hetzner.hcloud.hcloud_network_info – Gather info about your Hetzner Cloud networks.

hetzner.hcloud.hcloud_network_info – Gather info about your Hetzner Cloud networks.

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_network_info.

• Synopsis
• Requirements
• Parameters
• See Also
• Examples
• Return Values

Synopsis

• Gather info about your Hetzner Cloud networks.

Requirements

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

• hcloud-python >= 1.0.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%22	This is the API Endpoint for the Hetzner Cloud.
id integer		The ID of the network you want to get.
label_selector string		The label selector for the network you want to get.
name string		The name of the network you want to get.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

- name: Gather hcloud network info
  local_action:
    module: hcloud_network_info

- name: Print the gathered info
  debug:
    var: hcloud_network_info

Return Values

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

Key			Returned	Description
hcloud_network_info complex			always	The network info as list
	delete_protection boolean added in 0.1.0 of hetzner.hcloud		always	True if the network is protected for deletion
	id integer		always	Numeric identifier of the network Sample: 1937415
	ip_range string		always	IP range of the network Sample: 10.0.0.0/16
	labels dictionary		always	Labels of the network
	name string		always	Name of the network Sample: awesome-network
	routes complex		always	Routes belonging to the network
		gateway string	always	Gateway of this route Sample: 10.0.0.1
		ip_range string	always	Destination network or host of this route. Sample: 10.0.0.0/16
	servers complex		always	Servers attached to the network
		backup_window boolean	always	Time window (UTC) in which the backup will run, or null if the backups are not enabled Sample: 22-02
		datacenter string	always	Name of the datacenter of the server Sample: fsn1-dc14
		id integer	always	Numeric identifier of the server Sample: 1937415
		ipv4_address string	always	Public IPv4 address of the server Sample: 116.203.104.109
		ipv6 string	always	IPv6 network of the server Sample: 2a01:4f8:1c1c:c140::/64
		labels dictionary	always	User-defined labels (key-value pairs)
		location string	always	Name of the location of the server Sample: fsn1
		name string	always	Name of the server Sample: my-server
		rescue_enabled boolean	always	True if rescue mode is enabled, Server will then boot into rescue system on next reboot
		server_type string	always	Name of the server type of the server Sample: cx11
		status string	always	Status of the server Sample: running
	subnetworks complex		always	Subnetworks belonging to the network
		gateway string	always	Gateway of this subnetwork Sample: 10.0.0.1
		ip_range string	always	IP range of the subnetwork Sample: 10.0.0.0/24
		network_zone string	always	Network of the subnetwork. Sample: eu-central
		type string	always	Type of the subnetwork. Sample: cloud

Authors

• Christopher Schmitt (@cschmitt-hcloud)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/hetzner/hcloud/hcloud_network_info_module.html