community.network.pn_cluster – CLI command to create/delete a cluster.

Note

This plugin is part of the community.network collection.

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

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

DEPRECATED

Removed in

version 2.0.0

Why

Doesn’t support latest Pluribus Networks netvisor

Alternative

Latest modules will be pushed in Ansible future versions.

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.

Parameters

Parameter Choices/Defaults Comments
pn_clipassword
string
Provide login password if user is not root.
pn_cliswitch
string
Default:
"local"
Target switch to run the cli on.
pn_cliusername
string
Provide login username if user is not root.
pn_cluster_node1
string
Specify the name of the first switch in the cluster.
Required for 'cluster-create'.
pn_cluster_node2
string
Specify the name of the second switch in the cluster.
Required for 'cluster-create'.
pn_name
string / required
Specify the name of the cluster.
pn_validate
boolean
    Choices:
  • no
  • yes
Validate the inter-switch links and state of switches in the cluster.
state
string / required
    Choices:
  • present
  • absent
Specify action to perform. Use 'present' to create cluster and 'absent' to delete cluster.

Examples

- name: Create spine cluster
  community.network.pn_cluster:
    state: 'present'
    pn_name: 'spine-cluster'
    pn_cluster_node1: 'spine01'
    pn_cluster_node2: 'spine02'
    pn_validate: True
    pn_quiet: True

- name: Delete spine cluster
  community.network.pn_cluster:
    state: 'absent'
    pn_name: 'spine-cluster'
    pn_quiet: True

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(s).

stderr
list / elements=string
on error
The set of error responses from the cluster command.

stdout
list / elements=string
always
The set of responses from the cluster command.



Status

  • This module will be removed in version 2.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Pluribus Networks (@amitsi)