vmware.vmware_rest.vcenter_vm_storage_policy 模块 – 更新虚拟机及其关联虚拟硬盘的存储策略配置。

注意

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

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

要安装它,请使用:ansible-galaxy collection install vmware.vmware_rest。您需要其他要求才能使用此模块,请参阅 需求 以了解详情。

要在 playbook 中使用它,请指定:vmware.vmware_rest.vcenter_vm_storage_policy

vmware.vmware_rest 0.1.0 中的新增功能

概要

  • 更新虚拟机及其关联虚拟硬盘的存储策略配置。

需求

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

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

disks

字典

重新配置虚拟机磁盘时要使用的存储策略或策略。

如果未设置,则保留当前存储策略。

当客户端将此结构的值作为参数传递时,字段映射中的键必须是 vmware.vmware_rest.vcenter_vm_hardware_disk 返回的资源 ID。

session_timeout

浮点数

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

整个操作(包括连接建立、请求发送和响应)的最大秒数。

默认值为 300 秒。

state

字符串

选项

  • "present" ← (默认)

vcenter_hostname

字符串 / 必需

vSphere vCenter 的主机名或 IP 地址

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

vcenter_password

字符串 / 必需

vSphere vCenter 密码

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

vcenter_rest_log_file

字符串

您可以使用此可选参数来设置日志文件的位置。

此文件将用于记录 HTTP REST 交互。

该文件将存储在运行模块的主机上。

如果任务中未指定该值,则将使用

环境变量 VMWARE_REST_LOG_FILE 的值。

vcenter_username

字符串 / 必需

vSphere vCenter 用户名

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

vcenter_validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

vm

字符串 / 必需

虚拟机标识符。

该参数必须是 vmware.vmware_rest.vcenter_vm_info 返回的资源 ID。此参数是必需的。

vm_home

字典 / 必需

重新配置虚拟机主目录时要使用的存储策略。

如果未设置,则保留当前存储策略。此参数是必需的。

有效属性为

  • type (str): 此选项定义如何指定要与虚拟机主目录关联的策略的选择。([‘present’])

此键与 [‘present’] 一起使用时是必需的。

  • 接受的值

  • USE_DEFAULT_POLICY

  • USE_SPECIFIED_POLICY

  • policy (str): 存储策略标识。

此字段是可选的,仅当 *type* 的值为 USE_SPECIFIED_POLICY 时才相关。

当客户端将此结构的值作为参数传递时,该字段必须是 vmware.vmware_rest.vcenter_storage_policies_info 返回的资源 ID。([‘present’])

备注

注意

  • 在 vSphere 7.0.3 上测试

示例

- name: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
    - test_vm1

- name: Collect information about a specific VM
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ search_result.value[0].vm }}'
  register: test_vm1_info

- name: Prepare the disk policy dict
  ansible.builtin.set_fact:
    vm_disk_policy: "{{ {} | combine({ my_new_disk.id: {'policy': my_storage_policy.policy, 'type': 'USE_SPECIFIED_POLICY'} }) }}"

- name: Adjust VM storage policy
  vmware.vmware_rest.vcenter_vm_storage_policy:
    vm: '{{ test_vm1_info.id }}'
    vm_home:
      type: USE_DEFAULT_POLICY
    disks: '{{ vm_disk_policy }}'
  register: _result

返回值

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

描述

id

字典

资源的 moid

返回:成功时

value

字典

调整虚拟机存储策略

返回:成功时

示例: {}

作者

  • Ansible 云团队 (@ansible-collections)