vmrun 命令的语法

vmrun 命令分为几个功能类别。

下表按功能列出了适用于 Workstation Pro 的 vmrun 命令和参数。将在每行中列出一个参数。用方括号括起来的参数是可选的。竖线表示关键字选项。

vmrun 电源命令和参数

选项	参数	说明
start	.vmx 文件的路径 [ gui | nogui ]	启动虚拟机。默认 gui 选项以交互方式启动虚拟机，这是显示 Workstation Pro 界面所必需的。nogui 选项禁止显示 Workstation Pro 界面（包括启动对话框）以允许使用非交互脚本。
stop	.vmx 文件的路径 [ hard | soft ]	停止虚拟机。在运行关机脚本后，请使用 soft 选项关闭客户机电源。可以使用 hard 选项关闭客户机电源而不运行脚本，就像按电源按钮一样。默认设置是使用 .vmx 文件（如果有）中指定的 powerType 值。
reset	.vmx 文件的路径 [ hard | soft ]	重置虚拟机。在重新引导客户机之前，请使用 soft 选项运行关机脚本。可以使用 hard 选项重新引导客户机而不运行脚本，就像按电源按钮一样。默认设置是使用 .vmx 文件（如果有）中指定的 powerType 值。
suspend	.vmx 文件的路径 [ hard | soft ]	挂起而不关闭虚拟机，因此，以后可以恢复本地工作。在运行系统脚本后，soft 选项挂起客户机。在 Windows 客户机上，这些脚本释放 IP 地址。在 Linux 客户机上，这些脚本挂起网络连接。hard 选项挂起客户机而不运行脚本。默认设置是使用 .vmx 文件（如果有）中指定的 powerType 值。 要在 suspend 命令完成后恢复运行虚拟机，请使用 start 命令。在 Windows 上，将检索 IP 地址。在 Linux 上，将重新启动网络连接。
pause	.vmx 文件的路径	暂停虚拟机。
unpause	.vmx 文件的路径	恢复运行暂时停止正常运行的虚拟机。

vmrun 快照命令和参数

选项	参数	说明
listSnapshots	.vmx 文件的路径 [ showtree ]	列出虚拟机中的所有快照。showtree 选项以树形式显示快照，子项缩进到其父项下面。
snapshot	.vmx 文件的路径 快照名称	创建虚拟机的快照。由于 Workstation Pro 支持多个快照，您必须提供快照名称。
deleteSnapshot	.vmx 文件的路径 快照名称 [ andDeleteChildren ]	从虚拟机中移除快照。由于 Workstation Pro 支持多个快照，您必须提供快照名称。必须关闭虚拟机电源或将其挂起。如果快照具有子项，它们将变为删除的快照的父项的子项，从链末端看后续快照与以前相同。 andDeleteChildren 选项以递归方式删除指定的快照及其子项。 有关名称冲突的解决方案，请参阅 revertToSnapshot。
revertToSnapshot	.vmx 文件的路径 快照名称 或 .vmx 文件的路径 快照/"快照 2"/"快照 N"	将虚拟机设置为拍摄快照时的状态。不过，如果在拍摄快照时已打开虚拟机电源，vmrun 将其还原为已挂起状态，但不会恢复运行虚拟机。 如果快照在虚拟机中具有唯一的名称，请指定虚拟机的配置文件路径和唯一的快照名称以还原为该快照。 如果几个快照具有相同的名称，请包含快照的完整路径名以指定该快照。路径名是一系列以正斜杠字符 (/) 分隔的快照名称。每个名称在树中指定新的快照。例如，路径名 Snap1/Snap2 指定名为 Snap2 的快照，它是根据名为 Snap1 的快照的状态拍摄的。

vmrun 主机网络命令和参数

仅 Workstation Pro with Windows 支持主机网络命令。Workstation Pro with Linux does not support the host network commands.

选项	参数	说明
listHostNetworks		列出主机上的所有网络。
listPortForwardings	主机网络名称	列出主机网络上的所有可用的端口转发。
setPortForwarding	主机网络名称 协议 主机端口 客户机 IP 客户机端口 [Description]	在主机网络上设置端口转发。 注： 要防止该命令返回错误，请在 sudo 实用工具中使用该选项。例如， sudo vmrun setPortForwarding。
deletePortForwarding	主机网络名称 协议 主机端口	删除主机网络上的端口转发。 注： 要防止该命令返回错误，请在 sudo 实用工具中使用该选项。例如， sudo vmrun deletePortForwarding。

vmrun 客户机操作系统命令和参数

所有客户机相关命令的超时为 5 分钟，这是 VMware Tools 的等待时间。

