netapp.ontap.na_ontap_autosupport module – NetApp ONTAP autosupport
Note
This module is part of the netapp.ontap collection (version 22.8.3).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_autosupport.
New in netapp.ontap 2.7.0
Synopsis
Enable/Disable Autosupport
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9 or later - 2.12 or later is recommended.
Python3 - 3.9 or later is recommended.
When using ZAPI, 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
Parameters
Parameter |
Comments |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
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. |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. When Ignored with ZAPI. |
|
specify the e-mail address from which the node sends AutoSupport messages. |
|
The hostname or IP address of the ONTAP instance. |
|
Specify whether the hostname of the node is included in the subject line of the AutoSupport message. Choices:
|
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
path to SSL client key file. |
|
Specify whether collection of AutoSupport data when the AutoSupport daemon is disabled. Choices:
|
|
List of mail server(s) used to deliver AutoSupport messages via SMTP. Both host names and IP addresses may be used as valid input. |
|
Specify delivery size limit for the HTTP transport protocol (in bytes). |
|
Specify delivery size limit for the SMTP transport protocol (in bytes). |
|
Specify whether the disk health data is collected as part of the AutoSupport data. Choices:
|
|
The name of the filer that owns the AutoSupport Configuration. |
|
Specifies up to five recipients of short AutoSupport e-mail messages. |
|
Specify whether the AutoSupport OnDemand Download feature is enabled. Choices:
|
|
The ontap api version to use |
|
Specifies up to five partner vendor recipients of full AutoSupport e-mail messages. |
|
Password for the specified user. |
|
Specify whether the performance data is collected as part of the AutoSupport data. Choices:
|
|
The URL used to deliver AutoSupport messages via HTTP POST. |
|
Specify the removal of customer-supplied data. Choices:
|
|
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”. |
|
Specify whether AutoSupport reminders are enabled or disabled. Choices:
|
|
Specify the maximum number of delivery attempts for an AutoSupport message. |
|
Specifies whether the AutoSupport daemon is present or absent. When this setting is absent, delivery of all AutoSupport messages is turned off. Choices:
|
|
Specifies whether AutoSupport notification to technical support is enabled. Choices:
|
|
Specifies up to five recipients of full AutoSupport e-mail messages. |
|
The name of the transport protocol used to deliver AutoSupport messages. Choices:
|
|
Whether to use REST or ZAPI. always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST. never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI. auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise. Default: |
|
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
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
When set to true each node will validate the digital certificates that it receives. Choices:
|
Notes
Note
The modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
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