community.vmware.vmware_vmotion 模块 – 使用 vMotion 移动虚拟机,以及/或者使用 Storage vMotion 移动其 vmdk。

注意

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

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

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

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

概要

  • 使用 VMware vCenter,使用 vMotion 将虚拟机移动到不同的主机,以及/或者使用 Storage vMotion 将其 vmdk 移动到另一个数据存储。

参数

参数

注释

destination_cluster

字符串

虚拟机应在其上运行的目标集群的名称。

仅当为此集群启用了 DRS 时才有效。

destination_datacenter

字符串

数据存储所在的目的地数据中心的名称。

可选,仅当数据存储跨数据中心共享时才需要。

destination_datastore

别名:datastore

字符串

虚拟机的 vmdk 应在其上移动的目标数据存储的名称。

destination_datastore_cluster

字符串

虚拟机的 vmdk 应在其上移动的目标数据存储集群(存储池)的名称。

仅当为虚拟机正在运行/应运行的集群启用了 DRS 时才有效。

destination_host

别名:destination

字符串

虚拟机应在其上运行的目标主机的名称。

2.6 版及更高版本,此参数不是必需参数,与以前的版本不同。

destination_resourcepool

别名:resource_pool

字符串

虚拟机应在其上运行的目标资源池的名称。

如果在属于不同集群或数据中心的主机之间执行 vmotion,则需要资源池。

如果未传递,则将从 host_obj 父级检索 resource_pool 对象。

hostname

字符串

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

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

moid

字符串

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

如果未提供 vm_namevm_uuid,则需要此参数。

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

timeout

整数

在 community.vmware 3.4.0 中添加

以秒为单位的超时时间。达到超时时间时,模块将失败。

默认值: 3600

use_instance_uuid

布尔值

是否使用 VMware 实例 UUID 而不是 BIOS UUID。

选项

  • false ← (默认)

  • true

username

别名:admin, user

字符串

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

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

vm_name

别名:vm

字符串

要执行 vMotion 的虚拟机的名称。

如果未设置vm_uuid,则此参数为必填参数。

vm_uuid

别名:uuid

字符串

要对其执行 vMotion 操作的虚拟机的 UUID。

如果未设置vm_namemoid,则此参数为必填参数。

备注

注意

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

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

示例

- name: Perform vMotion of virtual machine
  community.vmware.vmware_vmotion:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_name: 'vm_name_as_per_vcenter'
    destination_host: 'destination_host_as_per_vcenter'
  delegate_to: localhost

- name: Perform vMotion of virtual machine
  community.vmware.vmware_vmotion:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    moid: vm-42
    destination_host: 'destination_host_as_per_vcenter'
  delegate_to: localhost

- name: Perform vMotion of virtual machine to resource_pool
  community.vmware.vmware_vmotion:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    moid: vm-42
    destination_host: 'destination_host_as_per_vcenter'
    destination_resourcepool: 'destination_resourcepool_as_per_vcenter'
  delegate_to: localhost

- name: Perform storage vMotion of virtual machine
  community.vmware.vmware_vmotion:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_name: 'vm_name_as_per_vcenter'
    destination_datastore: 'destination_datastore_as_per_vcenter'
  delegate_to: localhost

- name: Perform storage vMotion and host vMotion of virtual machine
  community.vmware.vmware_vmotion:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_name: 'vm_name_as_per_vcenter'
    destination_host: 'destination_host_as_per_vcenter'
    destination_datastore: 'destination_datastore_as_per_vcenter'
  delegate_to: localhost

- name: Perform storage vMotion to a Storage Cluster and vMotion to a Cluster of virtual machine
  community.vmware.vmware_vmotion:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    vm_name: 'vm_name_as_per_vcenter'
    destination_cluster: 'destination_cluster_as_per_vcenter'
    destination_datastore_cluster: 'destination_datastore_cluster_as_per_vcenter'
  delegate_to: localhost

返回值

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

描述

datastore

字符串

列出虚拟机所在的 datastore。

仅当请求存储 vMotion(Datastore 或 Datastore 集群)时才返回。

返回:changed 或 success

示例: "datastore1"

running_host

字符串

列出虚拟机注册到的主机。

仅当请求 vMotion(集群或主机)时才返回。

返回:changed 或 success

示例: "host1.example.com"

作者

  • Bede Carroll (@bedecarroll)

  • Olivier Boukili (@oboukili)