netapp.ontap.na_ontap_vserver_audit 模块 – NetApp Ontap - 创建、删除或修改 vserver 审计配置。

注意

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

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

要安装它，请使用：ansible-galaxy collection install netapp.ontap。您需要其他要求才能使用此模块，有关详细信息，请参阅需求。

要在剧本中使用它，请指定：netapp.ontap.na_ontap_vserver_audit。

netapp.ontap 22.3.0 中的新增功能

概要 

创建、删除或修改 vserver 审计配置。

需求 

以下需求是在执行此模块的主机上所需的。

Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。
Python 3 - 建议使用 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。
enabled 布尔值	指定是否在 SVM 上启用审计。选项 `false` `true`
events 字典	指定在 SVM 上启用审计的事件。
authorization_policy 布尔值	授权策略更改事件。选项 `false` `true`
cap_staging 布尔值	中央访问策略暂存事件。选项 `false` `true`
cifs_logon_logoff 布尔值	CIFS 登录和注销事件。选项 `false` `true`
file_operations 布尔值	文件操作事件。选项 `false` `true`
file_share 布尔值	文件共享类别事件。选项 `false` `true`
security_group 布尔值	本地安全组管理事件。选项 `false` `true`
user_account 布尔值	本地用户帐户管理事件。选项 `false` `true`
feature_flags 字典 netapp.ontap 20.5.0 中新增	启用或禁用新功能。这可以用来启用实验性功能或禁用破坏向后兼容性的新功能。支持的键和值可能会在未经通知的情况下更改。未知键将被忽略。
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 的形式，其中每个元素都是整数。
guarantee 布尔值	指示是否存在审计的严格保证。此选项需要 ONTAP 9.10.1 或更高版本。选项 `false` `true`
hostname 字符串 / 必需	ONTAP 实例的主机名或 IP 地址。
http_port 整数	使用此端口覆盖默认端口（80 或 443）
https 布尔值	启用和禁用 https。使用 REST 时被忽略，因为只支持 https。使用 SSL 证书身份验证时被忽略，因为它需要 SSL。选项 `false` ← (默认) `true`
key_filepath 字符串 netapp.ontap 20.6.0 中新增	SSL 客户端密钥文件的路径。
log 字典	指定在 SVM 上启用审计的事件。
格式字符串	此选项描述了合并过程生成的日志的格式。可能的值包括： xml - Data ONTAP 特定的 XML 日志格式 evtx - Microsoft Windows EVTX 日志格式选项 `"xml"` `"evtx"`
retention 字典	此选项描述了保留审计日志文件的计数和时间。
count 整数	确定在旋转掉最旧的日志文件之前要保留多少个审计日志文件。这与 duration 互斥。
duration 字符串	指定 ISO-8601 格式的日期和时间来保留审计日志文件。一旦审计日志文件达到指定的日期/时间，它们就会被删除。这与 count 互斥。
rotation 字典	当审计事件日志文件达到配置的阈值日志大小或处于配置的计划时，它们将被旋转。当事件日志文件被旋转时，计划的合并任务首先将活动转换文件重命名为带时间戳的存档文件，然后创建一个新的活动转换事件日志文件。
schedule 字典 netapp.ontap 22.11.0 中新增	通过使用任何组合的时间型旋转参数，根据时间表旋转审计日志。旋转时间表是通过使用所有与时间相关的数值计算的。
days 列表 / 元素=整数	指定每月旋转审计日志的日期。指定 -1 以每月所有日期旋转审计日志。
hours 列表 / 元素=整数	指定每小时旋转审计日志的时间表。指定 -1 以每小时旋转审计日志。
minutes 列表 / 元素=整数	指定旋转审计日志的分钟时间表。
months 列表 / 元素=整数	指定每月旋转审计日志的时间表。指定 -1 以每月旋转审计日志。
weekdays 列表 / 元素=整数	指定每周旋转审计日志的时间表。指定 -1 以每天旋转审计日志。
size 整数	基于日志大小（以字节为单位）旋转日志。默认值为 104857600。
log_path 字符串	存储合并审计日志的审计日志目标路径。
password 别名：pass 字符串	指定用户的密码。
state 字符串	指定的 vserver 审计配置是否存在。选项 `"present"` ← (默认) `"absent"`
use_rest 字符串	此模块仅支持 REST。 always – 将始终使用 REST API。如果模块不支持 REST，则会发出警告。默认值： `"always"`
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 的名称。

注释 

注意

此模块仅支持 REST。
至少应启用一个事件。
在为修改指定 enabled 时，不能指定其他字段。
以 na_ontap 为前缀的模块构建用于支持 ONTAP 存储平台。
默认情况下启用 https，并建议使用 https。要在集群上启用 http，必须运行以下命令：'set -privilege advanced;' 'system services web modify -http-enabled true;'

示例 

- name: Create vserver audit configuration
  netapp.ontap.na_ontap_vserver_audit:
    state: present
    vserver: ansible
    enabled: True
    events:
      authorization_policy: False
      cap_staging: False
      cifs_logon_logoff: True
      file_operations: True
      file_share: False
      security_group: False
      user_account: False
    log_path: "/"
    log:
      format: xml
      retention:
        count: 4
      rotation:
        size: "1048576"
    guarantee: False
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify vserver audit configuration
  netapp.ontap.na_ontap_vserver_audit:
    state: present
    vserver: ansible
    enabled: True
    events:
      authorization_policy: True
      cap_staging: True
      cifs_logon_logoff: True
      file_operations: True
      file_share: True
      security_group: True
      user_account: True
    log_path: "/tmp"
    log:
      format: evtx
      retention:
        count: 5
      rotation:
        size: "104857600"
    guarantee: True
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete vserver audit configuration
  netapp.ontap.na_ontap_vserver_audit:
    state: absent
    vserver: ansible
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

# The audit logs are rotated in January and March on Monday, Wednesday, and Friday,
# at 6:15, 6:30, 6:45, 12:15, 12:30, 12:45, 18:15, 18:30, and 18:45
# The last 6 audit logs are retained
- name: Create vserver audit configuration
  netapp.ontap.na_ontap_vserver_audit:
    state: present
    vserver: ansible
    enabled: True
    events:
      authorization_policy: False
      cap_staging: False
      cifs_logon_logoff: True
      file_operations: True
      file_share: False
      security_group: False
      user_account: False
    log_path: "/"
    log:
      format: xml
      retention:
        count: 6
      rotation:
        schedule:
          hours: [6,12,18]
          minutes: [15,30,45]
          months: [1,3]
          weekdays: [1,3,5]
    guarantee: False
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

# The audit logs are rotated monthly, all days of the week, at 12:30
- name: Modify vserver audit configuration
  netapp.ontap.na_ontap_vserver_audit:
    state: present
    vserver: ansible
    enabled: True
    events:
      authorization_policy: False
      cap_staging: False
      cifs_logon_logoff: True
      file_operations: True
      file_share: False
      security_group: False
      user_account: False
    log_path: "/"
    log:
      format: xml
      rotation:
        schedule:
          hours: [12]
          minutes: [30]
          months: [-1]
          weekdays: [-1]
    guarantee: False
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

作者

NetApp Ansible 团队 (@carchi8py)