community.network.pn_vrouter_interface_ip – CLI command to add/remove vrouter-interface-ip
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_vrouter_interface_ip.
Synopsis
- This module can be used to add an IP address on interface from a vRouter or remove an IP address on interface from a vRouter.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| pn_bd
string
|
interface Bridge Domain.
|
|
| pn_cliswitch
string
|
Target switch to run the CLI on.
|
|
| pn_ip
string
|
IP address.
|
|
| pn_netmask
string
|
netmask.
|
|
| pn_nic
string
|
virtual NIC assigned to interface.
|
|
| pn_vnet
string
|
interface VLAN VNET.
|
|
| pn_vrouter_name
string
|
name of service config.
|
|
| state
string / required
|
|
State the action to perform. Use present to addvrouter-interface-ip and absent to remove vrouter-interface-ip.
|
Examples
- name: Add vrouter interface to nic
community.network.pn_vrouter_interface_ip:
state: "present"
pn_cliswitch: "sw01"
pn_vrouter_name: "foo-vrouter"
pn_ip: "2620:0:1651:1::30"
pn_netmask: "127"
pn_nic: "eth0.4092"
- name: Remove vrouter interface to nic
community.network.pn_vrouter_interface_ip:
state: "absent"
pn_cliswitch: "sw01"
pn_vrouter_name: "foo-vrouter"
pn_ip: "2620:0:1651:1::30"
pn_nic: "eth0.4092"
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 vrouter-interface-ip command.
|
| stdout
list / elements=string
|
always |
set of responses from the vrouter-interface-ip 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_vrouter_interface_ip_module.html