netapp.storagegrid.na_sg_grid_domain_name module – Configure endpoint domain name 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_domain_name.

New in netapp.storagegrid 21.15.0

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Configure endpoint domain name 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
domain_name list / elements=string / required	List of domain names to be configured.
state string	The endpoint domain name should be present. 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 endpoint domain name
  netapp.storagegrid.na_sg_grid_domain_name:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    state: present
    validate_certs: false
    domain_name:
      - example1.com
      - example2.com

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 domain name. Returned: If state is ‘present’. Sample: `["example1.com", "example2.com"]`

Authors

NetApp Ansible Team (@vinaykus)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/netapp/storagegrid/na_sg_grid_domain_name_module.html