community.network.pn_port_config – CLI command to modify port-config

Note

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

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

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

Synopsis
Parameters
Examples
Return Values

Synopsis

This module can be used to modify a port configuration.

Parameters

Parameter	Choices/Defaults	Comments
pn_allowed_tpid string	vlan q-in-q q-in-q-old	Allowed TPID in addition to 0x8100 on Vlan header.
pn_autoneg boolean	no yes	physical port autonegotiation.
pn_cliswitch string		Target switch to run the CLI on.
pn_crc_check_enable boolean	no yes	CRC check on ingress and rewrite on egress.
pn_defer_bringup boolean	no yes	defer port bringup.
pn_description string		physical port description.
pn_dscp_map string		DSCP map name to enable on port.
pn_edge_switch boolean	no yes	physical port edge switch.
pn_egress_rate_limit string		max egress port data rate limit.
pn_enable boolean	no yes	physical port enable.
pn_eth_mode string	1000base-x sgmii disabled GMII	physical Ethernet mode.
pn_fabric_guard boolean	no yes	Fabric guard configuration.
pn_host_enable boolean	no yes	Host facing port control setting.
pn_intf string		physical interface.
pn_jumbo boolean	no yes	jumbo frames on physical port.
pn_lacp_priority string		LACP priority from 1 to 65535.
pn_local_switching boolean	no yes	no-local-switching port cannot bridge traffic to another no-local-switching port.
pn_loop_vlans string		looping vlans.
pn_loopback boolean	no yes	physical port loopback.
pn_mirror_only boolean	no yes	physical port mirror only.
pn_pause boolean	no yes	physical port pause.
pn_port string		physical port.
pn_port_mac_address string		physical port MAC Address.
pn_reflect boolean	no yes	physical port reflection.
pn_routing boolean	no yes	routing.
pn_send_port string		send port.
pn_speed string	disable 10m 100m 1g 2.5g 10g 25g 40g 50g 100g	physical port speed.
pn_vxlan_termination boolean	no yes	physical port vxlan termination setting.
state string / required	update	State the action to perform. Use `update` to modify the port-config.

Examples

- name: Port config modify
  community.network.pn_port_config:
    pn_cliswitch: "sw01"
    state: "update"
    pn_port: "all"
    pn_dscp_map: "foo"

- name: Port config modify
  community.network.pn_port_config:
    pn_cliswitch: "sw01"
    state: "update"
    pn_port: "all"
    pn_host_enable: true

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

Authors

Pluribus Networks (@rajaspachipulusu17)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/pn_port_config_module.html