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 string	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 string		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 string		API key of the Vultr API. The ENV variable VULTR_API_KEY is used as default, when defined.
api_retries integer		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_retry_max_delay integer added in 2.9		Retry backoff delay in seconds is exponential up to this max. value, in seconds. The ENV variable VULTR_API_RETRY_MAX_DELAY is used as default, when defined. Fallback value is 12 seconds.
api_timeout integer		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

• Also see the API documentation on https://www.vultr.com/api/.

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_retry_max_delay integer added in 2.9	success	Exponential backoff delay in seconds between retries up to this max delay value. Sample: 12
	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

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Yanis Guenane (@Spredzy)

Hint

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