community / community.general / 0.1.1 / module / vultr_network Manages networks on Vultr. Authors: Yanis Guenane (@Spredzy) preview | supported by communitycommunity.general.vultr_network (0.1.1) — module
Install with ansible-galaxy collection install community.general:==0.1.1
collections: - name: community.general version: 0.1.1
Manage networks on Vultr. A network cannot be updated. It needs to be deleted and re-created.
- 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
cidr: description: - The CIDR IPv4 network block to be used when attaching servers to this network. Required if I(state=present). name: aliases: - description - label description: - Name of the network. required: true state: choices: - present - absent default: present description: - State of the network. region: description: - Region the network is deployed into. Required if I(state=present). api_key: description: - API key of the Vultr API. - The ENV variable C(VULTR_API_KEY) is used as default, when defined. type: str api_account: default: default description: - Name of the ini section in the C(vultr.ini) file. - The ENV variable C(VULTR_API_ACCOUNT) is used as default, when defined. type: str api_retries: description: - Amount of retries in case of the Vultr API retuns an HTTP 503 code. - The ENV variable C(VULTR_API_RETRIES) is used as default, when defined. - Fallback value is 5 retries if not specified. type: int api_timeout: description: - HTTP timeout to Vultr API. - The ENV variable C(VULTR_API_TIMEOUT) is used as default, when defined. - Fallback value is 60 seconds if not specified. type: int api_endpoint: description: - URL to API endpint (without trailing slash). - The ENV variable C(VULTR_API_ENDPOINT) is used as default, when defined. - Fallback value is U(https://api.vultr.com) if not specified. type: str validate_certs: default: true description: - Validate SSL certs of the Vultr API. type: bool api_retry_max_delay: description: - Retry backoff delay in seconds is exponential up to this max. value, in seconds. - The ENV variable C(VULTR_API_RETRY_MAX_DELAY) is used as default, when defined. - Fallback value is 12 seconds. type: int
vultr_api: contains: api_account: description: Account used in the ini file to select the key returned: success sample: default type: str api_endpoint: description: Endpoint used for the API requests returned: success sample: https://api.vultr.com type: str api_retries: description: Amount of max retries for the API requests returned: success sample: 5 type: int api_retry_max_delay: description: Exponential backoff delay in seconds between retries up to this max delay value. returned: success sample: 12 type: int version_added: '2.9' version_added_collection: community.general api_timeout: description: Timeout used for the API requests returned: success sample: 60 type: int description: Response from Vultr API with a few additions/modification returned: success type: complex vultr_network: contains: date_created: description: Date when the network was created returned: success sample: '2018-08-02 08:54:52' type: str id: description: ID of the network returned: success sample: net5b62c6dc63ef5 type: str name: description: Name (label) of the network returned: success sample: mynetwork type: str region: description: Region the network was deployed into returned: success sample: Amsterdam type: str v4_subnet: description: IPv4 Network address returned: success sample: 192.168.42.0 type: str v4_subnet_mask: description: Ipv4 Network mask returned: success sample: 24 type: int description: Response from Vultr API returned: success type: complex