hetzner.hcloud.hcloud_subnetwork – Manage cloud subnetworks on the Hetzner Cloud.

Note

This plugin is part of the hetzner.hcloud collection (version 1.2.1).

To install it use: ansible-galaxy collection install hetzner.hcloud.

To use it in a playbook, specify: hetzner.hcloud.hcloud_subnetwork.

Synopsis

• Create, update and delete cloud subnetworks on the Hetzner Cloud.

Requirements

The below requirements are needed on the host that executes this module.

• hcloud-python >= 1.0.0

• hcloud-python >= 1.10.0

Parameters

Parameter	Choices/Defaults	Comments
api_token string / required		This is the API Token for the Hetzner Cloud.
endpoint string	Default: "https://api.hetzner.cloud/v1"	This is the API Endpoint for the Hetzner Cloud.
ip_range string / required		IP range of the subnetwork.
network string / required		The ID or Name of the Hetzner Cloud Networks.
network_zone string / required		Name of network zone.
state string	Choices: absent present ←	State of the subnetwork.
type string / required	Choices: server cloud vswitch	Type of subnetwork.
vswitch_id integer		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
  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
  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)
  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		Returned	Description
hcloud_subnetwork complex		always	One Subnet of a Network
	gateway string	always	Gateway of the subnetwork Sample: 10.0.0.1
	ip_range string	always	IP range of the Network Sample: 10.0.0.0/8
	network string	always	Name of the Network Sample: my-network
	network_zone string	always	Name of network zone Sample: eu-central
	type string	always	Type of subnetwork Sample: server
	vswitch_id integer	always	ID of the vswitch, null if not type vswitch Sample: 123

Authors

• Lukas Kaemmerling (@lkaemmerling)