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.10.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

ca

string

added in netapp.ontap 22.8.0

Name of the CA certificate

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

certificate

string

added in netapp.ontap 22.8.0

Name of the certificate

destination

string / required

Destination - content depends on the type.

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.

filters

list / elements=string / required

List of filters that destination is linked to.

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.

hostname

string / required

The hostname or IP address of the ONTAP instance.

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

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

name

string / required

Name of the EMS destination.

ontapi

integer

The ontap api version to use

password

aliases: pass

string

Password for the specified user.

state

string

Whether the destination should be present or not.

Choices:

  • "present" ← (default)

  • "absent"

syslog

dictionary

added in netapp.ontap 22.9.0

The parameter is specified when the EMS destination type is syslog.

hostname_format_override

string

Syslog Hostname Format Override.

Choices:

  • "no_override" ← (default)

  • "fqdn"

  • "hostname_only"

message_format

string

Syslog Message Format.

Choices:

  • "legacy_netapp" ← (default)

  • "rfc_5424"

port

integer

Syslog Port.

Default: 514

timestamp_format_override

string

Syslog Timestamp Format Override.

Choices:

  • "no_override" ← (default)

  • "rfc_3164"

  • "iso_8601_local_time"

  • "iso_8601_utc"

transport

string

Syslog Transport Protocol.

Choices:

  • "udp_unencrypted" ← (default)

  • "tcp_unencrypted"

  • "tcp_encrypted"

type

string / required

Type of the EMS destination.

Choices:

  • "email"

  • "syslog"

  • "rest_api"

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

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://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.

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)

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
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"

- 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
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"

- 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
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"

- name: Remove email EMS destination
  netapp.ontap.na_ontap_ems_destination:
    state: absent
    name: email_destination
    type: email
    filters: ['important_events']
    destination: [email protected]
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"

Authors

  • Bartosz Bielawski (@bielawb)