community.network.pn_fabric_local module – CLI command to modify fabric-local

Note

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

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_fabric_local.

Synopsis

  • This module can be used to modify fabric local information.

Aliases: network.netvisor.pn_fabric_local

Parameters

Parameter

Comments

pn_cliswitch

string / required

Target switch to run the CLI on.

pn_control_network

string

control plane network.

Choices:

  • "in-band"

  • "mgmt"

  • "vmgmt"

pn_fabric_advertisement_network

string

network to send fabric advertisements on.

Choices:

  • "inband-mgmt"

  • "inband-only"

  • "inband-vmgmt"

  • "mgmt-only"

pn_fabric_network

string

fabric administration network.

Choices:

  • "in-band"

  • "mgmt" ← (default)

  • "vmgmt"

pn_vlan

string

VLAN assigned to fabric.

state

string

State the action to perform. Use update to modify the fabric-local.

Choices:

  • "update" ← (default)

Examples

- name: Fabric local module
  community.network.pn_fabric_local:
    pn_cliswitch: "sw01"
    pn_vlan: "500"

- name: Fabric local module
  community.network.pn_fabric_local:
    pn_cliswitch: "sw01"
    pn_fabric_advertisement_network: "mgmt-only"

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 fabric-local command.

Returned: on error

stdout

list / elements=string

set of responses from the fabric-local command.

Returned: always

Authors

  • Pluribus Networks (@rajaspachipulusu17)