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.23.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 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

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

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:

  • no

  • yes

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.

force_ontap_version

string

added in 21.23.0 of netapp.ontap

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 use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

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

Enable and disable https.

Ignored when using REST as only https is supported.

Ignored when using SSL certificate authentication as it requires SSL.

Choices:

  • no ← (default)

  • yes

is_monitoring_of_objects_with_no_extension_enabled

boolean

Indicates whether monitoring of objects with no extension is required. By default, the value is false.

Choices:

  • no

  • yes

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

aliases: pass

string

Password for the specified user.

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

Whether the FPolicy policy scope is present or not

Choices:

  • present ← (default)

  • absent

use_rest

string

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: “auto”

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://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.

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:

  • no

  • yes ← (default)

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.

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

Authors

  • NetApp Ansible Team (@carchi8py)