community.network.pn_vtep module – CLI command to create/delete vtep

Note

This module is part of the community.network collection (version 5.1.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.network.

To use it in a playbook, specify: community.network.pn_vtep.

Note

The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.

DEPRECATED

Removed in:

version 6.0.0

Why:

This collection and all content in it is unmaintained and deprecated.

Alternative:

Unknown.

Synopsis

  • This module can be used to create a vtep and delete a vtep.

Aliases: network.netvisor.pn_vtep

Parameters

Parameter

Comments

pn_cliswitch

string

Target switch to run the CLI on.

pn_ip

string

Primary IP address.

pn_location

string

switch name.

pn_name

string

vtep name.

pn_switch_in_cluster

boolean

Tells whether switch in cluster or not.

Choices:

  • false

  • true ← (default)

pn_virtual_ip

string

Virtual/Secondary IP address.

pn_vrouter_name

string

name of the vrouter service.

state

string

vtep configuration command.

Choices:

  • "present" ← (default)

  • "absent"

Examples

- name: Create vtep
  community.network.pn_vtep:
    pn_cliswitch: 'sw01'
    pn_name: 'foo'
    pn_vrouter_name: 'foo-vrouter'
    pn_ip: '22.22.22.2'
    pn_location: 'sw01'
    pn_virtual_ip: "22.22.22.1"

- name: Delete vtep
  community.network.pn_vtep:
    pn_cliswitch: 'sw01'
    state: 'absent'
    pn_name: 'foo'

Return Values

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

Key

Description

changed

boolean

indicates whether the CLI caused changes on the target.

Returned: always

command

string

the CLI command run on the target node.

Returned: always

stderr

list / elements=string

set of error responses from the vtep command.

Returned: on error

stdout

list / elements=string

set of responses from the vtep command.

Returned: always

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Pluribus Networks (@rajaspachipulusu17)