community.general.memset_memstore_info – Retrieve Memstore product usage information.¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.memset_memstore_info
.
Synopsis¶
Retrieve Memstore product usage information.
This module was called
memset_memstore_facts
before Ansible 2.9. The usage did not change.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key
string
/ required
|
The API key obtained from the Memset control panel.
|
|
name
string
/ required
|
The Memstore product name (i.e.
mstestyaa1 ). |
Notes¶
Note
An API key generated via the Memset customer control panel is needed with the following minimum scope - memstore.usage.
Examples¶
- name: Get usage for mstestyaa1
community.general.memset_memstore_info:
name: mstestyaa1
api_key: 5eb86c9896ab03919abcf03857163741
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Simon Weald (@glitchcrab)