community.vmware.vmware_guest_move 模块 – 在 vCenter 中移动虚拟机

注意

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

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

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

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

概要

• 此模块可用于在文件夹之间移动虚拟机。

参数

参数	注释
datacenter 字符串 / 必需	移动操作的目标数据中心
dest_folder 字符串 / 必需	移动现有虚拟机的绝对路径 dest_folder 应包含数据中心。ESX 的数据中心是 ha-datacenter。 示例 dest_folder: /ha-datacenter/vm dest_folder: ha-datacenter/vm dest_folder: /datacenter1/vm dest_folder: datacenter1/vm dest_folder: /datacenter1/vm/folder1 dest_folder: datacenter1/vm/folder1 dest_folder: /folder1/datacenter1/vm dest_folder: folder1/datacenter1/vm dest_folder: /folder1/datacenter1/vm/folder2
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定此值，则将使用环境变量 VMWARE_HOST 的值。
moid 字符串	要管理的实例的托管对象 ID，如果已知，则此唯一标识符仅在一个 vCenter 实例内有效。 如果未提供 name 或 uuid，则需要此参数。
name 字符串	要移动的现有虚拟机的名称。 如果未提供 uuid 或 moid，则需要此参数。
name_match 字符串	如果多个虚拟机名称匹配，则使用找到的第一个或最后一个。 选项 "first" ← (默认) "last"
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 的值。
use_instance_uuid 布尔值	是否使用 VMware 实例 UUID 而不是 BIOS UUID。 选项 false ← (默认) true
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定值，则将使用环境变量VMWARE_USER的值。
uuid 字符串	已知情况下要管理的虚拟机的UUID，这是VMware的唯一标识符。 如果未提供name或moid，则需要此参数。
validate_certs 布尔值	允许在SSL证书无效时连接。当证书不受信任时，将其设置为false。 如果任务中未指定值，则将使用环境变量VMWARE_VALIDATE_CERTS的值。 选项 false true ← (默认)

注释

注意

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

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

示例

- name: Move Virtual Machine
  community.vmware.vmware_guest_move:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: datacenter
    name: testvm-1
    dest_folder: "/{{ datacenter }}/vm"
  delegate_to: localhost

- name: Move Virtual Machine using MoID
  community.vmware.vmware_guest_move:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: datacenter
    moid: vm-42
    dest_folder: "/{{ datacenter }}/vm"
  delegate_to: localhost

- name: Get VM UUID
  vmware_guest_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/{{ datacenter }}/vm"
    name: "{{ vm_name }}"
  delegate_to: localhost
  register: vm_facts

- name: Get UUID from previous task and pass it to this task
  community.vmware.vmware_guest_move:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    uuid: "{{ vm_facts.instance.hw_product_uuid }}"
    dest_folder: "/DataCenter/vm/path/to/new/folder/where/we/want"
  delegate_to: localhost
  register: facts

返回值

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

键

描述

instance 字典

关于虚拟机的元数据 返回：始终 示例： {"annotation": null, "current_snapshot": null, "customvalues": {}, "guest_consolidation_needed": false, "guest_question": null, "guest_tools_status": null, "guest_tools_version": "0", "hw_cores_per_socket": 1, "hw_datastores": ["LocalDS_0"], "hw_esxi_host": "DC0_H0", "hw_eth0": {"addresstype": "generated", "ipaddresses": null, "label": "ethernet-0", "macaddress": "00:0c:29:6b:34:2c", "macaddress_dash": "00-0c-29-6b-34-2c", "summary": "DVSwitch: 43cdd1db-1ef7-4016-9bbe-d96395616199"}, "hw_files": ["[LocalDS_0] DC0_H0_VM0/DC0_H0_VM0.vmx"], "hw_folder": "/F0/DC0/vm/F0", "hw_guest_full_name": null, "hw_guest_ha_state": null, "hw_guest_id": "otherGuest", "hw_interfaces": ["eth0"], "hw_is_template": false, "hw_memtotal_mb": 32, "hw_name": "DC0_H0_VM0", "hw_power_status": "poweredOn", "hw_processor_count": 1, "hw_product_uuid": "581c2808-64fb-45ee-871f-6a745525cb29", "instance_uuid": "8bcb0b6e-3a7d-4513-bf6a-051d15344352", "ipv4": null, "ipv6": null, "module_hw": true, "snapshots": []}

作者

• Jose Angel Munoz (@imjoseangel)

资源链接

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