ngine_io.vultr.vultr_network module – Manages networks on Vultr.

Note

This module is part of the ngine_io.vultr collection (version 1.1.1).

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 ngine_io.vultr.

To use it in a playbook, specify: ngine_io.vultr.vultr_network.

New in version 0.1.0: of ngine_io.vultr

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

Comments

api_account

string

Name of the ini section in the vultr.ini file.

The ENV variable VULTR_API_ACCOUNT is used as default, when defined.

Default: “default”

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

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

string

The CIDR IPv4 network block to be used when attaching servers to this network. Required if state=present.

name

aliases: description, label

string / required

Name of the network.

region

string

Region the network is deployed into. Required if state=present.

state

string

State of the network.

Choices:

  • present ← (default)

  • absent

validate_certs

boolean

Validate SSL certs of the Vultr API.

Choices:

  • no

  • yes ← (default)

Notes

Note

Examples

- name: Ensure a network is present
  ngine_io.vultr.vultr_network:
    name: mynet
    cidr: 192.168.42.0/24
    region: Amsterdam

- name: Ensure a network is absent
  ngine_io.vultr.vultr_network:
    name: mynet
    state: absent

Return Values

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

Key

Description

vultr_api

complex

Response from Vultr API with a few additions/modification

Returned: success

api_account

string

Account used in the ini file to select the key

Returned: success

Sample: “default”

api_endpoint

string

Endpoint used for the API requests

Returned: success

Sample:https://api.vultr.com

api_retries

integer

Amount of max retries for the API requests

Returned: success

Sample: 5

api_retry_max_delay

integer

Exponential backoff delay in seconds between retries up to this max delay value.

Returned: success

Sample: 12

api_timeout

integer

Timeout used for the API requests

Returned: success

Sample: 60

vultr_network

complex

Response from Vultr API

Returned: success

date_created

string

Date when the network was created

Returned: success

Sample: “2018-08-02 08:54:52”

id

string

ID of the network

Returned: success

Sample: “net5b62c6dc63ef5”

name

string

Name (label) of the network

Returned: success

Sample: “mynetwork”

region

string

Region the network was deployed into

Returned: success

Sample: “Amsterdam”

v4_subnet

string

IPv4 Network address

Returned: success

Sample: “192.168.42.0”

v4_subnet_mask

integer

Ipv4 Network mask

Returned: success

Sample: 24

Authors

  • Yanis Guenane (@Spredzy)