community.network.pn_vtep – CLI command to create/delete vtep
Note
This plugin is part of the community.network collection (version 3.0.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.
Synopsis
- This module can be used to create a vtep and delete a vtep.
Parameters
| Parameter | Choices/Defaults | 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.
|
| pn_virtual_ip
string
|
Virtual/Secondary IP address.
|
|
| pn_vrouter_name
string
|
name of the vrouter service.
|
|
| state
string
|
|
vtep configuration command.
|
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 | Returned | Description |
|---|---|---|
| changed
boolean
|
always |
indicates whether the CLI caused changes on the target.
|
| command
string
|
always |
the CLI command run on the target node.
|
| stderr
list / elements=string
|
on error |
set of error responses from the vtep command.
|
| stdout
list / elements=string
|
always |
set of responses from the vtep command.
|
Authors
- Pluribus Networks (@rajaspachipulusu17)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/pn_vtep_module.html