netapp.ontap.na_ontap_ems_destination module – NetApp ONTAP configuration for EMS event destination
Note
This module is part of the netapp.ontap collection (version 22.14.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_ems_destination.
New in netapp.ontap 21.23.0
Synopsis
Configure EMS destination.
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 |
|---|---|
Name of the CA certificate |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Name of the certificate |
|
Destination - content depends on the type. |
|
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. |
|
List of filters that destination is linked to. |
|
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. |
|
The hostname or IP address of the ONTAP instance. |
|
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. |
|
Name of the EMS destination. |
|
Password for the specified user. |
|
Whether the destination should be present or not. Choices:
|
|
The parameter is specified when the EMS destination type is |
|
Syslog Hostname Format Override. Choices:
|
|
Syslog Message Format. Choices:
|
|
Syslog Port. Default: |
|
Syslog Timestamp Format Override. Choices:
|
|
Syslog Transport Protocol. Choices:
|
|
Type of the EMS destination. Choices:
|
|
This module only supports REST. always -- will always use the REST API. A warning is issued if the module does not support REST. 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://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. 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:
|
Notes
Note
Supports check_mode.
This module only supports REST.
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: Configure REST EMS destination
netapp.ontap.na_ontap_ems_destination:
state: present
name: rest
type: rest_api
filters: ['important_events']
destination: http://my.rest.api/address
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"
- name: Configure REST EMS destination with a certificate
netapp.ontap.na_ontap_ems_destination:
state: present
name: rest
type: rest_api
filters: ['important_events']
destination: http://my.rest.api/address
certificate: my_cert
ca: my_cert_ca
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"
- name: Configure REST EMS destination with type syslog
netapp.ontap.na_ontap_ems_destination:
state: present
name: syslog_destination
type: syslog
filters: ['important_events']
destination: http://my.rest.api/address
certificate: my_cert
ca: my_cert_ca
syslog:
transport: udp_unencrypted
port: 514
message_format: legacy_netapp
hostname_format_override: no_override
timestamp_format_override: no_override
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"
- name: Remove email EMS destination
netapp.ontap.na_ontap_ems_destination:
state: absent
name: email_destination
type: email
filters: ['important_events']
destination: [email protected]
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"