netapp.storagegrid.na_sg_grid_autosupport module – Configure autosupport 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_autosupport.

New in netapp.storagegrid 21.15.0

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Configure autosupport on NetApp StorageGRID.

Parameters

Parameter	Comments
aod_enable boolean	Enable or disable sending Autosupport on Demand. Choices: `false` `true`
api_url string / required	The url to the StorageGRID Admin Node REST API.
auth_token string / required	The authorization token for the API request
available_updates_enable boolean	Whether to check for software updates. Choices: `false` `true`
cert_enable boolean	Enable AutoSupport certificate validation. Choices: `false` `true`
destinations list / elements=dictionary	AutoSupport destinations.
ca_cert string	The public CA certificate bundle in Privacy-Enhanced Mail (PEM) format.
hostname string / required	Hostname of the destination.
port integer / required	The port to use to connect to the ASUP destination.
event_enable boolean	Enable event-triggered AutoSupport messages. Choices: `false` `true`
state string	The alert receiver should be present. Choices: `"present"` ← (default)
transport string	Protocol used for AutoSupport messages. If you use HTTP, use a proxy to forward the data as HTTPS. NetApp’s AutoSupport servers will reject HTTP messages. Choices: `"SMTP"` `"HTTP"` `"HTTPS"`
validate_certs boolean	Should https certificates be validated? Choices: `false` `true` ← (default)
weekly_enable boolean	Enable weekly AutoSupport messages. Choices: `false` `true`

Notes

Note

The modules prefixed with na_sg are built to manage NetApp StorageGRID.

Examples

- name: Configure autosupport
  netapp.storagegrid.na_sg_grid_autosupport:
    state: present
    aod_enable: true
    available_updates_enable: true
    event_enable: true
    cert_enable: true
    transport: SMTP
    weekly_enable: true

- name: Configure autosupport with destinations
  netapp.storagegrid.na_sg_grid_autosupport:
    state: present
    aod_enable: true
    available_updates_enable: true
    event_enable: true
    cert_enable: true
    destinations:
      - hostname: "example.com"
        port: 443
        ca_cert: "<CA bundle in PEM-encoding>"
    transport: HTTPS
    weekly_enable: true

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 autosupport. Returned: If state is ‘present’. Sample: `{"aodEnable": true, "availableUpdatesEnable": true, "certEnable": true, "destinations": [{"caCert": null, "hostname": "example.com", "port": 443}], "eventEnable": true, "transport": "SMTP", "weeklyEnable": true}`

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_autosupport_module.html