Documentation

vultr_network – Manages networks on Vultr.

New in version 2.7.

Synopsis

  • Manage networks on Vultr. A network cannot be updated. It needs to be deleted and re-created.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
api_account
-
Default:
default
Name of the ini section in the vultr.ini file.
The ENV variable VULTR_API_ACCOUNT is used as default, when defined.
api_endpoint
-
URL to API endpint (without trailing slash).
The ENV variable VULTR_API_ENDPOINT is used as default, when defined.
Fallback value is https://api.vultr.com if not specified.
api_key
-
API key of the Vultr API.
The ENV variable VULTR_API_KEY is used as default, when defined.
api_retries
-
Amount of retries in case of the Vultr API retuns an HTTP 503 code.
The ENV variable VULTR_API_RETRIES is used as default, when defined.
Fallback value is 5 retries if not specified.
api_timeout
-
HTTP timeout to Vultr API.
The ENV variable VULTR_API_TIMEOUT is used as default, when defined.
Fallback value is 60 seconds if not specified.
cidr
-
The CIDR IPv4 network block to be used when attaching servers to this network. Required if state=present.
name
- / required
Name of the network.

aliases: description, label
region
-
Region the network is deployed into. Required if state=present.
state
-
    Choices:
  • present ←
  • absent
State of the network.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Validate SSL certs of the Vultr API.

Notes

Note

Examples

- name: Ensure a network is present
  local_action:
    module: vultr_network
    name: mynet
    cidr: 192.168.42.0/24
    region: Amsterdam

- name: Ensure a network is absent
  local_action:
    module: vultr_network
    name: mynet
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
vultr_api
complex
success
Response from Vultr API with a few additions/modification

  api_account
string
success
Account used in the ini file to select the key

Sample:
default
  api_endpoint
string
success
Endpoint used for the API requests

Sample:
https://api.vultr.com
  api_retries
integer
success
Amount of max retries for the API requests

Sample:
5
  api_timeout
integer
success
Timeout used for the API requests

Sample:
60
vultr_network
complex
success
Response from Vultr API

  date_created
string
success
Date when the network was created

Sample:
2018-08-02 08:54:52
  id
string
success
ID of the network

Sample:
net5b62c6dc63ef5
  name
string
success
Name (label) of the network

Sample:
mynetwork
  region
string
success
Region the network was deployed into

Sample:
Amsterdam
  v4_subnet
string
success
IPv4 Network address

Sample:
192.168.42.0
  v4_subnet_mask
integer
success
Ipv4 Network mask

Sample:
24


Status

Authors

  • Yanis Guenane (@Spredzy)

Hint

If you notice any issues in this documentation you can edit this document to improve it.