community.vmware.vmware_guest_storage_policy 模块 – 设置虚拟机主目录和磁盘存储策略配置文件。

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.vmware

要在 playbook 中使用它,请指定:community.vmware.vmware_guest_storage_policy

概要

  • 此模块可用于强制虚拟机上每个磁盘和/或虚拟机主目录的存储策略配置文件。

参数

参数

注释

disk

列表 / 元素=字典

要强制执行存储配置文件策略的磁盘列表。

至少需要 diskvm_home 中的一个。

controller_number

整数

SCSI 控制器编号。

有效值范围为 0 到 3。

默认值: 0

policy

字符串 / 必需

要为磁盘强制执行的存储配置文件策略的名称。

unit_number

整数 / 必需

磁盘单元编号。

有效值范围为 0 到 15。

folder

字符串

目标文件夹,用于查找现有虚拟机的绝对或相对路径。

如果找到多个同名虚拟机,则此为必需参数。

该文件夹应包含数据中心。ESX 的数据中心是 ha-datacenter。

示例

folder: /ha-datacenter/vm

folder: ha-datacenter/vm

folder: /datacenter1/vm

folder: datacenter1/vm

folder: /datacenter1/vm/folder1

folder: datacenter1/vm/folder1

folder: /folder1/datacenter1/vm

folder: folder1/datacenter1/vm

folder: /folder1/datacenter1/vm/folder2

hostname

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

如果未在任务中指定该值,则将改用环境变量 VMWARE_HOST 的值。

moid

字符串

要管理的实例的托管对象 ID(如果已知),这是仅在单个 vCenter 实例中唯一的标识符。

需要 nameuuidmoid 中的一个来定义虚拟机。

name

字符串

虚拟机的名称。

需要 nameuuidmoid 中的一个来定义虚拟机。

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 的值。

username

别名:admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

如果未在任务中指定该值,则将改用环境变量 VMWARE_USER 的值。

uuid

字符串

虚拟机的 UUID。

需要 nameuuidmoid 中的一个来定义虚拟机。

validate_certs

布尔值

允许在 SSL 证书无效时进行连接。当证书不受信任时,设置为 false

如果任务中未指定该值,则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

vm_home

字符串

要在 VM Home 上设置的存储策略。

必须至少提供 diskvm_home 其中一个参数。

注意

注意

  • 所有模块都需要 API 写入权限,因此不支持免费的 ESXi 许可证。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Enforce storepol1 policy for disk 0 and 1 on SCSI controller 0 using UUID
  community.vmware.vmware_guest_storage_policy:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    uuid: cefd316c-fc19-45f3-a539-2cd03427a78d
    disk:
      - unit_number: 0
        controller_number: 0
        policy: storepol1
      - unit_number: 1
        controller_number: 0
        policy: storepol1
  delegate_to: localhost
  register: policy_status

- name: Enforce storepol1 policy for VM Home using name
  community.vmware.vmware_guest_storage_policy:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    name: hostname1
    vm_home: storepol1
  delegate_to: localhost

返回值

通用返回值在此处记录 此处,以下是此模块独有的字段

描述

changed_policies

字典

包含磁盘(字典列表)和 vm_home 的已更改策略的字典。

返回: 总是

示例: {"disk": [{"policy": "storepol1", "unit_number": 0}], "vm_home": "storepol1"}

msg

字符串

有关作业结果的信息性消息。

返回: 总是

示例: "策略已成功设置。"

作者

  • Tyler Gates (@tgates81)