ansible / ansible.builtin / v2.9.18 / module / vultr_block_storage Manages block storage volumes on Vultr. | "added in version" 2.7 of ansible.builtin" Authors: Yanis Guenane (@Spredzy) preview | supported by communityansible.builtin.vultr_block_storage (v2.9.18) — module
pip
Install with pip install ansible==2.9.18
Manage block storage volumes on Vultr.
- name: Ensure a block storage volume is present local_action: module: vultr_block_storage name: myvolume size: 10 region: Amsterdam
- name: Ensure a block storage volume is absent local_action: module: vultr_block_storage name: myvolume state: absent
name: aliases: - description - label description: - Name of the block storage volume. required: true size: description: - Size of the block storage volume in GB. required: true state: choices: - present - absent default: present description: - State of the block storage volume. region: description: - Region the block storage volume is deployed into. required: true 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: ansible.builtin 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: contains: attached_to_id: description: The ID of the server the volume is attached to returned: success sample: '10194376' type: str cost_per_month: description: Cost per month for the volume returned: success sample: 1.0 type: float date_created: description: Date when the volume was created returned: success sample: '2017-08-26 12:47:48' type: str id: description: ID of the block storage volume returned: success sample: 1234abcd type: str name: description: Name of the volume returned: success sample: ansible-test-volume type: str region: description: Region the volume was deployed into returned: success sample: New Jersey type: str size: description: Information about the volume size in GB returned: success sample: 10 type: int status: description: Status about the deployment of the volume returned: success sample: active type: str description: Response from Vultr API returned: success type: complex