community.network.pn_vrouter_packet_relay – CLI command to add/remove vrouter-packet-relay

Note

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

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

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

Synopsis

  • This module can be used to add packet relay configuration for DHCP on vrouter and remove packet relay configuration for DHCP on vrouter.

Parameters

Parameter Choices/Defaults Comments
pn_cliswitch
string
Target switch to run the CLI on.
pn_forward_ip
string / required
forwarding IP address.
pn_forward_proto
string
    Choices:
  • dhcp ←
protocol type to forward packets.
pn_nic
string / required
NIC.
pn_vrouter_name
string / required
name of service config.
state
string
    Choices:
  • present ←
  • absent
vrouter-packet-relay configuration command.

Examples

- name: VRouter packet relay add
  community.network.pn_vrouter_packet_relay:
    pn_cliswitch: "sw01"
    pn_forward_ip: "192.168.10.1"
    pn_nic: "eth0.4092"
    pn_vrouter_name: "sw01-vrouter"

- name: VRouter packet relay remove
  community.network.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"

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-packet-relay command.
stdout
list / elements=string
always
set of responses from the vrouter-packet-relay command.


Authors

  • Pluribus Networks (@rajaspachipulusu17)