netapp.ontap.na_ontap_fpolicy_event – NetApp ONTAP FPolicy policy event configuration

Note

This plugin is part of the netapp.ontap collection (version 21.10.0).

To install it use: ansible-galaxy collection install netapp.ontap.

To use it in a playbook, specify: netapp.ontap.na_ontap_fpolicy_event.

New in version 21.4.0: of netapp.ontap

Synopsis

  • Create, delete or modify an FPolicy policy event.

Requirements

The below requirements are needed on the host that executes this module.

  • Ansible 2.9

  • Python3 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.

  • To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter Choices/Defaults Comments
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
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.
file_operations
list / elements=string
    Choices:
  • close
  • create
  • create_dir
  • delete
  • delete_dir
  • getattr
  • link
  • lookup
  • open
  • read
  • write
  • rename
  • rename_dir
  • setattr
  • symlink
Name of file operations to be applied to the event. By default no operations are monitored.
filters
list / elements=string
    Choices:
  • monitor_ads
  • close_with_modification
  • close_without_modification
  • first_read
  • first_write
  • offline_bit
  • open_with_delete_intent
  • open_with_write_intent
  • write_with_size_change
  • close_with_read
  • setattr_with_owner_change
  • setattr_with_group_change
  • setattr_with_sacl_change
  • setattr_with_dacl_change
  • setattr_with_modify_time_change
  • setattr_with_access_time_change
  • setattr_with_creation_time_change
  • setattr_with_mode_change
  • setattr_with_size_change
  • setattr_with_allocation_size_change
  • exclude_directory
Name of filters to be applied to the event. It is notification filtering parameters. By default no filters are selected.
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
    Choices:
  • no ←
  • yes
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
name
string / required
Name of the Event.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
protocol
string
    Choices:
  • cifs
  • nfsv3
  • nfsv4
Name of protocol for which event is created. By default no protocol is selected.
state
string
    Choices:
  • present ←
  • absent
Whether the FPolicy policy event is present or not.
use_rest
string
Default:
"auto"
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
always -- will always use the REST API
never -- will always use the ZAPI
auto -- will try to use the REST Api
username
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.

aliases: user
validate_certs
boolean
    Choices:
  • no
  • yes ←
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.
volume_monitoring
boolean
    Choices:
  • no
  • yes
Indicator if the volume operation required for the event. If not specified the default Value is false.
vserver
string / required
The name of the vserver to create the event on.

Notes

Note

  • Support check_mode.

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- name: Create FPolicy Event
  na_ontap_fpolicy_event:
    state: present
    vserver: svm1
    name: fpolicy_event
    file_operations: ['create', 'create_dir', 'delete', 'delete_dir', 'read', 'close', 'rename', 'rename_dir']
    filters: ['first_read', 'close_with_modification']
    protocol: cifs
    volume_monitoring: false
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

- name: Modify FPolicy Event
  na_ontap_fpolicy_event:
    state: present
    vserver: svm1
    name: fpolicy_event
    volume_monitoring: true
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

- name: Delete FPolicy Event
  na_ontap_fpolicy_event:
    state: absent
    vserver: svm1
    name: fpolicy_event
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

Authors