community.general.pn_cluster (0.1.1) — module

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

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
state:
    choices:
    - present
    - absent
    description:
    - Specify action to perform. Use 'present' to create cluster and 'absent' to delete
      cluster.
    required: true

pn_name:
    description:
    - Specify the name of the cluster.
    required: true

pn_validate:
    description:
    - Validate the inter-switch links and state of switches in the cluster.
    type: bool

pn_cliswitch:
    default: local
    description:
    - Target switch to run the cli on.
    required: false

pn_clipassword:
    description:
    - Provide login password if user is not root.
    required: false

pn_cliusername:
    description:
    - Provide login username if user is not root.
    required: false

pn_cluster_node1:
    description:
    - Specify the name of the first switch in the cluster.
    - Required for 'cluster-create'.

pn_cluster_node2:
    description:
    - Specify the name of the second switch in the cluster.
    - Required for 'cluster-create'.

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(s).
  returned: always
  type: str
stderr:
  description: The set of error responses from the cluster command.
  returned: on error
  type: list
stdout:
  description: The set of responses from the cluster command.
  returned: always
  type: list