Documentation

pn_cluster - CLI command to create/delete a cluster.

New in version 2.2.

Synopsis

  • Execute cluster-create or cluster-delete command.
  • A cluster allows two switches to cooperate in high-availability (HA) deployments. The nodes that form the cluster must be members of the same fabric. Clusters are typically used in conjunction with a virtual link aggregation group (VLAG) that allows links physically connected to two separate switches appear as a single trunk to a third device. The third device can be a switch,server, or any Ethernet device.

Options

parameter required default choices comments
pn_clipassword
 no
Provide login password if user is not root.
pn_cliswitch
 no
Target switch to run the cli on.
pn_cliusername
 no
Provide login username if user is not root.
pn_cluster_node1
 no
Specify the name of the first switch in the cluster.
Required for 'cluster-create'.
pn_cluster_node2
 no
Specify the name of the second switch in the cluster.
Required for 'cluster-create'.
pn_name
 yes
Specify the name of the cluster.
pn_validate
 no
  • validate
  • no-validate
Validate the inter-switch links and state of switches in the cluster.
state
 yes
  • present
  • absent
Specify action to perform. Use 'present' to create cluster and 'absent' to delete cluster.

Examples

- name: create spine cluster
  pn_cluster:
    state: 'present'
    pn_name: 'spine-cluster'
    pn_cluster_node1: 'spine01'
    pn_cluster_node2: 'spine02'
    pn_validate: validate
    pn_quiet: True

- name: delete spine cluster
  pn_cluster:
    state: 'absent'
    pn_name: 'spine-cluster'
    pn_quiet: True

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
changed Indicates whether the CLI caused changes on the target. always bool
command The CLI command run on the target node(s). always str
stderr The set of error responses from the cluster command. on error list
stdout The set of responses from the cluster command. always list


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.