community.vmware.vmware_vm_storage_policy 模块 – 创建 vSphere 存储策略

注意

此模块是 community.vmware 集合（版本 5.2.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定：community.vmware.vmware_vm_storage_policy。

概要 

vSphere 存储策略定义了描述虚拟机存储需求和存储提供程序存储功能的元数据。
目前，仅支持基于标签的存储策略创建。

参数 

参数	注释
description 字符串	要创建或更新的存储策略的描述。当 `state=absent` 时，将忽略此参数。
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果未在任务中指定该值，则将使用环境变量 `VMWARE_HOST` 的值。
name 字符串 / 必填	要创建、更新或删除的存储策略的名称。
password 别名：pass, pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果未在任务中指定该值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果未在任务中指定该值，则将使用环境变量 `VMWARE_PORT` 的值。默认值： `443`
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP。如果未在任务中指定该值，则将使用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果未在任务中指定该值，则将使用环境变量 `VMWARE_PROXY_PORT` 的值。
state 字符串	存储策略的状态。如果设置为 `present`，则会创建存储策略。如果设置为 `absent`，则会删除存储策略。选项 `"absent"` `"present"` ← (默认)
tag_affinity 布尔值	如果设置为 `true`，则存储策略强制虚拟机需要存在用于数据存储放置的标签。如果设置为 `false`，则存储策略强制虚拟机需要不存在用于数据存储放置的标签。当 `state=absent` 时，将忽略此参数。选项 `false` `true` ← (默认)
tag_category 字符串	要分配给存储策略的预先存在的标签类别的名称。当 `state=absent` 时，将忽略此参数。当 `state=present` 时，此参数是必需的。
tag_name 字符串	要分配给存储策略的预先存在的标签的名称。当 `state=absent` 时，将忽略此参数。当 `state=present` 时，此参数是必需的。
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果未在任务中指定该值，则将使用环境变量 `VMWARE_USER` 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 `false`。如果未在任务中指定该值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

说明 

注意

所有模块都需要 API 写入权限，因此在免费的 ESXi 许可证上不受支持。
所有变量和 VMware 对象名称都区分大小写。

示例 

- name: Create or update a vSphere tag-based storage policy
  community.vmware.vmware_vm_storage_policy:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: "vSphere storage policy"
    description: "vSphere storage performance policy"
    tag_category: "performance_tier"
    tag_name: "gold"
    tag_affinity: true
    state: "present"
  delegate_to: localhost

- name: Remove a vSphere tag-based storage policy
  community.vmware.vmware_vm_storage_policy:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: "vSphere storage policy"
    state: "absent"
  delegate_to: localhost

返回值 

常见返回值记录在此处，以下是此模块特有的字段

键	描述
vmware_vm_storage_policy 字典	存储策略信息的字典返回：成功示例： `{"vmware_vm_storage_policy": {"description": "gold-tier 存储的存储策略", "id": "aa6d5a82-1c88-45da-85d3-3d74b91a5bad", "name": "gold"}}`

作者

Dustin Scott (@scottd018)