选项	参数	说明
runProgramInGuest	.vmx 文件的路径 [ -noWait | -activeWindow | -interactive ] 程序名称 [ 程序参数 ]	在客户机操作系统中运行指定的程序。在客户机中启动该程序后，-noWait 选项立即返回一条提示，而不是等待该程序完成。该选项适用于交互式程序。-activeWindow 选项确保显示 Windows GUI，而不是将其最小化。它对 Linux 无效。-interactive 选项强制进行交互式客户机登录。该选项适用于 Windows Vista 和 Windows 7 或更高版本的客户机，以便在控制台窗口中显示该程序。您必须提供客户机可访问的程序的完整路径名。根据程序的要求，还要为程序参数中指定的任何文件提供可完全访问的路径名。需要使用 VMware Tools 和有效的客户机登录名。
fileExistsInGuest	.vmx 文件的路径	检查指定的文件在客户机操作系统中是否存在。需要使用 VMware Tools 和有效的客户机登录名。
directoryExistsInGuest	.vmx 文件的路径 客户机上的目录路径	检查指定的目录在客户机操作系统中是否存在。需要使用 VMware Tools 和有效的客户机登录名。
setSharedFolderState	.vmx 文件的路径 共享名称 主机上的文件夹的路径 writable | readonly	修改在主机和客户机虚拟机之间共享的指定文件夹的可写性状态。共享名称 参数值是客户机文件系统中的装载点。主机上的文件夹的路径 参数值是在主机上导出的目录。要将共享文件夹指定为可写或只读，请包含 writable 或 readonly 参数。
addSharedFolder	.vmx 文件的路径 共享名称 主机上的文件夹的路径	添加要在主机和客户机之间共享的文件夹。虚拟机必须正在运行，addSharedFolder 选项才会生效。共享名称 参数值是客户机文件系统中的装载点。主机上的文件夹的路径 参数值是在主机上导出的目录。在 Windows 客户机上，在 runProgramInGuest、fileExistsInGuest 和 directoryExistsInGuest 选项中显示共享文件夹之前可能会出现延迟。
removeSharedFolder	.vmx 文件的路径 共享名称	移除客户机虚拟机对主机上的共享文件夹的访问权限。虚拟机必须正在运行，removeSharedFolder 选项才会生效。共享名称 参数值是客户机文件系统中的装载点。
enableSharedFolders	.vmx 文件的路径 [runtime]	允许 .vmx 文件指定的客户机虚拟机与其主机共享文件夹。在启用后，请运行 addSharedFolder 选项以指定要共享的每个主机文件夹。可选的 [runtime] 参数限制文件夹共享，直到关闭虚拟机电源为止。否则，该设置在下次启动时仍然有效。 注： 在关闭并重新启动客户机后， enableSharedFolders 选项将生效。不会显示任何错误消息。
disableSharedFolders	.vmx 文件的路径 [runtime]	禁止 .vmx 文件指定的客户机虚拟机与其主机共享文件夹。可选的 [runtime] 参数限制将停止应用于文件夹共享，直到关闭虚拟机电源为止。否则，该设置在下次启动时仍然有效。 注： 在关闭并重新启动客户机后， disableSharedFolders 选项将生效。不会显示任何错误消息。
listProcessesInGuest	.vmx 文件的路径	列出在客户机操作系统中运行的所有进程。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。
killProcessInGuest	.vmx 文件的路径 进程 ID	在客户机操作系统中停止指定的进程。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。进程 ID 可以是在 listProcessesInGuest 选项输出中的 pid= 后面列出的任意编号。
runScriptInGuest	.vmx 文件的路径 [ -noWait | -activeWindow | -interactive ] 解释程序路径 脚本文本	在客户机操作系统中运行指定的命令脚本。有关选项说明，请参阅 runProgramInGuest 条目。解释程序路径 选项运行脚本。提供脚本的完整文本，而不是文件名。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。
deleteFileInGuest	.vmx 文件的路径 客户机上的文件的路径	从客户机操作系统中删除指定的文件。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。
createDirectoryInGuest	.vmx 文件的路径 客户机上的目录路径	在客户机操作系统中创建指定的目录。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。
deleteDirectoryInGuest	.vmx 文件的路径 客户机上的目录路径	从客户机操作系统中删除指定的目录。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。
createTempfileInGuest	.vmx 文件的路径	在客户机操作系统中创建一个临时文件，然后返回创建的临时文件的路径名。路径名因操作系统而异。您可以运行 deleteFileInGuest 选项以移除该文件。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。
listDirectoryInGuest	.vmx 文件的路径 客户机上的目录路径	列出客户机操作系统中的指定目录的内容。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。
CopyFileFromHostToGuest	.vmx 文件的路径 主机上的文件路径 客户机中的文件路径	将文件从主机拷贝到客户机操作系统。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。在目标文件名或客户机文件名前面指定源文件名或主机文件名。
CopyFileFromGuestToHost	.vmx 文件的路径 客户机中的文件路径 主机上的文件路径	将文件从客户机操作系统拷贝到主机。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。在目标文件名或主机文件名前面指定源文件名或客户机文件名。
renameFileInGuest	.vmx 文件的路径 原始文件名 新文件名	在客户机操作系统中重命名或移动文件。需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。在目标文件名前面指定源文件名或原始文件名。
connectNamedDevice	.vmx 文件的路径 设备名称	将命令中指定的设备连接到客户机操作系统。只有在打开虚拟机电源后，您才能运行该命令。您可以使用设备名称，例如，sound、serial0、Ethernet0 和 sata0:1 等。 注： 在使用 vmrun connectNamedDevice 命令将断开连接的 sound 设备连接到运行的虚拟机后，关闭虚拟机电源可能会将 sound 设备与虚拟机断开连接，即使虚拟机设置将 sound 设备列出为已连接。
disconnectNamedDevice	.vmx 文件的路径 设备名称	将命令中指定的设备与客户机操作系统断开连接。只有在打开虚拟机电源后，您才能运行该命令。您可以使用设备名称，例如，sound、serial0、Ethernet0 和 sata0:1 等。 注： 在使用 vmrun disconnectNamedDevice 命令将连接的 sound 设备与运行的虚拟机断开连接后，关闭虚拟机电源可能会将 sound 设备重新连接到虚拟机，即使虚拟机设置将 sound 设备列出为已断开连接。
captureScreen	.vmx 文件的路径 主机上的输出路径	将虚拟机屏幕捕获到一个本地文件。主机上的指定输出文件采用 PNG 格式。需要具有有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。
writeVariable	.vmx 文件的路径 [ guestVar | runtimeConfig | guestEnv ] 变量名称 变量值	将变量写入到虚拟机状态或客户机中。您可以在客户机操作系统中设置非永久性客户机变量 guestVar、运行时配置变量 runtimeConfig（存储在 .vmx 文件中）或环境变量 guestEnv。客户机变量是一个仅运行时值，它提供了一种简便的方法以将运行时值传入和传出客户机。环境变量需要使用 VMware Tools 和有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。对于 Linux，设置客户机环境还需要使用 root 登录名。
readVariable	.vmx 文件的路径 [ guestVar | runtimeConfig | guestEnv ] 变量名称	从虚拟机状态或客户机中读取变量。您可以在客户机操作系统中获取客户机变量、.vmx 文件中存储的运行时配置或环境变量。读取 guestEnv 变量需要具有有效的客户机登录名。例如，您可以使用 -gu 和 -gp 选项登录到客户机。有关变量类型的说明，请参阅 writeVariable 条目。
getGuestIPAddress	.vmx 文件的路径 [ -wait ]	检索客户机的 IP 地址。 在使用 [ -wait ] 选项时，该命令一直等到具有可用的 IP 地址。例如，在打开虚拟机电源后，才会具有可用的 IP 地址。如果网络未准备就绪，该命令立即返回到命令行提示符。

