W3cubDocs

/Ansible 2.11

community.network.pn_vrouter_loopback_interface – CLI command to add/remove vrouter-loopback-interface

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

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

Synopsis

  • This module can be used to add loopback interface to a vRouter or remove loopback interface from a vRouter.

Parameters

Parameter Choices/Defaults Comments
pn_cliswitch
string
Target switch to run the CLI on.
pn_index
string
loopback index from 1 to 255.
pn_ip
string / required
loopback IP address.
pn_vrouter_name
string / required
name of service config.
state
string
    Choices:
  • 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
  community.network.pn_vrouter_loopback_interface:
    state: "present"
    pn_cliswitch: "sw01"
    pn_vrouter_name: "sw01-vrouter"
    pn_ip: "192.168.10.1"

- name: Remove vrouter loopback interface
  community.network.pn_vrouter_loopback_interface:
    state: "absent"
    pn_cliswitch: "sw01"
    pn_vrouter_name: "sw01-vrouter"
    pn_ip: "192.168.10.1"
    pn_index: "2"

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 response from the vrouter-loopback-interface command.
stdout
list / elements=string
always
set of responses from the vrouter-loopback-interface 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/2.11/collections/community/network/pn_vrouter_loopback_interface_module.html