netapp.storagegrid.na_sg_grid_ilm_policy_tag module – Manage ILM policy tags on StorageGRID.

Note

This module is part of the netapp.storagegrid collection (version 21.16.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_policy_tag.

New in netapp.storagegrid 21.14.0

Synopsis

  • Interact with ILM policy tags on NetApp StorageGRID.

Parameters

Parameter

Comments

api_url

string / required

The url to the StorageGRID Admin Node REST API.

auth_token

string / required

The authorization token for the API request

description

string

The description of this policy tag.

Visible to tenants, do not include sensitive information.

name

string / required

The unique name of this tag.

Assigning an ILM policy to this tag applies the policy only to buckets tagged with NTAP-SG-ILM-BUCKET as the key and this name as the value (case-insensitive).

Visible to tenants, do not include sensitive information.

policy_id

string

The ID of the ILM policy that will use this tag.

state

string

Whether the specified ILM policy tag 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 policy tag
  na_sg_grid_ilm_policy_tag:
    auth_token: 9bcf4902-d5a3-479a-8d5e-8f98ef879f4e
    api_url: https://192.168.0.80
    name: tag1
    description: Applies ILM policy 'mypolicy'
    policy_id: r601033236249396421

- name: Delete existing ILM policy tag
  na_sg_grid_ILM_policy_tag:
    auth_token: 9bcf4902-d5a3-479a-8d5e-8f98ef879f4e
    api_url: https://192.168.0.80
    name: tag1
    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 policy tag.

Returned: If state is ‘present’.

Sample: {"description": "Data Center 1", "id": "f9cecfd8-fe93-4529-b883-d1707e753009", "name": "tag1", "policy_id": "r601033236249396421"}

Authors

  • Denis Magel (@dmagel-netapp)