netapp.ontap.na_ontap_vscan_on_access_policy module – NetApp ONTAP Vscan on access policy configuration.
Note
This module is part of the netapp.ontap collection (version 21.20.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_vscan_on_access_policy.
New in version 2.8.0: of netapp.ontap
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 |
Comments |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
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 for which On-Access scanning must not be performed. |
|
File extensions for which On-Access scanning is considered. The default value is ‘*’, which means that all files are considered for scanning except those which are excluded from scanning. |
|
A list of filters which can be used to define the scope of the On-Access policy more precisely. The filters can be added in any order. Possible values scan_ro_volume Enable scans for read-only volume, scan_execute_access Scan only files opened with execute-access (CIFS only). deprecated with REST, use |
|
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:
|
|
Specifies whether access to a file is allowed if there are no external virus-scanning servers available for virus scanning. If not specified, default value is False in ZAPI. Choices:
|
|
path to SSL client key file. |
|
Max file-size (in bytes) allowed for scanning. The default value of 2147483648 (2GB) is taken if not provided at the time of creating a policy. |
|
Scan only files opened with execute-access. If not specified, default value is False in creating policy. Choices:
|
|
The ontap api version to use |
|
Password for the specified user. |
|
File paths for which On-Access scanning must not be performed. |
|
The name of the policy |
|
Status for the created policy Choices:
|
|
Specifies whether files without any extension are considered for scanning or not. If not specified, default value is True in ZAPI. Choices:
|
|
Specifies whether or not read-only volume can be scanned. If not specified, default value is False in creating policy. Choices:
|
|
Whether a Vscan on Access policy 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: “auto” |
|
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:
|
|
the name of the data vserver to use. |
Examples
- name: Create Vscan On Access Policy
netapp.ontap.na_ontap_vscan_on_access_policy:
state: present
username: '{{ netapp_username }}'
password: '{{ netapp_password }}'
hostname: '{{ netapp_hostname }}'
vserver: carchi-vsim2
policy_name: carchi_policy
file_ext_to_exclude: ['exe', 'yml']
- name: Create Vscan On Access Policy with Policy Status enabled
netapp.ontap.na_ontap_vscan_on_access_policy:
state: present
username: '{{ netapp_username }}'
password: '{{ netapp_password }}'
hostname: '{{ netapp_hostname }}'
vserver: carchi-vsim2
policy_name: carchi_policy
file_ext_to_exclude: ['exe', 'yml']
policy_status: True
- name: modify Vscan on Access Policy
netapp.ontap.na_ontap_vscan_on_access_policy:
state: present
username: '{{ netapp_username }}'
password: '{{ netapp_password }}'
hostname: '{{ netapp_hostname }}'
vserver: carchi-vsim2
policy_name: carchi_policy
file_ext_to_exclude: ['exe', 'yml', 'py']
- name: Delete On Access Policy
netapp.ontap.na_ontap_vscan_on_access_policy:
state: absent
username: '{{ netapp_username }}'
password: '{{ netapp_password }}'
hostname: '{{ netapp_hostname }}'
vserver: carchi-vsim2
policy_name: carchi_policy
Authors
NetApp Ansible Team (@carchi8py)