community.vmware.vmware_guest_register_operation 模块 – VM 库存注册操作

注意

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

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

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

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

概要

• 此模块可以将 VM 注册或注销到库存。

参数

参数	注释
集群 字符串	指定要注册 VM 的集群名称。
数据中心 字符串	注册/注销操作的目标数据中心。 默认值： "ha-datacenter"
ESXi 主机名 字符串	虚拟机将在其上运行的 ESXi 主机名。
文件夹 字符串	目标文件夹的描述和绝对路径。 文件夹应包含数据中心。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
主机名 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定此值，则将改用环境变量 VMWARE_HOST 的值。
名称 字符串 / 必需	指定要在库存中注册的 VM 名称。
密码 别名：pass、pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定此值，则将改用环境变量 VMWARE_PASSWORD 的值。
路径 字符串	指定 vmx 文件的路径。 示例 [datastore1] vm/vm.vmx [datastore1] vm/vm.vmtx
端口 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果任务中未指定此值，则将改用环境变量 VMWARE_PORT 的值。 默认值： 443
代理主机 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP。 如果任务中未指定此值，则将改用环境变量 VMWARE_PROXY_HOST 的值。
代理端口 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定此值，则将改用环境变量 VMWARE_PROXY_PORT 的值。
资源池 字符串	指定要注册 VM 的资源池名称。 资源池应为所选主机父级的子级。
状态 字符串	指定虚拟机应处于的状态。 如果设置为 present，则将 VM 注册到库存。 如果设置为 absent，则将 VM 从库存中注销。 选项 "present" ← (默认) "absent"
模板 布尔值	是否将 VM 注册为模板。 选项 false ← (默认) true
用户名 别名：admin、user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定此值，则将改用环境变量 VMWARE_USER 的值。
UUID 字符串	如果已知，则为要管理的虚拟机的 UUID，这是 VMware 的唯一标识符。 如果虚拟机不存在，则忽略此参数。
validate_certs 布尔值	允许在SSL证书无效时连接。当证书不受信任时，将其设置为false。 如果任务中未指定此值，则将使用环境变量VMWARE_VALIDATE_CERTS的值。 选项 false true ← (默认)

备注

注意

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

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

示例

- name: Register VM to inventory
  community.vmware.vmware_guest_register_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/vm"
    esxi_hostname: "{{ esxi_hostname }}"
    name: "{{ vm_name }}"
    template: false
    path: "[datastore1] vm/vm.vmx"
    state: present

- name: Register VM in resource pool
  community.vmware.vmware_guest_register_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/vm"
    resource_pool: "{{ resource_pool }}"
    name: "{{ vm_name }}"
    template: false
    path: "[datastore1] vm/vm.vmx"
    state: present

- name: Register VM in Cluster
  community.vmware.vmware_guest_register_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/vm"
    cluster: "{{ cluster_name }}"
    name: "{{ vm_name }}"
    template: false
    path: "[datastore1] vm/vm.vmx"
    state: present

- name: UnRegister VM from inventory
  community.vmware.vmware_guest_register_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/vm"
    name: "{{ vm_name }}"
    state: absent

作者

• sky-joker (@sky-joker)

资源链接

• 问题追踪器
• 主页
• 代码仓库