hetzner.hcloud.subnetwork module – Manage cloud subnetworks on the Hetzner Cloud.
Note
This module is part of the hetzner.hcloud collection (version 4.2.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 hetzner.hcloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: hetzner.hcloud.subnetwork
.
Synopsis
Create, update and delete cloud subnetworks on the Hetzner Cloud.
Aliases: hcloud_subnetwork
Requirements
The below requirements are needed on the host that executes this module.
python-dateutil >= 2.7.5
requests >=2.20
Parameters
Parameter |
Comments |
---|---|
The API Endpoint for the Hetzner Cloud. You can also set this option by using the Default: |
|
The API Token for the Hetzner Cloud. You can also set this option by using the |
|
IP range of the subnetwork. |
|
The name or ID of the Hetzner Cloud Networks. |
|
Name of network zone. |
|
State of the subnetwork. Choices:
|
|
Type of subnetwork. Choices:
|
|
ID of the vSwitch you want to couple with your Network. Required if type == vswitch |
See Also
See also
- Documentation for Hetzner Cloud API
Complete reference for the Hetzner Cloud API.
Examples
- name: Create a basic subnetwork
hetzner.hcloud.subnetwork:
network: my-network
ip_range: 10.0.0.0/16
network_zone: eu-central
type: cloud
state: present
- name: Create a basic subnetwork
hetzner.hcloud.subnetwork:
network: my-vswitch-network
ip_range: 10.0.0.0/24
network_zone: eu-central
type: vswitch
vswitch_id: 123
state: present
- name: Ensure the subnetwork is absent (remove if needed)
hetzner.hcloud.subnetwork:
network: my-network
ip_range: 10.0.0.0/8
network_zone: eu-central
type: cloud
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
One Subnet of a Network Returned: always |
|
Gateway of the subnetwork Returned: always Sample: |
|
IP range of the Network Returned: always Sample: |
|
Name of the Network Returned: always Sample: |
|
Name of network zone Returned: always Sample: |
|
Type of subnetwork Returned: always Sample: |
|
ID of the vswitch, null if not type vswitch Returned: always Sample: |