UiPath Activities

The UiPath Activities Guide

UiPath.UiPath.VMware.Activities.GetVM

Retrieves details about the specified virtual machine or template.

Properties

Common

  • DisplayName - The display name of the activity.

Input

  • 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).
  • VirtualMachineId - Specifies the unique identifier of the virtual machine or template.
  • VirtualMachineName - Specifies the full path of the new virtual machine, including the data center and its folder.

Note:

At least one of VirtualMachineId or VirtualMachineName parameters must have a value; if both have values, the "VirtualMachineId" takes the precedence.

Misc

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

Output

  • VirtualMachine - Provides details about the newly created virtual machine.

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.

Note:

For retrieving the DNS Name and IP Address, you need to install the VMware tools on the Guest OS and to power on the machine at least once before initiating the request.

Updated 6 days ago


Get VM


Suggested Edits are limited on API Reference Pages

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