netapp.ontap.na_ontap_fpolicy_policy – NetApp ONTAP - Create, delete or modify an FPolicy policy.

Note

This plugin is part of the netapp.ontap collection (version 21.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.

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

New in version 21.3.0: of netapp.ontap

Synopsis

  • Create, delete or modify an FPolicy policy. Fpolicy scope must exist before running this module.

  • FPolicy is a file access notification framework that enables an administrator to monitor file and directory access in storage configured for CIFS and NFS.

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
allow_privileged_access
boolean
    Choices:
  • no
  • yes
Specifies if privileged access should be given to FPolicy servers registered for the policy.
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
engine
string
Name of the Engine. External engines must be created prior to running this task.
events
list / elements=string / required
Events for file access monitoring.
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.
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.
is_mandatory
boolean
    Choices:
  • no
  • yes
Specifies the action to take on a file access event in the case when all primary and secondary servers are down or no response is received from the
FPolicy servers within a given timeout period. When True, file access events will be denied under these circumstances
is_passthrough_read_enabled
boolean
    Choices:
  • no
  • yes
Specifies if passthrough-read should be allowed to FPolicy servers registered for the policy.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
name
string / required
Name of the policy.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
privileged_user_name
string
User name for privileged access.
state
string
    Choices:
  • present ←
  • absent
Whether the fPolicy policy should exist 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.
vserver
string / required
the name of the vserver to create the policy on

Notes

Note

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

Examples

- name: Create FPolicy policy
  na_ontap_fpolicy_policy:
    state: present
    vserver: svm1
    name: fpolicy_policy
    events: fcpolicy_event
    engine: fpolicy_ext_engine
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

- name: Modify FPolicy policy
  na_ontap_fpolicy_policy:
    state: present
    vserver: svm1
    name: fpolicy_policy
    events: fcpolicy_event
    is_mandatory: false
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

- name: Delete FPolicy policy
  na_ontap_fpolicy_policy:
    state: absent
    vserver: svm1
    name: fpolicy_policy
    events: fcpolicy_event
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

Authors