community.proxmox.proxmox_node_network_info module – Retrieve information about Proxmox VE node network interfaces

api_host

string / required

Specify the target host of the Proxmox VE cluster.

Uses the PROXMOX_HOST environment variable if not specified.

api_password

string

Specify the password to authenticate with.

Uses the PROXMOX_PASSWORD environment variable if not specified.

api_port

integer

Specify the target port of the Proxmox VE cluster.

Uses the PROXMOX_PORT environment variable if not specified.

api_timeout

integer

Time limit for requests towards the Proxmox VE API.

Default: 5

api_token_id

string

Specify the token ID.

Uses the PROXMOX_TOKEN_ID environment variable if not specified.

api_token_secret

string

Specify the token secret.

Uses the PROXMOX_TOKEN_SECRET environment variable if not specified.

api_user

string / required

Specify the user to authenticate with.

Uses the PROXMOX_USER environment variable if not specified.

ca_path

path

Path to a local certificate, which will be used to verify TLS connections.

Ignored if validate_certs=false.

check_changes

boolean

Whether to check for pending network configuration changes.

When enabled, the module will return only information about any staged changes that are waiting to be applied.

When disabled (default), the module will return network interface information.

This parameter cannot be used together with iface or iface_type parameters, as checking for pending changes is a node-level operation.

Choices:

• false ← (default)
• true

iface

string

Name of a specific network interface to retrieve information for.

If not specified, information for all interfaces will be returned.

iface_type

string

Filter results by interface type.

Choices:

• "bridge"
• "bond"
• "eth"
• "vlan"
• "OVSBridge"
• "OVSBond"
• "OVSPort"
• "OVSIntPort"

node

string / required

The Proxmox node to retrieve network interface information from.

validate_certs

boolean

Validate the TLS certificates used for the connection to the Proxmox VE API.

Currently defaults to false and changes default to true with community.proxmox 2.0.0.

Uses the PROXMOX_VALIDATE_CERTS environment variable if not specified.

Choices:

• false
• true

action_group

Action group: community.proxmox.proxmox

Use group/community.proxmox.proxmox in module_defaults to set defaults for this module.

check_mode

Support: full

Check mode is fully supported.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

This is an info module and does not make changes.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

has_pending_changes

boolean

Whether there are any pending network configuration changes

Returned: success, when check_changes is true

Sample: true

pending_changes

string

Pending network configuration changes

Returned: success, when check_changes is true

Sample: "--- /etc/network/interfaces\n+++ /etc/network/interfaces\n@@ -10,6 +10,12 @@\n # The primary network interface\n auto eth0\n iface eth0 inet dhcp\n+\n+# Bridge interface\n+auto vmbr1\n+iface vmbr1 inet static\n+        address 192.168.2.1/24\n+        bridge_ports eth1\n"

proxmox_node_networks

list / elements=dictionary

List of network interfaces on the node

Returned: success, when check_changes is false or not specified

Sample: [{"active": true, "address": "192.168.1.1", "autostart": true, "bridge_ports": "eth0", "cidr": "192.168.1.1/24", "exists": true, "families": ["inet"], "gateway": "192.168.1.254", "iface": "vmbr0", "method": "static", "mtu": 1500, "netmask": "255.255.255.0", "type": "bridge"}, {"active": true, "autostart": true, "bond-primary": "eth1", "bond_mode": "active-backup", "exists": true, "families": ["inet"], "iface": "bond0", "method": "manual", "mtu": 1500, "slaves": "eth1 eth2", "type": "bond"}]