Create or delete VPCs.
VPCs (virtual private clouds) allow you to create virtual networks containing resources that can communicate with each other in full isolation using private IP addresses.
View the create API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/VPCs.
| Parameter | Choices | Default | Comments |
|---|---|---|---|
client_override_options(dict) |
Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options. | ||
description(str) |
A free-form text field for describing the VPC's purpose. It may be a maximum of 255 characters. | ||
ip_range(str) |
The range of IP addresses in the VPC in CIDR notation. Network ranges cannot overlap with other networks in the same account and must be in range of private addresses as defined in RFC1918. It may not be smaller than /28 nor larger than /16. If no IP range is specified, a /20 network range is generated that won't conflict with other VPC networks in your account. | ||
module_override_options(dict) |
Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options. | ||
name(str) |
The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods. | ||
region(str) |
The slug identifier for the region where the VPC will be created. | ||
state(str) |
|
present | State of the resource, present to create, absent to destroy. |
timeout(int) |
300 | Polling timeout in seconds. | |
token(str) |
DigitalOcean API token. There are several environment variables which can be used to provide this value. DIGITALOCEAN_ACCESS_TOKEN, DIGITALOCEAN_TOKEN, DO_API_TOKEN, DO_API_KEY, DO_OAUTH_TOKEN and OAUTH_TOKEN |
- name: Create VPC
digitalocean.cloud.vpc:
token: "{{ token }}"
state: present
name: env.prod-vpc
region: nyc1
ip_range: "10.10.10.0/24"
| Key | Returned | Description |
|---|---|---|
error(dict) |
failure |
DigitalOcean API error.
Sample: |
msg(str) |
always |
Droplet result information.
Sample: |
vpc(dict) |
always |
VPC information.
Sample: |