Documentation

pn_vlag - CLI command to create/delete/modify vlag.

New in version 2.2.

Synopsis

  • Execute vlag-create/vlag-delete/vlag-modify command.
  • A virtual link aggregation group (VLAG) allows links that are physically connected to two different Pluribus Networks devices to appear as a single trunk to a third device. The third device can be a switch, server, or any Ethernet device. A VLAG can provide Layer 2 multipathing, which allows you to create redundancy by increasing bandwidth, enabling multiple parallel paths between nodes and loadbalancing traffic where alternative paths exist.

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 this command on.
pn_cliusername
 no
Provide login username if user is not root.
pn_failover_action
 no
  • move
  • ignore
Specify the failover action as move or ignore.
pn_lacp_fallback
 no
  • bundle
  • individual
Specify the LACP fallback mode as bundles or individual.
pn_lacp_fallback_timeout
 no
Specify the LACP fallback timeout in seconds. The range is between 30 and 60 seconds with a default value of 50 seconds.
pn_lacp_mode
 no
  • off
  • passive
  • active
Specify the LACP mode.
pn_lacp_timeout
 no
  • slow
  • fast
Specify the LACP timeout as slow(30 seconds) or fast(4 seconds).
pn_mode
 no
  • active-active
  • active-standby
Specify the mode for the VLAG. Active-standby indicates one side is active and the other side is in standby mode. Active-active indicates that both sides of the vlag are up by default.
pn_name
 yes
The pn_name takes a valid name for vlag configuration.
pn_peer_port
 no
Specify the peer VLAG port.
Required for vlag-create.
pn_peer_switch
 no
Specify the fabric-name of the peer switch.
pn_port
 no
Specify the local VLAG port.
Required for vlag-create.
state
 yes
  • present
  • absent
  • update
State the action to perform. Use 'present' to create vlag, 'absent' to delete vlag and 'update' to modify vlag.

Examples

- name: create a VLAG
  pn_vlag:
    state: 'present'
    pn_name: spine-to-leaf
    pn_port: 'spine01-to-leaf'
    pn_peer_port: 'spine02-to-leaf'
    pn_peer_switch: spine02
    pn_mode: 'active-active'

- name: delete VLAGs
  pn_vlag:
    state: 'absent'
    pn_name: spine-to-leaf

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 vlag command.
 on error list
stdout
The set of responses from the vlag 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.