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.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| pn_broadcast_level |
Specify a broadcast level in percent. The default value is 100%.
|
|
| pn_clipassword |
Provide login password if user is not root.
|
|
| pn_cliswitch |
Target switch(es) to run the cli on.
|
|
| pn_cliusername |
Provide login username if user is not root.
|
|
| pn_description |
Specify a description for the trunk configuration.
|
|
| pn_edge_switch |
Specify if the switch is an edge switch.
|
|
| pn_egress_rate_limit |
Specify an egress port data rate limit for the configuration.
|
|
| pn_host |
Host facing port control setting.
|
|
| pn_jumbo |
Specify if the port can receive jumbo frames.
|
|
| pn_lacp_fallback |
|
Specify the LACP fallback mode as bundles or individual.
|
| pn_lacp_fallback_timeout |
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 |
|
Specify the LACP mode for the configuration.
|
| pn_lacp_priority |
Specify the LACP priority. This is a number between 1 and 65535 with a default value of 32768.
|
|
| pn_lacp_timeout |
|
Specify the LACP time out as slow (30 seconds) or fast (4seconds). The default value is slow.
|
| pn_loopback |
Specify loopback if you want to use loopback.
|
|
| pn_loopvlans |
Specify a list of looping vlans.
|
|
| pn_mirror_receive |
Specify if the configuration receives mirrored traffic.
|
|
| pn_name
required
|
Specify the name for the trunk configuration.
|
|
| pn_pause |
Specify if pause frames are sent.
|
|
| pn_port_macaddr |
Specify the MAC address of the port.
|
|
| pn_ports |
Specify the port number(s) for the link(s) to aggregate into the trunk.
Required for trunk-create.
|
|
| pn_routing |
Specify if the port participates in routing on the network.
|
|
| pn_speed |
|
Specify the port speed or disable the port.
|
| pn_unknown_mcast_level |
Specify an unknown multicast level in percent. The default value is 100%.
|
|
| pn_unknown_ucast_level |
Specify an unknown unicast level in percent. The default value is 100%.
|
|
| state
required
|
|
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, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed
bool
|
always |
Indicates whether the CLI caused changes on the target.
|
| command
str
|
always |
The CLI command run on the target node(s).
|
| stderr
list
|
on error |
The set of error responses from the trunk command.
|
| stdout
list
|
always |
The set of responses from the trunk command.
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Pluribus Networks (@amitsi)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/pn_trunk_module.html