netapp.ontap.na_ontap_ems_filter module – NetApp ONTAP EMS Filter

Note

This module is part of the netapp.ontap collection (version 24.0.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_filter.

New in netapp.ontap 22.4.0

Synopsis

• Create, delete, or modify EMS filters on NetApp ONTAP. This module only supports REST.

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_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.
gcnv aliases: google_netapp_unified_pool dictionary added in netapp.ontap 24.0.0	Configuration parameters for Google Cloud NetApp Volumes (GCNV) ONTAP-mode passthrough. These options are only supported with REST. When set, hostname, username, and password are not required. Option alias google_netapp_unified_pool is supported.
access_token string / required	OAuth 2.0 bearer token (JWT) used for authorization. Passed as a Bearer token in the HTTP Authorization header.
custom_base_url string	GCNV API base URL including version. Defaults to https://netapp.googleapis.com/v1. Default: "https://netapp.googleapis.com/v1"
location string / required	Google Cloud location, for example us-central1-a.
project_id string / required	Google Cloud project ID.
storage_pool string / required	GCNV storage pool name.
hostname string	The hostname or IP address of the ONTAP instance. Not required when gcnv is configured.
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.
lambda_config dictionary added in netapp.ontap 23.6.0	Configuration parameters for AWS Lambda proxy functionality. These option and suboptions are only supported with REST.
aws_profile string	The name of the AWS profile to use for authentication.
aws_region string / required	The name of the AWS region.
function_name string / required	The name of the AWS Lambda function to invoke.
name string / required	Name of the EMS Filter
password aliases: pass string	Password for the specified user.
rules list / elements=dictionary	List of EMS filter rules
index integer / required	Index of rule
message_criteria dictionary	Message criteria for EMS filter, required one of severities, name_pattern when creating ems filter.
name_pattern string	Name pattern to apply rule to
severities string	comma separated string of severities this rule applies to
parameter_criteria list / elements=dictionary added in netapp.ontap 23.3.0	Parameter criteria for EMS filter, used to match specific parameters in EMS messages.
name_pattern string	Name pattern for parameter matching
value_pattern string	Value pattern for parameter matching
type string / required	The type of rule Choices: "include" "exclude"
state string	Whether the specified user should exist or not. Choices: "present" ← (default) "absent"
use_lambda boolean added in netapp.ontap 23.4.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	This module only supports REST. always -- will always use the REST API. A warning is issued if the module does not support REST. 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 Basic authentication, using username and password. 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

• This module only supports REST.

• Supports AWS Lambda proxy functionality. See README for example usage.

• Supports GCNV ONTAP-mode REST passthrough when gcnv is provided. See the README file for examples.

• 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: Create EMS filter
  netapp.ontap.na_ontap_ems_filter:
    state: present
    name: carchi_ems
    rules:
      - index: 1
        type: include
        message_criteria:
          severities: "error"
          name_pattern: "callhome.*"
      - index: 2
        type: include
        message_criteria:
          severities: "EMERGENCY"

- name: Modify EMS filter add rule
  netapp.ontap.na_ontap_ems_filter:
    state: present
    name: carchi_ems
    rules:
      - index: 1
        type: include
        message_criteria:
          severities: "error"
          name_pattern: "callhome.*"
      - index: 2
        type: include
        message_criteria:
          severities: "EMERGENCY"
      - index: 3
        type: include
        message_criteria:
          severities: "ALERT"

- name: Create EMS filter with parameter criteria
  netapp.ontap.na_ontap_ems_filter:
    state: present
    name: param_filter
    rules:
      - index: 1
        type: include
        message_criteria:
          severities: "error"
        parameter_criteria:
          - name_pattern: "volume"
            value_pattern: "vol0*"
          - name_pattern: "node"
            value_pattern: "cluster-01"

- name: Delete EMS Filter
  netapp.ontap.na_ontap_ems_filter:
    state: absent
    name: carchi_ems

Authors

• NetApp Ansible Team (@carchi8py)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)