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

Note

This module is part of the community.general collection (version 9.4.0).

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

  • Retrieve Memstore product usage information.

Parameters

Parameter

Comments

api_key

string / required

The API key obtained from the Memset control panel.

name

string / required

The Memstore product name (that is, mstestyaa1).

Attributes

Attribute

Support

Description

check_mode

Support: full

added in community.general 3.3.0

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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

Description

memset_api

complex

Info from the Memset API

Returned: always

bandwidth

complex

Dictionary of CDN bandwidth facts

Returned: always

bytes_in

integer

Inbound bandwidth for the last 24 hours in bytes

Returned: always

Sample: 1000

bytes_out

integer

Outbound bandwidth for the last 24 hours in bytes

Returned: always

Sample: 1000

requests

integer

Number of requests in the last 24 hours

Returned: always

Sample: 10

bytes

integer

Space used in bytes

Returned: always

Sample: 3860997965

cdn_bandwidth

complex

Dictionary of CDN bandwidth facts

Returned: always

bytes_in

integer

Inbound CDN bandwidth for the last 24 hours in bytes

Returned: always

Sample: 1000

bytes_out

integer

Outbound CDN bandwidth for the last 24 hours in bytes

Returned: always

Sample: 1000

requests

integer

Number of requests in the last 24 hours

Returned: always

Sample: 10

containers

integer

Number of containers

Returned: always

Sample: 10

objs

integer

Number of objects

Returned: always

Sample: 1000

Authors

  • Simon Weald (@glitchcrab)