UiPath Activities

The UiPath Activities Guide

Power Off VM

UiPath.UiPath.VMware.Activities.PowerOffVM

This activity powers off a virtual machine.

Properties

Common

  • DisplayName - The display name of the activity.

Input

  • ShutdownGuestOS - When selected, the virtual machine is powered off by shutting down the Guest OS. The default value is True.
  • Timeout - Specifies how long to wait (in seconds) for the activity to run before an error is thrown. The default value is 300 seconds (5 minutes).
  • VirtualMachine - Identifies the virtual machine on which the operation is performed.

Note:

The VirtualMachine parameter provides the following information:

  • ID - Specifies the ID of the virtual machine.
  • Name - Specifies the name Virtual machine.
  • Host - Specifies the host on which the virtual machine is running.
  • FullPath - Specifies the full path to the virtual machine, including datacenter and folder hierarchy.
  • IPAddress - Specifies the primary IP address assigned to the guest operating system, if known.
  • DNSName - Specifies the hostname of the guest operating system, if known.
  • GuestOS - Specifies the guest's operating system full name, if known.
  • GuestOSState - Specifies the guest's operating system state. Possible values are Running, ShuttingDown, Resetting, Standby, NotRunning, Unknown.
  • PowerState - Specifies the virtual machine power state. Possible values are PoweredOn, PoweredOff, Suspended.
  • VMwareToolsState - Specifies the current running status of VMware Tools in the guest operating system, if known. Possible values are NotRunning, Running, ExecutingScripts.
  • VMwareToolsVersionStatus - Specifies the current version status of VMware Tools. The possible values are Blacklisted, Current, NeedUpgrade, NotInstalled, SupportedNew, SupportedOld, TooNew, TooOld, Unmanaged.
  • IsTemplate - Indicates if the input represents a virtual machine template.
  • Tags - Specifies the list of tags assigned to the virtual machine or template.
  • WaitForCompletion - When selected, waits for the activity to be complete but cannot exceed the value specified in the Timeout field. When the option it's not selected, the activity ends immediately after the VMware API call is made. The default value is True.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Note:

If the value of ShutdownGuestOS parameter is True and the virtual machine has no Guest OS or VMWare Tools installed on it, the activity completes successfully (i.e. the exception thrown by trying to shutdown the Guest OS is ignored but written into the log files).

Updated 8 days ago


Power Off VM


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.