netapp.storagegrid.na_sg_grid_ha_group (21.12.0) — module

Install collection

Install with ansible-galaxy collection install netapp.storagegrid:==21.12.0

Add to requirements.yml

  collections:
    - name: netapp.storagegrid
      version: 21.12.0

Description

Create, Update, Delete HA Groups on NetApp StorageGRID.

Usage examples

Scanned by Steampunk Spotter

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

  - name: create HA Group
    netapp.storagegrid.na_sg_grid_ha_group:
      api_url: "https://<storagegrid-endpoint-url>"
      auth_token: "storagegrid-auth-token"
      validate_certs: false
      state: present
      name: Site1-HA-Group
      description: "Site 1 HA Group"
      gateway_cidr: 192.168.50.1/24
      virtual_ips: 192.168.50.5
      interfaces:
        - node: SITE1-ADM1
          interface: eth2
        - node: SITE1-G1
          interface: eth2

Scanned by Steampunk Spotter

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

  - name: add VIP to HA Group
    netapp.storagegrid.na_sg_grid_ha_group:
      api_url: "https://<storagegrid-endpoint-url>"
      auth_token: "storagegrid-auth-token"
      validate_certs: false
      state: present
      name: Site1-HA-Group
      description: "Site 1 HA Group"
      gateway_cidr: 192.168.50.1/24
      virtual_ips: 192.168.50.5,192.168.50.6
      interfaces:
        - node: SITE1-ADM1
          interface: eth2
        - node: SITE1-G1
          interface: eth2

Scanned by Steampunk Spotter

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

  - name: rename HA Group
    netapp.storagegrid.na_sg_grid_ha_group:
      api_url: "https://<storagegrid-endpoint-url>"
      auth_token: "storagegrid-auth-token"
      validate_certs: false
      state: present
      ha_group_id: 00000000-0000-0000-0000-000000000000
      name: Site1-HA-Group-New-Name
      description: "Site 1 HA Group"
      gateway_cidr: 192.168.50.1/24
      virtual_ips: 192.168.50.5
      interfaces:
        - node: SITE1-ADM1
          interface: eth2
        - node: SITE1-G1
          interface: eth2

Scanned by Steampunk Spotter

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

  - name: delete HA Group
    netapp.storagegrid.na_sg_grid_ha_group:
      api_url: "https://<storagegrid-endpoint-url>"
      auth_token: "storagegrid-auth-token"
      validate_certs: false
      state: absent
      name: Site1-HA-Group

Inputs

    
name:
    description:
    - Name of the HA Group.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified HA Group should exist.
    type: str

api_url:
    description:
    - The url to the StorageGRID Admin Node REST API.
    required: true
    type: str

auth_token:
    description:
    - The authorization token for the API request
    required: true
    type: str

interfaces:
    description:
    - A set of StorageGRID node interface pairs.
    - The primary interface is specified first, followed by the other interface pairs
      in failover order.
    elements: dict
    suboptions:
      interface:
        description:
        - The interface to bind to. eth0 corresponds to the Grid Network, eth1 to the
          Admin Network, and eth2 to the Client Network.
        type: str
      node:
        description:
        - Name of the StorageGRID node.
        type: str
    type: list

description:
    description:
    - Description of the HA Group.
    type: str

ha_group_id:
    description:
    - HA Group ID.
    - May be used for modify or delete operation.
    type: str

virtual_ips:
    description:
    - A list of virtual IP addresses.
    elements: str
    type: list

gateway_cidr:
    description:
    - CIDR for the gateway IP and VIP subnet.
    type: str

validate_certs:
    default: true
    description:
    - Should https certificates be validated?
    required: false
    type: bool

Outputs

resp:
  description: Returns information about the StorageGRID HA Group.
  returned: success
  sample:
    description: Site 1 HA Group
    gatewayCidr: 192.168.50.1/24
    id: bb386f30-805d-4fec-a2c5-85790b460db0
    interfaces:
    - interface: eth2
      nodeId: 0b1866ed-d6e7-41b4-815f-bf867348b76b
    - interface: eth2
      nodeId: 7bb5bf05-a04c-4344-8abd-08c5c4048666
    name: Site1-HA-Group
    virtualIps:
    - 192.168.50.5
    - 192.168.50.6
  type: dict