community.general.memset_memstore_info – Retrieve Memstore product usage information.

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.memset_memstore_info.

Synopsis
Parameters
Notes
Examples
Return Values

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:

Key			Returned	Description
memset_api complex			always	Info from the Memset API
	bandwidth complex		always	Dictionary of CDN bandwidth facts
		bytes_in integer	always	Inbound bandwidth for the last 24 hours in bytes Sample: 1000
		bytes_out integer	always	Outbound bandwidth for the last 24 hours in bytes Sample: 1000
		requests integer	always	Number of requests in the last 24 hours Sample: 10
	bytes integer		always	Space used in bytes Sample: 3860997965
	cdn_bandwidth complex		always	Dictionary of CDN bandwidth facts
		bytes_in integer	always	Inbound CDN bandwidth for the last 24 hours in bytes Sample: 1000
		bytes_out integer	always	Outbound CDN bandwidth for the last 24 hours in bytes Sample: 1000
		requests integer	always	Number of requests in the last 24 hours Sample: 10
	containers integer		always	Number of containers Sample: 10
	objs integer		always	Number of objects Sample: 1000

Authors

Simon Weald (@glitchcrab)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/memset_memstore_info_module.html