netapp.ontap.na_ontap_volume_efficiency 模块 – NetApp ONTAP 启用、禁用或修改卷效率

注意

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

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

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

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

netapp.ontap 21.2.0 中的新增功能

概要

• 启用、修改或禁用卷效率。

• 必须提供 path 或 volume_name 中的一个。

• 只有管理员用户才能修改卷效率。

要求

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

• 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。
enable_compression 布尔值	指定是否启用压缩。 选项 false true
enable_cross_volume_background_dedupe 布尔值	指定是否启用跨卷后台重复数据删除，只有在启用内联重复数据删除时才能启用此功能。 选项 false true
enable_cross_volume_inline_dedupe 布尔值	指定是否启用内联跨卷重复数据删除，只有在启用内联重复数据删除时才能启用此功能。 选项 false true
enable_data_compaction 布尔值	指定是否启用压缩。 选项 false true
enable_inline_compression 布尔值	指定是否启用内联压缩。 选项 false true
enable_inline_dedupe 布尔值	指定是否启用内联重复数据删除，仅在 AFF 系统或混合聚合上支持。 选项 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 的形式，每个元素都是整数。 当 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 客户端密钥文件的路径。
ontapi 整数	要使用的 ontap api 版本
password 别名: pass 字符串	指定用户的密码。
path 字符串	指定卷的路径。 必须提供 path 或 volume_name 中的一个。 需要 ONTAP 9.9.1 或更高版本，并且使用 REST。
policy 字符串	指定要使用的存储效率策略。 默认情况下，可以使用以下名称 'auto'、'default'、'inline-only'、'-'。 需要 ONTAP 9.7 或更高版本，并且使用 REST。
schedule 字符串	指定存储效率计划。 仅支持 ZAPI。
start_ve_build_metadata 布尔值 在 netapp.ontap 21.4.0 中添加	指定扫描程序扫描整个卷并生成指纹数据库，而不尝试共享。 仅支持 ZAPI。 选项 false true
start_ve_delete_checkpoint 布尔值 在 netapp.ontap 21.4.0 中添加	指定扫描程序删除现有检查点并从头开始操作。 仅支持 ZAPI。 选项 false true
start_ve_qos_policy 字符串 在 netapp.ontap 21.4.0 中添加	指定操作的 QoS 策略。 ZAPI 中的默认值为尽力而为。 仅支持 ZAPI。 选项 "background" "best-effort"
start_ve_queue_operation 布尔值 在 netapp.ontap 21.4.0 中添加	指定如果卷上已在运行并且处于指纹验证阶段的操作，则要排队的操作。 仅支持 ZAPI。 选项 false true
start_ve_scan_all 布尔值 在 netapp.ontap 21.4.0 中添加	指定扫描程序扫描整个卷而不应用共享块优化。 仅支持 ZAPI。 选项 false true
start_ve_scan_old_data 布尔值 在 netapp.ontap 21.4.0 中添加	指定扫描文件系统以处理所有现有数据的操作。 需要 ONTAP 9.11.1 或更高版本，并且使用 REST。 选项 false true
state 字符串	是否应启用指定的卷效率。 选项 "present" ← (默认) "absent"
stop_ve_all_operations 布尔值 在 netapp.ontap 21.4.0 中添加	指定停止所有正在运行和排队的操作。 仅支持 ZAPI。 选项 false true
storage_efficiency_mode 字符串 在 netapp.ontap 21.14.0 中添加	卷使用的存储效率模式。此参数仅在 AFF 平台上受支持。 需要 ONTAP 9.10.1 或更高版本。 选项 "default" "efficient"
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 ← (默认)
volume_efficiency (卷效率) 字符串 在 netapp.ontap 21.4.0 中添加	在给定卷路径上启动或停止卷效率操作。 需要 ONTAP 9.11.1 或更高版本，并且使用 REST。 选项 "start" (启动) "stop" (停止)
volume_name (卷名称) 字符串 在 netapp.ontap 22.3.0 中添加	指定卷名称。
vserver (V服务器) 字符串 / 必需	指定卷的V服务器。

说明

注意

• 支持ZAPI和REST。REST需要ONTAP 9.6或更高版本。

• 支持检查模式。

• 以na_ontap为前缀的模块旨在支持ONTAP存储平台。

• 默认情况下启用并建议使用https。要在集群上启用http，必须运行以下命令：‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

示例

- name: Enable Volume efficiency
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    https: true
    validate_certs: false

- name: Disable Volume efficiency test
  netapp.ontap.na_ontap_volume_efficiency:
    state: absent
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    https: true
    validate_certs: false

- name: Modify storage efficiency schedule with ZAPI.
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    schedule: "mon-sun@0,1,23"
    enable_compression: true
    enable_inline_compression: true
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    https: true
    validate_certs: false

- name: Start volume efficiency
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    volume_efficiency: "start"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    https: true
    validate_certs: false

- name: Stop volume efficiency
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    volume_efficiency: "stop"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    https: true
    validate_certs: false

- name: modify volume efficiency with volume name in REST.
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    volume_name: "test_sis"
    volume_efficiency: "stop"
    enable_compression: True
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    https: true
    validate_certs: false

作者

• NetApp Ansible 团队 (@carchi8py)

集合链接

• 问题跟踪器
• 主页
• 仓库 (源代码)