vultr.cloud.vpc2 module – Manages VPCs 2.0 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.vpc2
.
New in vultr.cloud 1.9.0
Synopsis
Create and remove VPCs 2.0.
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: |
|
Description of the VPC. |
|
The subnet of the VPC. Required if state=present. |
|
Type of the IP version. Required if state=present. Choices:
|
|
The number of bits for the netmask in CIDR notation, e.g. 24. Required if state=present. |
|
Region the VPC will be related to. Required if state=present. |
|
State of the VPC. 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 VPC is present
vultr.cloud.vpc2:
description: my VPC.
ip_block: 10.99.1.0
prefix_length: 24
region: ewr
- name: Ensure a VPC is absent
vultr.cloud.vpc2:
description: my VPC.
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 |
|
Date the VPC was created. Returned: success Sample: |
|
Description of the VPC. Returned: success Sample: |
|
ID of the VPC. Returned: success Sample: |
|
Subnet of the VPC. Returned: success Sample: |
|
The number of bits for the netmask in CIDR notation. Returned: success Sample: |
|
The region the VPC is located in. Returned: success Sample: |