netapp.storagegrid.na_sg_grid_sso module – Manage single sign-on (SSO) configuration on StorageGRID.

Note

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

New in netapp.storagegrid 21.17.0

Synopsis

  • Manage single sign-on (SSO) configuration 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

ca_cert

string

Custom certificate for securing the TLS connection between StorageGRID and the identity provider.

If no custom certificate is supplied and TLS is enabled, the OS CA certificate will be used.

disable

boolean / required

Whether single sign-on is enabled for the grid.

Choices:

  • false

  • true

disable_tls

boolean

Whether to disable TLS for securing the connection when the idp sends SSO configuration information in response to StorageGRID requests.

Choices:

  • false ← (default)

  • true

identity_provider

dictionary / required

Configuration for the identity provider (IdP) used for single sign-on.

admin_nodes

list / elements=dictionary

Single sign-on settings for each Admin Node. Required for Azure and Ping Federate. Optional for Active Directory.

federation_metadata_url

string

The URL for retrieving federation metadata from the admin node.

name

string

The name of the admin node.

federation_service_name

string

The name of the identity provider service, required for Active Directory and ignored for other types.

idp_type

string

The type of identity provider service. Default is Active Directory.

relying_party_identifier

string / required

The relying party unique identification string.

sandbox

boolean / required

Whether single sign-on sandbox mode is enabled for SSO configuration testing.

Choices:

  • false

  • true

state

string

The desired state of the SSO configuration.

Choices:

  • "present" ← (default)

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: Configure SSO with Azure identity provider
  netapp.storagegrid.na_sg_grid_sso:
    api_url: gmi.example.com
    auth_token: "storagegrid-auth-token"
    disable: false
    sandbox: true
    identity_provider:
      idp_type: Azure
      federation_service_name: ansible_test_federation
      relying_party_identifier: ansible_test_relying_party
      admin_nodes:
        - name: admin-node-1
          federation_metadata_url: https://admin-node-1.example.com/metadata
    disable_tls: true
    ca_cert: -----BEGIN CERTIFICATE----- abcdefghijkl1234FabcdefghijklABCD -----END CERTIFICATE----

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 single sign-on configuration.

Returned: If state is ‘present’.

Sample: {"caCert": "", "disable": false, "disableTLS": true, "identityProvider": {"adminNodes": [{"federationMetadataUrl": "https://admin-node-1.example.com/metadata", "nodeId": "12345678-90ab-cdef-1234-567890aqcdef"}], "federationServiceName": "ansible_test_federation", "relyingPartyIdentifier": "ansible_test_relying_party", "type": "Azure"}, "sandbox": true}

Authors

  • NetApp Ansible Team (@vinaykus)