Join AnsibleFest at Red Hat Summit!

netapp.storagegrid.na_sg_grid_ec_profile module – Manage EC profiles 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_ec_profile.

New in netapp.storagegrid 21.14.0

Synopsis

  • Interact with EC profiles on NetApp StorageGRID.

Parameters

Parameter

Comments

api_url

string / required

Rest endpoint for all invocations against the grid

auth_token

string / required

The authorization token for the API request

name

string / required

The EC Profile’s name

pool_id

string

The Storage Pool ID of the selected scheme

scheme_id

string

The selected scheme for the EC profile

state

string

Whether the specified policy should be created or deactivated.

State “absent” only deactivates the EC profile.

Deactivated EC profiles cannot be activated

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 EC profile
  na_sg_grid_ec_profile:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    name: "profile1"
    pool_id: p10771105546308032398
    scheme_id: "1"

- name: Deactivate existing EC profile
  na_sg_grid_ec_profile:
    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 EC profile.

Returned: If state is ‘present’.

Sample: {"active": true, "id": "5", "name": "EC profile 123", "poolId": "p10771105546308032398", "schemeId": "4"}

Authors

  • Denis Magel (@dmagel-netapp)