VMware Plugin Commands
Cloud Power Commands
The following table describes the Cloud Power Commands. These commands are available starting from BigFix Platform version 11.0.3.
Name | Syntax | Description |
start instance | start instance | This command starts the target Cloud instance. |
stop instance | stop instance | This command stops the target Cloud instance. The command does not complete successfully the operation if the VMware Tools are not installed on the target Cloud instance. |
restart instance | restart instance | This command restarts the target Cloud instance. |
stop force instance | stop force instance | This command forces the target Cloud instance shutdown operation. |
Required VMware privileges:
- VirtualMachine.Interact.PowerOn
- VirtualMachine.Interact.PowerOff for stop hard instance
- VirtualMachine.Interact.Reset for restart instance
Host Commands
The following table describes the Host Commands:
Name | Syntax | Description |
shutdown host | shutdown host [force=<force>] | This command shuts down a host. |
reboot host | reboot host [force=<force>] | This command reboots a host. |
enter maintenance mode | enter maintenance mode [action=<action> timeout=<timeout> evacuate=<evacuate>] | This command puts the host in maintenance mode. While this task is running and when the host is in maintenance mode, no virtual machines can be powered on and no provisioning operations can be performed on the host. |
exit maintenance mode | exit maintenance mode [timeout=<timeout>] | This command takes the host out of maintenance mode, unless any concurrent running maintenance-only host configurations operations are being performed. |
Required VMware privileges:
- Host.Config.Maintenance
Guest Commands
The following table describes the Guest Power Commands:
Name | Syntax | Description |
power on | power on | This command powers on the target Guest Virtual Machine. |
power off hard | power off hard | This command powers off the target Guest Virtual Machine. |
power off soft | power off soft | This command shuts down the target Guest Virtual Machine. |
reset | reset | This command resets (first powers off, then powers on) the target Guest Virtual Machine. |
restart | restart | This command reboots the target Guest Virtual Machine. |
suspend soft | suspend soft | This command asks the target Guest Virtual Machine operating system to prepare for a suspend operation. |
suspend hard | suspend hard | This command suspends the execution in the target Guest Virtual Machine. |
Required VMware privileges:
- VirtualMachine.Interact.PowerOn
- VirtualMachine.Interact.PowerOff for both power off soft and hard
- VirtualMachine.Interact.Suspend for both suspend soft and hard
- VirtualMachine.Interact.Reset for both reset and restart
The following table describes the Guest Snapshot Commands:
Name | Syntax | Description |
create snapshot | create snapshot <snapshot-name> | This command creates a snapshot with the given name. |
revert snapshot | revert snapshot | This command reverts the virtual machine to the current snapshot. If no snapshot exists, the virtual machine state remains unchanged. |
go to snapshot | go to snapshot <snapshot-name> | This command changes the execution state of the virtual machine to the state of the snapshot with the given name. |
rename snapshot | rename snapshot <snapshot-name>|+|<new-snapshot-name> | This command renames the shapshot with the given name. |
remove snapshot | remove snapshot <snapshot-name> [<children>] | This command removes the snapshot with the given name. If the optional boolean is set to true, it will delete all the snapshot children. |
remove all snapshots | remove all snapshots | This command removes all the snapshot of a Virtual Machine. |
Required VMware privileges:
- VirtualMachine.State.CreateSnapshot
- VirtualMachine.State.RemoveSnapshot for both remove snapshot and remove all snapshots
- VirtualMachine.State.RenameSnapshot
- VirtualMachine.State.RevertToSnapshot for both revert snapshot and go to snapshot
The following table describes the Guest Tools Commands:
Name | Syntax | Description |
mount tools | mount tools | This command will mount the VMware Tools installer on a Virtual Machine. |
upgrade tools | upgrade tools | This command upgrades the VMware Tools for a Virtual Machine. |
Required VMware privileges:
- VirtualMachine.Interact.ToolsInstall for both mount tools and upgrade tools
The following table describes the Guest VLAN Command:
Name | Syntax | Description |
change vlan | change vlan <vlan-name>|+|<adapter-number> | This command will switch the VLAN of a Virtual Machine. |
Required VMware privileges:
- VirtualMachine.Config.EditDevice