Docs4dev
Docs
ansible / latest / collections / netapp / ontap / na_ontap_fpolicy_scope_module.html

netapp.ontap.na_ontap_fpolicy_scope – NetApp ONTAP - Create, delete or modify an FPolicy policy scope configuration.

Note

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

New in version 21.4.0: of netapp.ontap

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
  • 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.
check_extensions_on_directories
boolean
    Choices:
  • no
  • yes
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.
export_policies_to_exclude
list / elements=string
Export Policies to exclude for file access monitoring. By default no export policy is selected.
export_policies_to_include
list / elements=string
Export policies to include for file access monitoring. By default no export policy is selected.
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_extensions_to_exclude
list / elements=string
File extensions excluded for screening. By default no file extension is selected.
file_extensions_to_include
list / elements=string
File extensions included for screening. By default no file extension is 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.
is_monitoring_of_objects_with_no_extension_enabled
boolean
    Choices:
  • no
  • yes
Indicates whether monitoring of objects with no extension is required. By default, the value is false.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
name
string / required
Name of the policy. The FPolicy policy must exist for the scope to be created.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
shares_to_exclude
list / elements=string
Shares to exclude for file access monitoring. By default no share is selected.
shares_to_include
list / elements=string
Shares to include for file access monitoring. By default no share is selected.
state
string
    Choices:
  • present ←
  • absent
Whether the FPolicy policy scope 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.
volumes_to_exclude
list / elements=string
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_to_include
list / elements=string
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.
vserver
string / required
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.

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 }}"

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_fpolicy_scope_module.html