community / community.general / 0.1.1 / module / vultr_block_storage_info Get information about the Vultr block storage volumes available. Authors: Yanis Guenane (@Spredzy), René Moser (@resmo) preview | supported by communitycommunity.general.vultr_block_storage_info (0.1.1) — module
Install with ansible-galaxy collection install community.general:==0.1.1
collections: - name: community.general version: 0.1.1
Get infos about block storage volumes available in Vultr.
- name: Get Vultr block storage infos vultr_block_storage_info: register: result
- name: Print the infos debug: var: result.vultr_block_storage_info
api_key: description: - API key of the Vultr API. - The ENV variable C(VULTR_API_KEY) is used as default, when defined. type: str api_account: default: default description: - Name of the ini section in the C(vultr.ini) file. - The ENV variable C(VULTR_API_ACCOUNT) is used as default, when defined. type: str api_retries: description: - Amount of retries in case of the Vultr API retuns an HTTP 503 code. - The ENV variable C(VULTR_API_RETRIES) is used as default, when defined. - Fallback value is 5 retries if not specified. type: int api_timeout: description: - HTTP timeout to Vultr API. - The ENV variable C(VULTR_API_TIMEOUT) is used as default, when defined. - Fallback value is 60 seconds if not specified. type: int api_endpoint: description: - URL to API endpint (without trailing slash). - The ENV variable C(VULTR_API_ENDPOINT) is used as default, when defined. - Fallback value is U(https://api.vultr.com) if not specified. type: str validate_certs: default: true description: - Validate SSL certs of the Vultr API. type: bool api_retry_max_delay: description: - Retry backoff delay in seconds is exponential up to this max. value, in seconds. - The ENV variable C(VULTR_API_RETRY_MAX_DELAY) is used as default, when defined. - Fallback value is 12 seconds. type: int
vultr_api: contains: api_account: description: Account used in the ini file to select the key returned: success sample: default type: str api_endpoint: description: Endpoint used for the API requests returned: success sample: https://api.vultr.com type: str api_retries: description: Amount of max retries for the API requests returned: success sample: 5 type: int api_retry_max_delay: description: Exponential backoff delay in seconds between retries up to this max delay value. returned: success sample: 12 type: int version_added: '2.9' version_added_collection: community.general api_timeout: description: Timeout used for the API requests returned: success sample: 60 type: int description: Response from Vultr API with a few additions/modification returned: success type: complex vultr_block_storage_info: contains: attached_to_id: description: Block storage is attached to this server ID. returned: success sample: null type: str cost_per_month: description: Cost per month of the block storage. returned: success sample: 1.0 type: float date_created: description: Date created of the block storage. returned: success sample: '2018-07-24 12:59:59' type: str id: description: ID of the block storage. returned: success sample: 17332323 type: int name: description: Name of the block storage. returned: success sample: my volume type: str region: description: Region the block storage is located in. returned: success sample: New Jersey type: str size: description: Size in GB of the block storage. returned: success sample: 10 type: int status: description: Status of the block storage. returned: success sample: active type: str description: Response from Vultr API as list returned: success type: complex