netapp_eseries.santricity.na_santricity_asup – NetApp E-Series manage auto-support settings

Note

This plugin is part of the netapp_eseries.santricity collection (version 1.2.13).

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_eseries.santricity.

To use it in a playbook, specify: netapp_eseries.santricity.na_santricity_asup.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Allow the auto-support settings to be configured for an individual E-Series storage-system

Parameters

Parameter		Choices/Defaults	Comments
active boolean		Choices: no yes ←	Enable active/proactive monitoring for ASUP. When a problem is detected by our monitoring systems, it's possible that the bundle did not contain all of the required information at the time of the event. Enabling this option allows NetApp support personnel to manually request transmission or re-transmission of support data in order ot resolve the problem. Only applicable if state=enabled.
api_password string / required			The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
api_url string / required			The url to the SANtricity Web Services Proxy or Embedded Web Services API. Example https://prod-1.wahoo.acme.com:8443/devmgr/v2
api_username string / required			The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
days list / elements=string		Choices: monday tuesday wednesday thursday friday saturday sunday	A list of days of the week that ASUP bundles will be sent. A larger, weekly bundle will be sent on one of the provided days. aliases: schedule_days, days_of_week
email dictionary			Information particular to the e-mail delivery method. Uses the SMTP protocol. Required when M(method==email).
	sender string		Sender's email account Required when M(routing_type==email).
	server string		Mail server's IP address or fully qualified domain name. Required when M(routing_type==email).
	test_recipient string		Test verification email Required when M(routing_type==email).
end integer		Default: 24	An end hour may be specified in a range from 1 to 24 hours. ASUP bundles will be sent daily between the provided start and end time (UTC). start must be less than end.
maintenance_duration integer		Default: 24	The duration of time the ASUP maintenance mode will be active. Permittable range is between 1 and 72 hours. Required when state==maintenance_enabled.
maintenance_emails list / elements=string			List of email addresses for maintenance notifications. Required when state==maintenance_enabled.
method string		Choices: https ← http email	AutoSupport dispatch delivery method.
proxy dictionary			Information particular to the proxy delivery method. Required when M((method==https or method==http) and routing_type==proxy).
	host string		Proxy host IP address or fully qualified domain name. Required when M(method==http or method==https) and M(routing_type==proxy).
	password string		Password for the proxy.
	port integer		Proxy host port. Required when M(method==http or method==https) and M(routing_type==proxy).
	script string		Path to the AutoSupport routing script file. Required when M(method==http or method==https) and M(routing_type==script).
	username string		Username for the proxy.
routing_type string		Choices: direct ← proxy script	AutoSupport routing Required when M(method==https or method==http).
ssid string		Default: 1	The ID of the array to manage. This value must be unique for each array.
start integer		Default: 0	A start hour may be specified in a range from 0 to 23 hours. ASUP bundles will be sent daily between the provided start and end time (UTC). start must be less than end.
state string		Choices: enabled ← disabled maintenance_enabled maintenance_disabled	Enable/disable the E-Series auto-support configuration or maintenance mode. When this option is enabled, configuration, logs, and other support-related information will be relayed to NetApp to help better support your system. No personally identifiable information, passwords, etc, will be collected. The maintenance state enables the maintenance window which allows maintenance activities to be performed on the storage array without generating support cases. Maintenance mode cannot be enabled unless ASUP has previously been enabled.
validate boolean		Choices: no ← yes	Validate ASUP configuration.
validate_certs boolean		Choices: no yes ←	Should https certificates be validated?

Notes

Note

Check mode is supported.
Enabling ASUP will allow our support teams to monitor the logs of the storage-system in order to proactively respond to issues with the system. It is recommended that all ASUP-related options be enabled, but they may be disabled if desired.
This API is currently only supported with the Embedded Web Services API v2.0 and higher.
The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.
Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
M(netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP instance.

Examples

- name: Enable ASUP and allow pro-active retrieval of bundles
  na_santricity_asup:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: enabled
    active: true
    days: ["saturday", "sunday"]
    start: 17
    end: 20
- name: Set the ASUP schedule to only send bundles from 12 AM CST to 3 AM CST.
  na_santricity_asup:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: disabled
- name: Set the ASUP schedule to only send bundles from 12 AM CST to 3 AM CST.
  na_santricity_asup:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    state: maintenance_enabled
    maintenance_duration: 24
    maintenance_emails:
      - [email protected]
- name: Set the ASUP schedule to only send bundles from 12 AM CST to 3 AM CST.
  na_santricity_asup:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: maintenance_disabled

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
active boolean		on success	True if the active option has been enabled. Sample: True
asup boolean		on success	True if ASUP is enabled. Sample: True
cfg complex		on success	Provide the full ASUP configuration.
	asupEnabled boolean	success	True if ASUP has been enabled.
	daysOfWeek list / elements=string	success	The days of the week that ASUP bundles will be sent.
	onDemandEnabled boolean	success	True if ASUP active monitoring has been enabled.
msg string		on success	Success message Sample: The settings have been updated.

Authors

Michael Price (@lmprice)
Nathan Swartz (@ndswartz)

© 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_eseries/santricity/na_santricity_asup_module.html