You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

pn_vrouterlbif - CLI command to add/remove vrouter-loopback-interface.¶

New in version 2.2.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Execute vrouter-loopback-interface-add, vrouter-loopback-interface-remove commands.
Each fabric, cluster, standalone switch, or virtual network (VNET) can provide its tenants with a virtual router (vRouter) service that forwards traffic between networks and implements Layer 3 protocols.

Options ¶

parameter	required	default	choices	comments
pn_clipassword	no			Provide login password if user is not root.
pn_cliswitch	no			Target switch(es) to run the cli on.
pn_cliusername	no			Provide login username if user is not root.
pn_index	no			Specify the interface index from 1 to 255.
pn_interface_ip	yes			Specify the IP address.
pn_vrouter_name	yes			Specify the name of the vRouter.
state	yes		present absent	State the action to perform. Use 'present' to add vrouter loopback interface and 'absent' to remove vrouter loopback interface.

Examples ¶

- name: add vrouter-loopback-interface
  pn_vrouterlbif:
    state: 'present'
    pn_vrouter_name: 'ansible-vrouter'
    pn_interface_ip: '104.104.104.1'

- name: remove vrouter-loopback-interface
  pn_vrouterlbif:
    state: 'absent'
    pn_vrouter_name: 'ansible-vrouter'
    pn_interface_ip: '104.104.104.1'

Return Values ¶

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

name	description	returned	type	sample
changed	Indicates whether the CLI caused changes on the target.	always	bool
command	The CLI command run on the target node(s).	always	str
stderr	The set of error responses from the vrouterlb command.	on error	list
stdout	The set of responses from the vrouterlb command.	always	list

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.