netapp.ontap.na_ontap_fpolicy_scope module – NetApp ONTAP - Create, delete or modify an FPolicy policy scope configuration.
Note
This module is part of the netapp.ontap collection (version 21.24.1).
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_fpolicy_scope.
New in netapp.ontap 21.4.0
Synopsis
Create, delete or modify an FPolicy policy scope.
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 |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Indicates whether directory names are also subjected to extensions check, similar to file names. By default, the value is true if policy is configured with Native engine, false otherwise. Choices:
|
|
Export Policies to exclude for file access monitoring. By default no export policy is selected. |
|
Export policies to include for file access monitoring. By default no export policy is selected. |
|
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 extensions excluded for screening. By default no file extension is selected. |
|
File extensions included for screening. By default no file extension is selected. |
|
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 Ignored with ZAPI. |
|
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:
|
|
Indicates whether monitoring of objects with no extension is required. By default, the value is false. Choices:
|
|
path to SSL client key file. |
|
Name of the policy. The FPolicy policy must exist for the scope to be created. |
|
The ontap api version to use |
|
Password for the specified user. |
|
Shares to exclude for file access monitoring. By default no share is selected. |
|
Shares to include for file access monitoring. By default no share is selected. |
|
Whether the FPolicy policy scope is present or not Choices:
|
|
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: |
|
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
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:
|
|
Volumes that are inactive for the file policy. The list can include items which are regular expressions, such as ‘vol*’ or ‘user?’. Note that if a policy has both an exclude list and an include list, the include list is ignored by the filer when processing user requests. By default no volume is selected. |
|
Volumes that are active for the file policy. The list can include items which are regular expressions, such as ‘vol*’ or ‘user?’. By default no volume is selected. |
|
the name of the vserver to create the scope on |
Notes
Note
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 FPolicy scope
na_ontap_fpolicy_scope:
state: present
vserver: GBSMNAS80LD
name: policy1
export_policies_to_include: export1
shares_to_include: share1
username: "{{ username }}"
password: "{{ password }}"
hostname: "{{ hostname }}"
use_rest: "{{ use_rest }}"
- name: Modify FPolicy scope
na_ontap_fpolicy_scope:
state: present
vserver: GBSMNAS80LD
name: policy1
export_policies_to_include: export1,export2
shares_to_include: share1,share2
username: "{{ username }}"
password: "{{ password }}"
hostname: "{{ hostname }}"
use_rest: "{{ use_rest }}"
- name: Delete FPolicy scope
na_ontap_fpolicy_scope:
state: absent
vserver: GBSMNAS80LD
name: policy1
username: "{{ username }}"
password: "{{ password }}"
hostname: "{{ hostname }}"
use_rest: "{{ use_rest }}"