vpc

Generated on 20 Jun 2025 from digitalocean.cloud version v1.2.1

Synopsis

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.

Requirements

  • pydo >= 0.1.3
  • azure-core >= 1.26.1

Parameters

Parameter Choices / Default Description
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 / required
The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.
region
str / required
The slug identifier for the region where the VPC will be created.
state
str
Choices:
  • present (default)
  • absent
State of the resource, present to create, absent to destroy.
timeout
int
Default: 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

Examples

- name: Create VPC
  digitalocean.cloud.vpc:
    token: "{{ token }}"
    state: present
    name: env.prod-vpc
    region: nyc1
    ip_range: "10.10.10.0/24"

Return Values

KeyReturnedDescription
error
dict
failure DigitalOcean API error.
Sample:
{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}
msg
str
always Droplet result information.
Sample:
[
  "Created VPC env.prod-vpc (5a4981aa-9653-4bd1-bef5-d6bff52042e4)",
  "Deleted VPC env.prod-vpc (5a4981aa-9653-4bd1-bef5-d6bff52042e4)",
  "VPC env.prod-vpc would be created",
  "VPC env.prod-vpc (5a4981aa-9653-4bd1-bef5-d6bff52042e4) exists",
  "VPC env.prod-vpc does not exist",
  "VPC env.prod-vpc (5a4981aa-9653-4bd1-bef5-d6bff52042e4) would be deleted"
]
vpc
dict
always VPC information.
Sample:
{
  "created_at": "2020-03-13T19:20:47.442049222Z",
  "default": true,
  "description": "VPC for production environment",
  "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
  "ip_range": "10.10.10.0/24",
  "name": "env.prod-vpc",
  "region": "nyc1",
  "urn": "do:vpc:5a4981aa-9653-4bd1-bef5-d6bff52042e4"
}

We can't find any results for your search.

Try using different keywords or simplifying your search terms.