vultr.cloud.reserved_ip module – Manages reserved IPs on Vultr
Note
This module is part of the vultr.cloud collection (version 1.13.0).
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 vultr.cloud
.
To use it in a playbook, specify: vultr.cloud.reserved_ip
.
New in vultr.cloud 1.0.0
Synopsis
Create, attach, detach and remove reserved IPs.
Parameters
Parameter |
Comments |
---|---|
URL to API endpint (without trailing slash). Fallback environment variable Default: |
|
API key of the Vultr API. Fallback environment variable |
|
Amount of retries in case of the Vultr API retuns an HTTP error code, such as - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Fallback environment variable Default: |
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds. Fallback environment variable Default: |
|
HTTP timeout to Vultr API. Fallback environment variable Default: |
|
ID of the Instance the reserved IP should be attached to. Mutually exclusive with instance_name. |
|
Name of the Instance the reserved IP should be attached to. Mutually exclusive with instance_id. |
|
Type of the IP. Choices:
|
|
Label of the reserved IP. |
|
Region of the reserved IP will be related to. |
|
State of the reserved IP. Choices:
|
|
Validate SSL certs of the Vultr API. Choices:
|
Notes
Note
Also see the API documentation on https://www.vultr.com/api/.
Examples
- name: Ensure a reserved IP present and attached to an instance
vultr.cloud.reserved_ip:
label: my attached IP
region: ewr
ip_type: v4
instance_name: web-01
- name: Ensure a reserved IP is detached
vultr.cloud.reserved_ip:
label: my reserved IP
region: ewr
ip_type: v4
instance_id: ""
- name: Ensure a reserved IP is absent
vultr.cloud.reserved_ip:
label: my attached IP
region: ewr
ip_type: v4
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response from Vultr API with a few additions/modification. Returned: success |
|
Endpoint used for the API requests. Returned: success Sample: |
|
Amount of max retries for the API requests. Returned: success Sample: |
|
Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: |
|
Timeout used for the API requests. Returned: success Sample: |
|
Response from Vultr API. Returned: success |
|
ID of the reserved IP. Returned: success Sample: |
|
ID of the Instance the reserved IP is attached to. Returned: success Sample: |
|
Type of the reserved IP. Returned: success Sample: |
|
Name of the reserved IP. Returned: success Sample: |
|
Region of the reserved IP is related to. Returned: success Sample: |
|
Subnet of the reserved IP. Returned: success Sample: |
|
Size of the subnet of the reserved IP. Returned: success Sample: |