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

CLI command to add/remove vrouter-packet-relay

| "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 packet relay configuration for DHCP on vrouter and remove packet relay configuration for DHCP on vrouter.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: vRouter packet relay add
  pn_vrouter_packet_relay:
    pn_cliswitch: "sw01"
    pn_forward_ip: "192.168.10.1"
    pn_nic: "eth0.4092"
    pn_vrouter_name: "sw01-vrouter"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: vRouter packet relay remove
  pn_vrouter_packet_relay:
    pn_cliswitch: "sw01"
    state: "absent"
    pn_forward_ip: "192.168.10.1"
    pn_nic: "eth0.4092"
    pn_vrouter_name: "sw01-vrouter"

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - vrouter-packet-relay configuration command.
    required: false
    type: str

pn_nic:
    description:
    - NIC.
    required: true
    type: str

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

pn_forward_ip:
    description:
    - forwarding IP address.
    required: true
    type: str

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

pn_forward_proto:
    choices:
    - dhcp
    default: dhcp
    description:
    - protocol type to forward packets.
    required: false
    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 responses from the vrouter-packet-relay command.
  returned: on error
  type: list
stdout:
  description: set of responses from the vrouter-packet-relay command.
  returned: always
  type: list