community.proxmox.proxmox_vnet module – Manage virtual networks in Proxmox SDN.

Note

This module is part of the community.proxmox collection (version 1.4.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 community.proxmox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.proxmox.proxmox_vnet.

New in community.proxmox 1.4.0

Synopsis

  • Create, update, or delete virtual networks in Proxmox SDN.

  • Configure network isolation, VLAN awareness, and other network settings.

Requirements

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

  • proxmoxer >= 2.0

  • requests

Parameters

Parameter

Comments

alias

string

An optional alias for the virtual network.

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

delete

string

A list of settings you want to delete.

isolate_ports

boolean

Enable isolation of ports within the virtual network.

Choices:

  • false ← (default)

  • true

lock_token

string

The token for unlocking the global SDN configuration.

state

string

Desired state of the virtual network.

Choices:

  • "present" ← (default)

  • "absent"

tag

integer

Tag for the virtual network.

update

boolean

If state=present then it will update the vnet if needed.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Uses the PROXMOX_VALIDATE_CERTS environment variable if not specified.

Choices:

  • false ← (default)

  • true

vlanaware

boolean

Enable VLAN awareness for the virtual network.

Choices:

  • false

  • true

vnet

string

The name of the virtual network to be managed.

zone

string

zone for the virtual network.

Attributes

Attribute

Support

Description

action_group

Action group: community.proxmox.proxmox

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

check_mode

Support: none

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

diff_mode

Support: none

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

Examples

- name: Create a vnet
  community.proxmox.proxmox_vnet:
    api_user: "{{ pc.proxmox.api_user }}"
    api_token_id: "{{ pc.proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false
    vnet: anstest
    zone: ans1
    state: present

- name: Update a vnet
  community.proxmox.proxmox_vnet:
    api_user: "{{ pc.proxmox.api_user }}"
    api_token_id: "{{ pc.proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false
    vnet: anstest
    zone: ans1
    alias: anst
    state: present
    update: true

- name: Delete a vnet
  community.proxmox.proxmox_vnet:
    api_user: "{{ pc.proxmox.api_user }}"
    api_token_id: "{{ pc.proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false
    vnet: anstest
    zone: ans1
    state: absent

Return Values

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

Key

Description

vnet

string

vnet name which was created/updated/deleted.

Returned: on success

Sample: "anstest"

Authors

  • Jana Hoch