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_vscan_on_demand_task.
New in version 2.8.0: of netapp.ontap
The below requirements are needed on the host that executes this module.
| 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. | |
| cross_junction boolean |
| Specifies whether the On-Demand task is allowed to cross volume junctions |
| directory_recursion boolean |
| Specifies whether the On-Demand task is allowed to recursively scan through sub-directories. |
| 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_ext_to_exclude list / elements=string | File-Extensions for which scanning must not be performed. File whose extension matches with both inclusion and exclusion list is not considered for scanning. | |
| file_ext_to_include list / elements=string | File extensions for which scanning is considered. The default value is '*', which means that all files are considered for scanning except those which are excluded from scanning. File whose extension matches with both inclusion and exclusion list is not considered for scanning. | |
| 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. |
| key_filepath string added in 20.6.0 of netapp.ontap | path to SSL client key file. | |
| max_file_size string | Max file-size (in bytes) allowed for scanning. The default value of 10737418240 (10GB) is taken if not provided at the time of creating a task. | |
| ontapi integer | The ontap api version to use | |
| password string | Password for the specified user. aliases: pass | |
| paths_to_exclude list / elements=string | File-paths for which scanning must not be performed. | |
| report_directory string | Path from the vserver root where task report is created. The path must be a directory and provided in unix-format from the root of the Vserver. Example /vol1/on-demand-reports. | |
| report_log_level string |
| Log level for the On-Demand report. |
| request_timeout string | Total request-service time-limit in seconds. If the virus-scanner does not respond within the provided time, scan will be timedout. | |
| scan_files_with_no_ext boolean |
| Specifies whether files without any extension are considered for scanning or not. |
| scan_paths list / elements=string | List of paths that need to be scanned. The path must be provided in unix-format and from the root of the Vserver. Example /vol1/large_files. | |
| scan_priority string |
| Priority of the On-Demand scan requests generated by this task. |
| schedule string | Schedule of the task. The task will be run as per the schedule. For running the task immediately, vscan-on-demand-task-run api must be used after creating a task. | |
| state string |
| Whether a Vscan on demand task is present or not |
| task_name string / required | Name of the task. | |
| 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 |
| 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 data vserver to use. |
Note
- name: Create Vscan On Demand Task
na_ontap_vscan_on_demand_task:
state: present
username: '{{ netapp_username }}'
password: '{{ netapp_password }}'
hostname: '{{ netapp_hostname }}'
vserver: carchi-vsim2
task_name: carchiOnDemand
scan_paths: /
report_directory: /
file_ext_to_exclude: ['py', 'yml']
max_file_size: 10737418241
paths_to_exclude: ['/tmp', '/var']
report_log_level: info
request_timeout: 60
- name: Delete Vscan On Demand Task
na_ontap_vscan_on_demand_task:
state: absent
username: '{{ netapp_username }}'
password: '{{ netapp_password }}'
hostname: '{{ netapp_hostname }}'
vserver: carchi-vsim2
task_name: carchiOnDemand
© 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_vscan_on_demand_task_module.html