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

From Get docs
Ansible/docs/2.11/collections/community/network/pn fabric local module


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

Note

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

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.

Parameters

Parameter Choices/Defaults Comments

pn_cliswitch

string / required

Target switch to run the CLI on.

pn_control_network

string

  • in-band
  • mgmt
  • vmgmt

control plane network.

pn_fabric_advertisement_network

string

  • inband-mgmt
  • inband-only
  • inband-vmgmt
  • mgmt-only

network to send fabric advertisements on.

pn_fabric_network

string

  • in-band
  • mgmt

  • vmgmt

fabric administration network.

pn_vlan

string

VLAN assigned to fabric.

state

string

  • update

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



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


stdout

list / elements=string

always

set of responses from the fabric-local command.





Authors

  • Pluribus Networks (@rajaspachipulusu17)

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