netapp.ontap.na_ontap_vscan_on_access_policy 模块 – 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_access_policy。

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。

feature_flags

字典

在 netapp.ontap 20.5.0 中添加

启用或禁用新功能。

这可以用于启用实验性功能或禁用破坏向后兼容性的新功能。

支持的键和值可能会更改，恕不另行通知。未知的键将被忽略。

file_ext_to_exclude

列表 / 元素=字符串

不应执行按需扫描的文件扩展名。

file_ext_to_include

列表 / 元素=字符串

考虑按需扫描的文件扩展名。默认值为“*”，表示所有文件都考虑进行扫描，除非

那些被排除在扫描之外的文件。

filters

列表 / 元素=字符串

可用于更精确地定义按需策略范围的过滤器列表。可以按任何顺序添加过滤器。可能的值

scan_ro_volume 启用对只读卷的扫描，

scan_execute_access 仅扫描以执行访问权限打开的文件（仅限 CIFS）。

已弃用 REST，请使用 scan_readonly_volumes 或 only_execute_access。

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

is_scan_mandatory

布尔值

指定如果没有可用于病毒扫描的外部病毒扫描服务器，是否允许访问文件。

如果未指定，则 ZAPI 中的默认值为 False。

选项

  • false

  • true

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端密钥文件的路径。

max_file_size

整数

允许扫描的最大文件大小（以字节为单位）。如果在创建策略时未提供，则采用默认值 2147483648 (2GB)。

only_execute_access

布尔值

在 netapp.ontap 21.20.0 中添加

仅扫描以执行访问权限打开的文件。

如果未指定，则在创建策略时默认值为 False。

选项

  • false

  • true

ontapi

整数

要使用的 ontap api 版本

password

别名：pass

字符串

指定用户的密码。

paths_to_exclude

列表 / 元素=字符串

不应执行按需扫描的文件路径。

policy_name

字符串 / 必需

策略的名称

policy_status

布尔值

在 netapp.ontap 20.8.0 中添加

创建的策略的状态

选项

  • false

  • true

scan_files_with_no_ext

布尔值

指定是否考虑扫描没有任何扩展名的文件。

如果未指定，则 ZAPI 中的默认值为 True。

选项

  • false

  • true

scan_readonly_volumes

布尔值

在 netapp.ontap 21.20.0 中添加

指定是否可以扫描只读卷。

如果未指定，则在创建策略时默认值为 False。

选项

  • false

  • true

state

字符串

Vscan 访问策略是否存在

选项

  • "present" ← (默认)

  • "absent"

use_rest

字符串

是否使用 REST 或 ZAPI。

always – 如果模块支持 REST，将始终使用 REST API。如果模块不支持 REST，则会发出警告。如果模块选项在 REST 中不受支持，则会发出错误。

never – 如果模块支持 ZAPI，将始终使用 ZAPI。如果 REST 选项在 ZAPI 中不受支持，则可能会发出错误。

auto – 如果模块支持 REST 且模块选项受支持，将尝试使用 REST API。否则，将回退到 ZAPI。

默认值： "auto"

username

别名: user

字符串

这可以是集群范围或 SVM 范围的帐户，具体取决于需要集群级别还是 SVM 级别的 API。

有关更多信息，请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。

支持两种身份验证方法：

  1. 基本身份验证，使用用户名和密码；

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

作者

  • NetApp Ansible 团队 (@carchi8py)