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

Note

This module is part of the community.network collection (version 4.0.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

  • This module can be used to modify a port configuration.

Parameters

Parameter

Comments

pn_allowed_tpid

string

Allowed TPID in addition to 0x8100 on Vlan header.

Choices:

  • vlan

  • q-in-q

  • q-in-q-old

pn_autoneg

boolean

physical port autonegotiation.

Choices:

  • no

  • yes

pn_cliswitch

string

Target switch to run the CLI on.

pn_crc_check_enable

boolean

CRC check on ingress and rewrite on egress.

Choices:

  • no

  • yes

pn_defer_bringup

boolean

defer port bringup.

Choices:

  • no

  • yes

pn_description

string

physical port description.

pn_dscp_map

string

DSCP map name to enable on port.

pn_edge_switch

boolean

physical port edge switch.

Choices:

  • no

  • yes

pn_egress_rate_limit

string

max egress port data rate limit.

pn_enable

boolean

physical port enable.

Choices:

  • no

  • yes

pn_eth_mode

string

physical Ethernet mode.

Choices:

  • 1000base-x

  • sgmii

  • disabled

  • GMII

pn_fabric_guard

boolean

Fabric guard configuration.

Choices:

  • no

  • yes

pn_host_enable

boolean

Host facing port control setting.

Choices:

  • no

  • yes

pn_intf

string

physical interface.

pn_jumbo

boolean

jumbo frames on physical port.

Choices:

  • no

  • yes

pn_lacp_priority

string

LACP priority from 1 to 65535.

pn_local_switching

boolean

no-local-switching port cannot bridge traffic to another no-local-switching port.

Choices:

  • no

  • yes

pn_loop_vlans

string

looping vlans.

pn_loopback

boolean

physical port loopback.

Choices:

  • no

  • yes

pn_mirror_only

boolean

physical port mirror only.

Choices:

  • no

  • yes

pn_pause

boolean

physical port pause.

Choices:

  • no

  • yes

pn_port

string

physical port.

pn_port_mac_address

string

physical port MAC Address.

pn_reflect

boolean

physical port reflection.

Choices:

  • no

  • yes

pn_routing

boolean

routing.

Choices:

  • no

  • yes

pn_send_port

string

send port.

pn_speed

string

physical port speed.

Choices:

  • disable

  • 10m

  • 100m

  • 1g

  • 2.5g

  • 10g

  • 25g

  • 40g

  • 50g

  • 100g

pn_vxlan_termination

boolean

physical port vxlan termination setting.

Choices:

  • no

  • yes

state

string / required

State the action to perform. Use update to modify the port-config.

Choices:

  • update

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

Description

changed

boolean

indicates whether the CLI caused changes on the target.

Returned: always

command

string

the CLI command run on the target node.

Returned: always

stderr

list / elements=string

set of error responses from the port-config command.

Returned: on error

stdout

list / elements=string

set of responses from the port-config command.

Returned: always

Authors

  • Pluribus Networks (@rajaspachipulusu17)