ansible.builtin.pn_vrouter_loopback_interface (v2.9.27) — module

CLI command to add/remove vrouter-loopback-interface

| "added in version" 2.9 of ansible.builtin"

Authors: Pluribus Networks (@rajaspachipulusu17)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add vrouter loopback interface
  pn_vrouter_loopback_interface:
    state: "present"
    pn_cliswitch: "sw01"
    pn_vrouter_name: "sw01-vrouter"
    pn_ip: "192.168.10.1"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove vrouter loopback interface
  pn_vrouter_loopback_interface:
    state: "absent"
    pn_cliswitch: "sw01"
    pn_vrouter_name: "sw01-vrouter"
    pn_ip: "192.168.10.1"
    pn_index: "2"

Inputs

    
pn_ip:
    description:
    - loopback IP address.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State the action to perform. Use C(present) to add vrouter-loopback-interface and
      C(absent) to remove vrouter-loopback-interface.
    required: false
    type: str

pn_index:
    description:
    - loopback index from 1 to 255.
    required: false
    type: str

pn_cliswitch:
    description:
    - Target switch to run the CLI on.
    required: false
    type: str

pn_vrouter_name:
    description:
    - name of service config.
    required: true
    type: str

Outputs

changed:
  description: indicates whether the CLI caused changes on the target.
  returned: always
  type: bool
command:
  description: the CLI command run on the target node.
  returned: always
  type: str
stderr:
  description: set of error response from the vrouter-loopback-interface command.
  returned: on error
  type: list
stdout:
  description: set of responses from the vrouter-loopback-interface command.
  returned: always
  type: list