netapp.ontap.na_ontap_vscan_on_demand_task 模块 – NetApp ONTAP Vscan 按需任务配置。

注意

此模块是 netapp.ontap 集合（版本 22.13.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install netapp.ontap。您需要进一步的要求才能使用此模块，请参阅要求以了解详细信息。

要在 Playbook 中使用它，请指定：netapp.ontap.na_ontap_vscan_on_demand_task。

netapp.ontap 2.8.0 中的新功能

概要 

配置 Vscan 的按需任务

要求 

执行此模块的主机上需要以下要求。

Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。
Python3 - 建议使用 3.9 或更高版本。
当使用 ZAPI 时，强烈建议使用 netapp-lib 2018.11.13 或更高版本（使用 ‘pip install netapp-lib’ 安装），强烈建议使用 netapp-lib 2020.3.12，因为它为连接问题提供了更好的错误报告。
一个物理或虚拟集群 Data ONTAP 系统，该模块支持 Data ONTAP 9.1 及更高版本，REST 支持需要 ONTAP 9.6 或更高版本。

参数 

参数	注释
cert_filepath 字符串在 netapp.ontap 20.6.0 中添加	SSL 客户端证书文件（.pem）的路径。不支持 python 2.6。
cross_junction 布尔值	指定是否允许按需任务跨卷连接 REST 不支持此选项。此选项对于 ZAPI 默认为 False。选择 `false` `true`
directory_recursion 布尔值	指定是否允许按需任务递归扫描子目录。 REST 不支持此选项。此选项对于 ZAPI 默认为 False。选择 `false` `true`
feature_flags 字典在 netapp.ontap 20.5.0 中添加	启用或禁用新功能。这可以用来启用实验性功能或禁用破坏向后兼容性的新功能。支持的键和值如有更改，恕不另行通知。未知的键将被忽略。
file_ext_to_exclude 列表 / 元素=字符串	不应执行扫描的文件扩展名。扩展名与包含和排除列表都匹配的文件不考虑扫描。
file_ext_to_include 列表 / 元素=字符串	考虑扫描的文件扩展名。默认值为“*”，这意味着除了从扫描中排除的文件外，所有文件都考虑扫描。扩展名与包含和排除列表都匹配的文件不考虑扫描。
force_ontap_version 字符串在 netapp.ontap 21.23.0 中添加	使用 REST 时覆盖集群 ONTAP 版本。如果版本与目标集群不匹配，则行为未定义。当由于权限问题无法读取集群版本时，这可以作为一种解决方法。请参阅 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues。这应该是 9.10 或 9.10.1 的形式，每个元素都是整数。当 `use_rest` 设置为 auto 时，这可能会根据版本和平台功能强制切换到基于 ZAPI。使用 ZAPI 时忽略。
hostname 字符串 / 必需	ONTAP 实例的主机名或 IP 地址。
http_port 整数	使用此端口覆盖默认端口（80 或 443）
https 布尔值	启用和禁用 https。使用 REST 时忽略，因为仅支持 https。使用 SSL 证书身份验证时忽略，因为它需要 SSL。选择 `false` ← (默认) `true`
key_filepath 字符串在 netapp.ontap 20.6.0 中添加	SSL 客户端密钥文件的路径。
max_file_size 整数	允许扫描的最大文件大小（以字节为单位）。如果在创建任务时未提供，则采用默认值 10737418240 (10GB)。
ontapi 整数	要使用的 ontap api 版本
password 别名: pass 字符串	指定用户的密码。
paths_to_exclude 列表 / 元素=字符串	不应执行扫描的文件路径。
report_directory 字符串	从 vserver 根目录创建任务报告的路径。该路径必须是一个目录，并以 unix 格式从 Vserver 的根目录提供。示例 /vol1/on-demand-reports。
report_log_level 字符串	按需报告的日志级别。 REST 不支持此选项。对于 ZAPI，此选项默认为 ‘error’。选择 `“verbose”` `“info”` `“error”`
request_timeout 字符串	请求服务的总超时时间（秒）。如果病毒扫描器在指定时间内未响应，扫描将超时。 REST 不支持此选项。
scan_files_with_no_ext 布尔值	指定是否考虑扫描没有任何扩展名的文件。选择 `false` `true` ←（默认）
scan_paths 列表 / 元素=字符串	需要扫描的路径列表。路径必须以 unix 格式提供，并从 Vserver 的根目录开始。示例：/vol1/large_files。
scan_priority 字符串	此任务生成的按需扫描请求的优先级。 REST 不支持此选项。对于 ZAPI，此选项默认为 ‘low’。选择 `“low”` `“normal”`
schedule 字符串	任务的计划。任务将按照计划运行。要立即运行任务，必须在创建任务后使用 vscan-on-demand-task-run API。
state 字符串	是否配置按需 Vscan 任务选择 `"present"` ←（默认） `“absent”`
task_name 字符串 / 必需	任务的名称。
use_rest 字符串	是否使用 REST 或 ZAPI。 always – 如果模块支持 REST，则始终使用 REST API。如果模块不支持 REST，则会发出警告。如果 REST 中不支持某个模块选项，则会发出错误。 never – 如果模块支持 ZAPI，则始终使用 ZAPI。如果 ZAPI 中不支持某个 REST 选项，则可能会发出错误。 auto – 如果模块支持 REST 且支持模块选项，则会尝试使用 REST API。否则，会恢复为 ZAPI。默认值： `"auto"`
username 别名：user 字符串	这可以是集群范围或 SVM 范围的帐户，具体取决于需要集群级还是 SVM 级 API。有关更多信息，请阅读文档：https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。支持两种身份验证方法基本身份验证，使用用户名和密码； SSL 证书身份验证，使用 SSL 客户端证书文件，以及可选的私钥文件。要使用证书，必须已在 ONTAP 集群中安装证书，并且必须已启用证书身份验证。
validate_certs 布尔值	如果设置为 `no`，则不会验证 SSL 证书。仅当在个人控制的站点上使用自签名证书时，才应将其设置为 `False`。选择 `false` `true` ←（默认）
vserver 字符串 / 必需	要使用的数据 vserver 的名称。

说明 

注意

以 na_ontap 为前缀的模块旨在支持 ONTAP 存储平台。
默认情况下启用并建议使用 https。要在集群上启用 http，必须运行以下命令：‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

示例 

- name: Create Vscan On Demand Task
  netapp.ontap.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
  netapp.ontap.na_ontap_vscan_on_demand_task:
    state: absent
    username: '{{ netapp_username }}'
    password: '{{ netapp_password }}'
    hostname: '{{ netapp_hostname }}'
    vserver: carchi-vsim2
    task_name: carchiOnDemand

作者

NetApp Ansible 团队 (@carchi8py)