W3cubDocs

/Ansible

pn_trunk - CLI command to create/delete/modify a trunk.

New in version 2.2.

Synopsis

  • Execute trunk-create or trunk-delete command.
  • Trunks can be used to aggregate network links at Layer 2 on the local switch. Use this command to create a new trunk.

Options

parameter required default choices comments
pn_broadcast_level
 no
Specify a broadcast level in percent. The default value is 100%.
pn_clipassword
 no
Provide login password if user is not root.
pn_cliswitch
 no
Target switch(es) to run the cli on.
pn_cliusername
 no
Provide login username if user is not root.
pn_description
 no
Specify a description for the trunk configuration.
pn_edge_switch
 no
Specify if the switch is an edge switch.
pn_egress_rate_limit
 no
Specify an egress port data rate limit for the configuration.
pn_host
 no
Host facing port control setting.
pn_jumbo
 no
Specify if the port can receive jumbo frames.
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 for the configuration.
pn_lacp_priority
 no
Specify the LACP priority. This is a number between 1 and 65535 with a default value of 32768.
pn_lacp_timeout
 no
  • slow
  • fast
Specify the LACP time out as slow (30 seconds) or fast (4seconds). The default value is slow.
pn_loopback
 no
Specify loopback if you want to use loopback.
pn_loopvlans
 no
Specify a list of looping vlans.
pn_mirror_receive
 no
Specify if the configuration receives mirrored traffic.
pn_name
 yes
Specify the name for the trunk configuration.
pn_pause
 no
Specify if pause frames are sent.
pn_port_macaddr
 no
Specify the MAC address of the port.
pn_ports
 no
Specify the port number(s) for the link(s) to aggregate into the trunk.
Required for trunk-create.
pn_routing
 no
Specify if the port participates in routing on the network.
pn_speed
 no
  • disable
  • 10m
  • 100m
  • 1g
  • 2.5g
  • 10g
  • 40g
Specify the port speed or disable the port.
pn_unknown_mcast_level
 no
Specify an unknown multicast level in percent. The default value is 100%.
pn_unknown_ucast_level
 no
Specify an unknown unicast level in percent. The default value is 100%.
state
 yes
  • present
  • absent
  • update
State the action to perform. Use 'present' to create trunk, 'absent' to delete trunk and 'update' to modify trunk.

Examples

- name: create trunk
  pn_trunk:
    state: 'present'
    pn_name: 'spine-to-leaf'
    pn_ports: '11,12,13,14'

- name: delete trunk
  pn_trunk:
    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 trunk command.
 on error list
stdout
The set of responses from the trunk 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.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/pn_trunk_module.html