vmrun 常规命令和参数

选项	参数	说明
list		列出所有运行的虚拟机。
upgradevm	.vmx 文件的路径	将虚拟机升级到当前虚拟硬件版本。如果虚拟硬件版本是支持的最新版本，则该命令无效。 关闭虚拟机电源，例如，使用 vmrun stop 命令。等待较短的时间以完成该命令，然后运行 vmrun upgradevm 命令。
installTools	.vmx 文件的路径	准备在客户机操作系统中安装 VMware Tools。在已启用自动运行的 Windows 客户机中，VMware Tools 安装程序将自行启动。在未启用自动运行的 Linux 客户机中，该命令将虚拟 CD-ROM 驱动器连接到适用于客户机的 VMware Tools ISO 映像，但不会启动该安装程序。 您必须执行额外的手动步骤以完成安装，如产品文档中所述。
checkToolsState	.vmx 文件的路径	检查客户机中的 VMware Tools 的状态。可能的状态为 unknown、installed 和 running。
deleteVM	.vmx 文件的路径	删除虚拟机。
clone	.vmx 文件的路径 目标 .vmx 文件路径 full|linked [-snapshot=Snapshot Name] [-cloneName=Name]	创建虚拟机的副本。 仅 Workstation Pro 支持 clone 选项。

vmrun 模板虚拟机命令和参数

选项	参数	说明
downloadPhotonVM	下载的虚拟机的保存路径	下载 VMware Project Photon 操作系统虚拟机。