community.vmware.vmware_tools 连接 – 通过 VMware Tools 在虚拟机内执行任务

注意

此连接插件是 community.vmware 集合（版本 5.2.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.vmware。您需要进一步的要求才能使用此连接插件，有关详细信息，请参阅 要求。

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

概要

  • 使用 VMware Tools 在 VMware 基础设施中运行的客户机操作系统中运行任务，或将文件放入/获取到客户机操作系统。

  • 对于 Windows 虚拟机，请将 ansible_shell_type 设置为 powershell。

  • 不适用于 become。

要求

本地控制器节点上需要以下要求来执行此连接。

  • requests（Python 库）

参数

参数

注释

exec_command_sleep_interval

浮点数

执行命令之间休眠的时间（以秒为单位）。

默认值： 0.5

配置

  • 变量：ansible_vmware_tools_exec_command_sleep_interval

executable

字符串

在容器内执行时使用的 shell

默认值： "/bin/sh"

配置

  • INI 条目

    [defaults]
executable = /bin/sh

  • 环境变量：ANSIBLE_EXECUTABLE

  • 变量：ansible_executable

  • 变量：ansible_vmware_tools_executable

file_chunk_size

整数

文件块大小。

（适用于将文件写入磁盘时，例如：使用 ansible.builtin.fetch 模块。）

默认值： 128

配置

  • 变量：ansible_vmware_tools_file_chunk_size

validate_certs

布尔值

验证连接的 SSL。

注意：这将验证 vmware_host 和运行虚拟机的 ESXi 主机的证书。

选项

  • false

  • true ← （默认）

配置

vm_password

字符串 / 必填

客户机操作系统中用户的密码。

配置

  • 变量：ansible_password

  • 变量：ansible_vmware_tools_password

vm_path

字符串

与 vm_uuid 互斥

相对于连接的 VM 路径绝对路径。

vCenter 示例：Datacenter/vm/Discovered virtual machine/testVM。

ESXi 主机示例：ha-datacenter/vm/testVM。

必须包含 VM 名称，附加到“folder”，因为它将传递到 community.vmware.vmware_guest。

需要在数据中心和 VM 路径的其余部分之间包含 vm。

ESXi 服务器的数据中心默认值为 ha-datacenter。

文件夹 vm 在 vSphere Web Client 中不可见，但 VMware API 工作所必需。

配置

  • 变量：ansible_vmware_guest_path

vm_user

字符串 / 必填

虚拟机用户名。

ansible_vmware_tools_user 用于连接到虚拟机。

ansible_user 由虚拟机上的 Ansible 使用。

配置

  • 变量：ansible_user

  • 变量：ansible_vmware_tools_user

vm_uuid

字符串

与 vm_path 互斥

连接的 VM UUID。

来自 community.vmware.vmware_vm_inventory 插件的属性 config.uuid 的虚拟机 UUID

配置

  • 变量：ansible_vmware_guest_uuid

vmware_host

字符串 / 必填

连接的 FQDN 或 IP 地址（vCenter 或 ESXi 主机）。

配置

  • 环境变量：VI_SERVER

  • 环境变量：VMWARE_HOST

  • 变量：ansible_host

  • 变量：ansible_vmware_host

vmware_password

字符串 / 必填

连接的密码。

配置

vmware_port

字符串

连接的端口。

默认值： 443

配置

vmware_user

字符串 / 必填

连接的用户名。

在虚拟机上需要以下权限： - VirtualMachine.GuestOperations.Execute - VirtualMachine.GuestOperations.Modify - VirtualMachine.GuestOperations.Query

配置

作者

  • Deric Crago (@dericcrago)

提示

每个条目类型的配置条目都有一个从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。