hetzner.hcloud.hcloud_network – Create and manage cloud Networks on the Hetzner Cloud.
Note
This plugin is part of the hetzner.hcloud collection (version 1.6.0).
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 hetzner.hcloud.
To use it in a playbook, specify: hetzner.hcloud.hcloud_network.
Synopsis
- Create, update and manage cloud Networks on the Hetzner Cloud.
- You need at least hcloud-python 1.3.0.
Requirements
The below requirements are needed on the host that executes this module.
- hcloud-python >= 1.0.0
- hcloud-python >= 1.3.0
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_token
string / required
|
This is the API Token for the Hetzner Cloud.
|
|
| delete_protection
boolean
|
|
Protect the Network for deletion.
|
| endpoint
string
|
Default:
"https://api.hetzner.cloud/v1"
|
This is the API Endpoint for the Hetzner Cloud.
|
| id
integer
|
The ID of the Hetzner Cloud Networks to manage.
Only required if no Network name is given.
|
|
| ip_range
string
|
IP range of the Network.
Required if Network does not exists.
|
|
| labels
dictionary
|
User-defined labels (key-value pairs).
|
|
| name
string
|
The Name of the Hetzner Cloud Network to manage.
Only required if no Network id is given or a Network does not exists.
|
|
| state
string
|
|
State of the Network.
|
See Also
See also
- Documentation for Hetzner Cloud API
-
Complete reference for the Hetzner Cloud API.
Examples
- name: Create a basic network
hcloud_network:
name: my-network
ip_range: 10.0.0.0/8
state: present
- name: Ensure the Network is absent (remove if needed)
hcloud_network:
name: my-network
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| hcloud_network
complex
|
always |
The Network
|
|
| delete_protection
boolean
added in 0.1.0 of hetzner.hcloud
|
always |
True if Network is protected for deletion
|
|
| id
integer
|
always |
ID of the Network
Sample:
12345
|
|
| ip_range
string
|
always |
IP range of the Network
Sample:
10.0.0.0/8
|
|
| labels
dictionary
|
always |
User-defined labels (key-value pairs)
Sample:
{'key': 'value', 'mylabel': 123}
|
|
| name
string
|
always |
Name of the Network
Sample:
my-volume
|
|
Authors
- Lukas Kaemmerling (@lkaemmerling)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/hcloud_network_module.html