netapp.storagegrid.na_sg_grid_login module – Login to StorageGRID grid/tenant.

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_login.

New in netapp.storagegrid 21.16.0

Synopsis

  • This module generates authentication token to get login into grid/tenant module.

Parameters

Parameter

Comments

hostname

string / required

The ip or fqdn of the admin node for the grid.

password

string / required

The password of the user authenticating.

tenant_id

string

The uuid of the tenant to log into tenant manager.

username

string / required

The username of the user authenticating.

validate_certs

boolean

Should https certificates be validated?

Choices:

  • false

  • true ← (default)

Examples

- name: generate auth token for grid module on StorageGRID
  netapp.storagegrid.na_sg_grid_login:
    hostname: 1.2.3.4
    username: root
    password: admin123
    validate_certs: false
  register: auth

- name: generate auth token for org module on StorageGRID
  netapp.storagegrid.na_sg_grid_login:
    hostname: 1.2.3.4
    username: tenant_username
    password: tenant_password
    tenant_id: 24240721088016532652
    validate_certs: false
  register: auth

Return Values

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

Key

Description

resp

string

Returns information about the authentication token.

Returned: success

Sample: "24263715-99c1-4d32-8c7f-e21cd0f6a731"

Authors

  • NetApp Ansible Team (@vinaykus)