community.general.pn_port_config (0.1.1) — module

CLI command to modify port-config

Authors: Pluribus Networks (@rajaspachipulusu17)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module can be used to modify a port configuration.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: port config modify
  pn_port_config:
    pn_cliswitch: "sw01"
    state: "update"
    pn_port: "all"
    pn_dscp_map: "foo"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: port config modify
  pn_port_config:
    pn_cliswitch: "sw01"
    state: "update"
    pn_port: "all"
    pn_host_enable: true

Inputs

    
state:
    choices:
    - update
    description:
    - State the action to perform. Use C(update) to modify the port-config.
    required: true
    type: str

pn_intf:
    description:
    - physical interface.
    required: false
    type: str

pn_port:
    description:
    - physical port.
    required: false
    type: str

pn_jumbo:
    description:
    - jumbo frames on physical port.
    required: false
    type: bool

pn_pause:
    description:
    - physical port pause.
    required: false
    type: bool

pn_speed:
    choices:
    - disable
    - 10m
    - 100m
    - 1g
    - 2.5g
    - 10g
    - 25g
    - 40g
    - 50g
    - 100g
    description:
    - physical port speed.
    required: false

pn_enable:
    description:
    - physical port enable.
    required: false
    type: bool

pn_autoneg:
    description:
    - physical port autonegotiation.
    required: false
    type: bool

pn_reflect:
    description:
    - physical port reflection.
    required: false
    type: bool

pn_routing:
    description:
    - routing.
    required: false
    type: bool

pn_dscp_map:
    description:
    - DSCP map name to enable on port.
    required: false
    type: str

pn_eth_mode:
    choices:
    - 1000base-x
    - sgmii
    - disabled
    - GMII
    description:
    - physical Ethernet mode.
    required: false

pn_loopback:
    description:
    - physical port loopback.
    required: false
    type: bool

pn_cliswitch:
    description:
    - Target switch to run the CLI on.
    required: false
    type: str

pn_send_port:
    description:
    - send port.
    required: false
    type: str

pn_loop_vlans:
    description:
    - looping vlans.
    required: false
    type: str

pn_description:
    description:
    - physical port description.
    required: false
    type: str

pn_edge_switch:
    description:
    - physical port edge switch.
    required: false
    type: bool

pn_host_enable:
    description:
    - Host facing port control setting.
    required: false
    type: bool

pn_mirror_only:
    description:
    - physical port mirror only.
    required: false
    type: bool

pn_allowed_tpid:
    choices:
    - vlan
    - q-in-q
    - q-in-q-old
    description:
    - Allowed TPID in addition to 0x8100 on Vlan header.
    required: false
    type: str

pn_fabric_guard:
    description:
    - Fabric guard configuration.
    required: false
    type: bool

pn_defer_bringup:
    description:
    - defer port bringup.
    required: false
    type: bool

pn_lacp_priority:
    description:
    - LACP priority from 1 to 65535.
    required: false
    type: str

pn_local_switching:
    description:
    - no-local-switching port cannot bridge traffic to another no-local-switching port.
    required: false
    type: bool

pn_crc_check_enable:
    description:
    - CRC check on ingress and rewrite on egress.
    required: false
    type: bool

pn_port_mac_address:
    description:
    - physical port MAC Address.
    required: false
    type: str

pn_egress_rate_limit:
    description:
    - max egress port data rate limit.
    required: false
    type: str

pn_vxlan_termination:
    description:
    - physical port vxlan termination setting.
    required: false
    type: bool

Outputs

changed:
  description: indicates whether the CLI caused changes on the target.
  returned: always
  type: bool
command:
  description: the CLI command run on the target node.
  returned: always
  type: str
stderr:
  description: set of error responses from the port-config command.
  returned: on error
  type: list
stdout:
  description: set of responses from the port-config command.
  returned: always
  type: list