Spec-Zone.ru › Ansible

netapp.ontap.na_ontap_autosupport module – NetApp ONTAP autosupport

Note

This module is part of the netapp.ontap collection (version 23.5.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. 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
  • Requirements
  • Parameters
  • Notes
  • Examples

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.
  • netapp-lib only when using ZAPI (install using ‘pip install netapp-lib’), Please note that netapp-lib is deprecated and no longer maintained. Proceed at your own risk.
  • 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

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

feature_flags

dictionary

added in netapp.ontap 20.5.0

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.

force

boolean

added in netapp.ontap 23.2.0

Set the force flag to true to modify some of the AutoSupport configurations that are otherwise blocked when the automatic update feature is enabled.

Without this flag set to true, an attempt to disable AutoSupport, modify the transport to SMTP, or disable the AutoSupport OnDemand feature fails if the automatic update feature is enabled.

Choices:

  • false
  • true

force_ontap_version

string

added in netapp.ontap 21.23.0

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 use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

from_address

string

added in netapp.ontap 2.8.0

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 netapp.ontap 2.8.0

Specify whether the hostname of the node is included in the subject line of the AutoSupport message.

Supported only with ZAPI.

Choices:

  • false
  • true

http_port

integer

Override the default port (80 or 443) with this port

https

boolean

Enable and disable https.

Ignored when using REST as only https is supported.

Ignored when using SSL certificate authentication as it requires SSL.

Choices:

  • false ← (default)
  • true

is_minimal

boolean

added in netapp.ontap 23.2.0

Specifies whether the system information is collected in compliant form, to remove private data or in complete form, to enhance diagnostics.

Supported only with REST.

Choices:

  • false
  • true

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

local_collection_enabled

boolean

added in netapp.ontap 21.5.0

Specify whether collection of AutoSupport data when the AutoSupport daemon is disabled.

Supported only with ZAPI.

Choices:

  • false
  • true

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 netapp.ontap 21.5.0

Specify delivery size limit for the HTTP transport protocol (in bytes).

Supported only with ZAPI.

max_smtp_size

integer

added in netapp.ontap 21.5.0

Specify delivery size limit for the SMTP transport protocol (in bytes).

Supported only with ZAPI.

nht_data_enabled

boolean

added in netapp.ontap 21.5.0

Specify whether the disk health data is collected as part of the AutoSupport data.

Supported only with ZAPI.

Choices:

  • false
  • true

node_name

string

The name of the filer that owns the AutoSupport Configuration.

Supported only with ZAPI.

noteto

list / elements=string

Specifies up to five recipients of short AutoSupport e-mail messages.

Supported only with ZAPI.

ondemand_enabled

boolean

added in netapp.ontap 21.5.0

Specify whether the AutoSupport OnDemand Download feature is enabled.

Choices:

  • false
  • true

ontapi

integer

The ontap api version to use

partner_addresses

list / elements=string

added in netapp.ontap 2.8.0

Specifies up to five partner vendor recipients of full AutoSupport e-mail messages.

password

aliases: pass

string

Password for the specified user.

perf_data_enabled

boolean

added in netapp.ontap 21.5.0

Specify whether the performance data is collected as part of the AutoSupport data.

Supported only with ZAPI.

Choices:

  • false
  • true

post_url

string

The URL used to deliver AutoSupport messages via HTTP POST.

Supported only with ZAPI.

private_data_removed

boolean

added in netapp.ontap 21.5.0

Specify the removal of customer-supplied data.

Supported only with ZAPI.

Choices:

  • false
  • true

proxy_url

string

added in netapp.ontap 2.8.0

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 netapp.ontap 21.5.0

Specify whether AutoSupport reminders are enabled or disabled.

Supported only with ZAPI.

Choices:

  • false
  • true

retry_count

integer

added in netapp.ontap 21.5.0

Specify the maximum number of delivery attempts for an AutoSupport message.

Supported only with ZAPI.

smtp_encryption

string

added in netapp.ontap 23.2.0

The encryption protocol used to deliver AutoSupport messages via SMTP to the configured mail_hosts.

Supported only with REST.

Choices:

  • "none"
  • "start_tls"

state

string

Specifies whether the AutoSupport daemon is to be enabled or disabled.

When this setting is absent, delivery of all AutoSupport messages is turned off.

Choices:

  • "present" ← (default)
  • "absent"

support

boolean

Specifies whether AutoSupport notification to technical support is enabled.

Choices:

  • false
  • true

to_addresses

list / elements=string

added in netapp.ontap 2.8.0

Specifies up to five recipients of full AutoSupport e-mail messages.

transport

string

The name of the transport protocol used to deliver AutoSupport messages.

Choices:

  • "http"
  • "https"
  • "smtp"

use_lambda

boolean

added in netapp.ontap 23.2.0

Specifies if AWS Lambda proxy functionality should be used to connect to the ONTAP system.

Supported only with REST.

Choices:

  • false ← (default)
  • true

use_rest

string

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: "always"

username

aliases: user

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://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html.

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.

validate_certs

boolean

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.

Choices:

  • false
  • true ← (default)

validate_digital_certificate

boolean

added in netapp.ontap 21.5.0

When set to true each node will validate the digital certificates that it receives.

Supported only with ZAPI.

Choices:

  • false
  • true

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 - ZAPI
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    state: present
    node_name: test
    transport: https
    noteto: abc@def.com,def@ghi.com
    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 - ZAPI
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    state: present
    node_name: test
    transport: https
    proxy_url: username:password@host.com:8000

- name: Modify autosupport proxy_url without password - ZAPI
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    state: present
    node_name: test
    transport: https
    proxy_url: username@host.com:8000

- name: Disable autosupport - ZAPI
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    state: absent
    node_name: test

- name: Enable autosupport - REST
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    transport: https
    mail_hosts: 1.2.3.4,5.6.7.8
    proxy_url: proxyhost.local.com
    to_addresses: rst@xyz.com
    from_address: testmail1@abc.com
    ondemand_enabled: true
    support: true
    state: present
    force: true
    is_minimal: true
    smtp_encryption: none
    partner_addresses: test2@xyz.com

- name: Modify autosupport - REST
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    transport: smtp
    mail_hosts: 1.2.3.4:25
    proxy_url: proxyhost.local.com
    to_addresses: rst@xyz.com,mymail@abc.com
    from_address: testmail@abc.com
    ondemand_enabled: false
    support: false
    state: present
    is_minimal: false
    smtp_encryption: start_tls
    partner_addresses: test1@xyz.com
    force: true

- name: Disable autosupport - REST
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    state: absent

Authors

  • NetApp Ansible Team (@carchi8py)

Collection links

  • Issue Tracker
  • Homepage
  • Repository (Sources)

© 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/ontap/na_ontap_autosupport_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API