netapp.ontap.na_ontap_autosupport – NetApp ONTAP autosupport

Note

This plugin is part of the netapp.ontap collection (version 21.12.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.ontap.

To use it in a playbook, specify: netapp.ontap.na_ontap_autosupport.

New in version 2.7.0: of netapp.ontap

Synopsis

  • Enable/Disable Autosupport

Requirements

The below requirements are needed on the host that executes this module.

  • Ansible 2.9
  • Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
  • netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
  • A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.
  • REST support requires ONTAP 9.6 or later.
  • To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter Choices/Defaults Comments
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
Enable or disable a new feature.
This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility.
Supported keys and values are subject to change without notice. Unknown keys are ignored.
from_address
string
added in 2.8.0 of netapp.ontap
specify the e-mail address from which the node sends AutoSupport messages
hostname
string / required
The hostname or IP address of the ONTAP instance.
hostname_in_subject
boolean
added in 2.8.0 of netapp.ontap
    Choices:
  • no
  • yes
Specify whether the hostname of the node is included in the subject line of the AutoSupport message.
http_port
integer
Override the default port (80 or 443) with this port
https
boolean
    Choices:
  • no
  • yes
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
local_collection_enabled
boolean
added in 21.5.0 of netapp.ontap
    Choices:
  • no
  • yes
Specify whether collection of AutoSupport data when the AutoSupport daemon is disabled.
mail_hosts
list / elements=string
List of mail server(s) used to deliver AutoSupport messages via SMTP.
Both host names and IP addresses may be used as valid input.
max_http_size
integer
added in 21.5.0 of netapp.ontap
Specify delivery size limit for the HTTP transport protocol (in bytes).
max_smtp_size
integer
added in 21.5.0 of netapp.ontap
Specify delivery size limit for the SMTP transport protocol (in bytes).
nht_data_enabled
boolean
added in 21.5.0 of netapp.ontap
    Choices:
  • no
  • yes
Specify whether the disk health data is collected as part of the AutoSupport data.
node_name
string / required
The name of the filer that owns the AutoSupport Configuration.
noteto
list / elements=string
Specifies up to five recipients of short AutoSupport e-mail messages.
ondemand_enabled
boolean
added in 21.5.0 of netapp.ontap
    Choices:
  • no
  • yes
Specify whether the AutoSupport OnDemand Download feature is enabled.
ontapi
integer
The ontap api version to use
partner_addresses
list / elements=string
added in 2.8.0 of netapp.ontap
Specifies up to five partner vendor recipients of full AutoSupport e-mail messages.
password
string
Password for the specified user.

aliases: pass
perf_data_enabled
boolean
added in 21.5.0 of netapp.ontap
    Choices:
  • no
  • yes
Specify whether the performance data is collected as part of the AutoSupport data.
post_url
string
The URL used to deliver AutoSupport messages via HTTP POST
private_data_removed
boolean
added in 21.5.0 of netapp.ontap
    Choices:
  • no
  • yes
Specify the removal of customer-supplied data.
proxy_url
string
added in 2.8.0 of netapp.ontap
specify an HTTP or HTTPS proxy if the 'transport' parameter is set to HTTP or HTTPS and your organization uses a proxy.
If authentication is required, use the format "username:password@host:port".
reminder_enabled
boolean
added in 21.5.0 of netapp.ontap
    Choices:
  • no
  • yes
Specify whether AutoSupport reminders are enabled or disabled.
retry_count
integer
added in 21.5.0 of netapp.ontap
Specify the maximum number of delivery attempts for an AutoSupport message.
state
string
    Choices:
  • present
  • absent
Specifies whether the AutoSupport daemon is present or absent.
When this setting is absent, delivery of all AutoSupport messages is turned off.
support
boolean
    Choices:
  • no
  • yes
Specifies whether AutoSupport notification to technical support is enabled.
to_addresses
list / elements=string
added in 2.8.0 of netapp.ontap
Specifies up to five recipients of full AutoSupport e-mail messages.
transport
string
    Choices:
  • http
  • https
  • smtp
The name of the transport protocol used to deliver AutoSupport messages
use_rest
string
Default:
"auto"
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
always -- will always use the REST API
never -- will always use the ZAPI
auto -- will try to use the REST Api
username
string
This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.
For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.
Two authentication methods are supported
1. basic authentication, using username and password,
2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file.
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled.

aliases: user
validate_certs
boolean
    Choices:
  • no
  • yes
If set to no, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
validate_digital_certificate
boolean
added in 21.5.0 of netapp.ontap
    Choices:
  • no
  • yes
When set to true each node will validate the digital certificates that it receives.

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- name: Enable autosupport
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: present
    node_name: test
    transport: https
    noteto: [email protected],[email protected]
    mail_hosts: 1.2.3.4,5.6.7.8
    support: False
    post_url: url/1.0/post
- name: Modify autosupport proxy_url with password
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: present
    node_name: test
    transport: https
    proxy_url: username:[email protected]:8000
- name: Modify autosupport proxy_url without password
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: present
    node_name: test
    transport: https
    proxy_url: [email protected]:8000
- name: Disable autosupport
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: absent
    node_name: test

Authors

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