Join AnsibleFest at Red Hat Summit!

netapp.storagegrid.na_sg_grid_ilm_pool module – Manage ILM pools on StorageGRID.

Note

This module is part of the netapp.storagegrid collection (version 21.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netapp.storagegrid.

To use it in a playbook, specify: netapp.storagegrid.na_sg_grid_ilm_pool.

New in netapp.storagegrid 21.14.0

Synopsis

  • Interact with ILM pools on NetApp StorageGRID.

Parameters

Parameter

Comments

api_url

string / required

Rest endpoint for all invocations against the grid

archives

list / elements=dictionary

A list of the sites that use the Archive Nodes storage grade

description

string

The IDs of all sites and storage grades for this storage pool.

The null site (“All Sites”) is the default site, which includes all current sites.

The null storage grade (“All Storage Nodes”) is the default storage grade, which includes all Storage Nodes at the selected site.

Use the All Sites default with care because it will automatically include new sites added in an expansion, which might not be the behavior you want.

To get more information about the sites and storage grades, use the ilm-grade-site and ilm-grades endpoints.

grade

integer

Storage grade ID

group

integer

If both the group and siteId fields are provided, for a disk, the siteId will be used when creating/ editing a storage pool.

siteId

string

If both the group and siteId fields are provided, for a disk, the siteId will be used when creating/ editing a storage pool.

auth_token

string / required

The authorization token for the API request

disks

list / elements=dictionary

A list of the sites and storage grades in the storage pool

description

string

The IDs of all sites and storage grades for this storage pool.

The null site (“All Sites”) is the default site, which includes all current sites.

The null storage grade (“All Storage Nodes”) is the default storage grade, which includes all Storage Nodes at the selected site.

Use the All Sites default with care because it will automatically include new sites added in an expansion, which might not be the behavior you want.

To get more information about the sites and storage grades, use the ilm-grade-site and ilm-grades endpoints.

grade

integer

Storage grade ID

group

integer

If both the group and siteId fields are provided, for a disk, the siteId will be used when creating/ editing a storage pool.

siteId

string

If both the group and siteId fields are provided, for a disk, the siteId will be used when creating/ editing a storage pool.

name

string / required

The name of the storage pool

Must be unique

state

string

Whether the specified pool should be created or deleted.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

Should https certificates be validated?

Choices:

  • false

  • true ← (default)

Notes

Note

  • The modules prefixed with na_sg are built to manage NetApp StorageGRID.

Examples

- name: Create ILM pool
  na_sg_grid_ilm_pool:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    name: "Data Center 1"
    disks:
      - group: 10
    archives: []

- name: Delete existing ILM pool
  na_sg_grid_ilm_pool:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    name: "profile1"
    state: absent

Return Values

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

Key

Description

resp

dictionary

Returns information about the StorageGRID ILM pool.

Returned: If state is ‘present’.

Sample: {"archives": [], "disks": [{"grade": null, "group": null, "siteId": null}], "displayName": "Data Center 1", "id": "p10771105546308032398", "name": "Data Center 1"}

Authors

  • Denis Magel (@dmagel-netapp)