Try SpotterNetApp ONTAP Vscan on demand task configuration.
| "added in version" 2.8 of ansible.builtin"
Authors: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
preview | supported by certified
pipInstall with pip install ansible==2.9.26
Configure on demand task for Vscan
- 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
https:
default: false
description:
- Enable and disable https.
- Ignored when using REST as only https is supported.
- Ignored when using SSL certificate authentication as it requires SSL.
type: bool
state:
choices:
- present
- absent
default: present
description:
- Whether a Vscan on demand task is present or not
ontapi:
description:
- The ontap api version to use
type: int
vserver:
description:
- the name of the data vserver to use.
required: true
hostname:
description:
- The hostname or IP address of the ONTAP instance.
required: true
type: str
password:
aliases:
- pass
description:
- Password for the specified user.
type: str
schedule:
description:
- 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.
use_rest:
choices:
- Never
- Always
- Auto
default: Auto
description:
- 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
type: str
username:
aliases:
- user
description:
- 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 U(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.
type: str
http_port:
description:
- Override the default port (80 or 443) with this port
type: int
task_name:
description:
- Name of the task.
required: true
scan_paths:
description:
- 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.
type: list
key_filepath:
description:
- path to SSL client key file.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
cert_filepath:
description:
- path to SSL client cert file (.pem).
- not supported with python 2.6.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
feature_flags:
description:
- 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.
type: dict
version_added: 20.5.0
version_added_collection: netapp.ontap
max_file_size:
description:
- 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.
scan_priority:
choices:
- low
- normal
default: low
description:
- Priority of the On-Demand scan requests generated by this task.
cross_junction:
default: false
description:
- Specifies whether the On-Demand task is allowed to cross volume junctions
type: bool
validate_certs:
default: true
description:
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(False) used on personally controlled sites using self-signed
certificates.
type: bool
request_timeout:
description:
- Total request-service time-limit in seconds. If the virus-scanner does not respond
within the provided time, scan will be timed out.
paths_to_exclude:
description:
- File-paths for which scanning must not be performed.
type: list
report_directory:
description:
- 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:
choices:
- verbose
- info
- error
default: error
description:
- Log level for the On-Demand report.
directory_recursion:
default: false
description:
- Specifies whether the On-Demand task is allowed to recursively scan through sub-directories.
type: bool
file_ext_to_exclude:
description:
- File-Extensions for which scanning must not be performed.
- File whose extension matches with both inclusion and exclusion list is not considered
for scanning.
type: list
file_ext_to_include:
description:
- 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.
type: list
scan_files_with_no_ext:
default: true
description:
- Specifies whether files without any extension are considered for scanning or not.
type: bool