Activities
latest
false
- Overview
- Active Directory
- Release Notes
- About the Active Directory Activities Package
- Project Compatibility
- Active Directory Scope
- Get Object Distinguished Name
- Get Object Properties
- Get Objects by Filter
- Get Objects by LDAP Filter
- Is Object Member of Group
- Move Object
- Rename Object
- Update Object Properties
- Add Computer To Group
- Computer Exists
- Create Computer
- Delete Computer
- Get Computer Status
- Get Computers in Group
- Join Computer to Domain
- Remove Computer From Group
- Set Computer Status
- Unjoin Computer From Domain
- Add Group To Group
- Create Group
- Delete Group
- Group Exists
- Remove Group From Group
- Add User To Group
- Change User Password
- Create User
- Delete User
- Force Password Change
- Get Password Expiration Date
- Get User Expiration Date
- Get User Groups
- Get User Status
- Get Users in Group
- Remove User From Group
- Set User Expiration Date
- Set User Status
- User Exists
- Validate User Credentials
- Create Organizational Unit
- Delete Organizational Unit
- Active Directory how-to guides
- Amazon Web Services
- Release Notes
- About the Amazon Web Services Activities Package
- Project Compatibility
- Permissions List
- Amazon Web Services Scope
- Configure Robot
- Create Instance
- Create Instance From Launch Template
- Get Instance by ID
- Get Instance List
- Reboot Instance
- Start Instance
- Stop Instance
- Terminate Instance
- Attach Volume To Instance
- Create Instance Snapshots
- Create Volume
- Create Volume Snapshot
- Delete Snapshot
- Delete Volume
- Detach Volume From Instance
- Get Instance Volumes
- Get Snapshot
- Get Volume
- Get Volume List
- Add User To Group
- Create Group
- Delete Group
- For Each Group
- Get Group
- Remove User From Group
- Update Group
- Add/Remove Inline Policy
- Attach/Detach Managed Policy
- Create Managed Policy
- Delete Managed Policy
- For Each Managed Policy
- Get IAM Identities Attached to a Managed Policy
- Get IAM Identity Inline Policies
- Get IAM Identity Managed Polices
- Get Managed Policy
- Update Managed Policy
- Add Role to Instance Profile
- Create Role
- Delete Role
- For Each Role
- Get Role
- Remove Role From Instance Profile
- Update Role
- Change User Password
- Create User
- Delete User
- For Each User
- For Each User Group
- For Each User in Group
- Get User
- Update User
- Configure Logging for Bucket
- Configure Public Access to Bucket
- Create Bucket
- Delete Bucket
- Delete Bucket Policy
- Empty Bucket
- Get Bucket
- Get Bucket List
- Get Bucket Policy
- Set Bucket Policy
- Update Bucket Properties
- Copy Object
- Delete Multiple Objects
- Delete Single Object
- Download Object to File
- For Each Object in Bucket
- Get Object
- Get Object ACL
- Set Object ACL
- Upload Object From File
- Upload Objects From Folder
- Run Power Shell Command
- Amazon Web Services how-to guides
- Amazon WorkSpaces
- Azure
- Release Notes
- About the Azure Activities Package
- Project Compatibility
- Azure Scope
- Get Secrets
- Create Resource Group
- Delete Resource Group
- Get Resource Group
- Get Resource Group List
- Append to Blob
- Copy Blob
- Create Blob Container
- Delete Blob
- Delete Blob Container
- Download Blob To File
- For Each Blob Container
- For Each Blob in Container
- Get Blob
- Get Blob Container
- Get Blob Containers List
- Get Blob List
- Upload Blob From File
- Create Storage Account
- Delete Storage Account
- Get Storage Account
- Get Storage Account Key
- Get Storage Account List
- Regenerate Storage Account Key
- Create Tables
- Delete Rows
- Delete Table
- For Each Row In Table
- Get Row
- Get Rows By Filter
- Get Table
- Get Table List
- Insert Rows
- Attach VM Data Disk
- Configure Robot
- Create VM
- Delete VM
- Detach VM Data Disk
- Get Disk
- Get Disk List
- Get RDP Files
- Get VM
- Get VM Custom Image
- Get VM Custom Image List
- Get VM Disk List
- Get VM Image By Publisher
- Get VM List
- Restart VM
- Run Script In VM
- Shutdown VM
- Start VM
- Stop VM
- Create Network Interface
- Get Network Interface
- Delete Network Interface
- Create NSG
- Delete NSG
- For Each NSG
- Get VM NSG List
- Delete IP Configuration
- Delete Security Rule
- Get NSG
- Get Security Rule List
- For Each Security Alert
- For Each Network Interface
- Get NSG Network Interface List
- Create IP Configuration
- Set Security Alert State
- Get VM Network Interface List
- Get Security Rule
- Create Security Rule
- Get Security Alert
- Set Blob Tier
- Azure how-to guides
- Azure Active Directory
- Release Notes
- About the Azure Active Directory Activities Package
- Project Compatibility
- Azure AD Delegated Scope
- Azure AD Application Scope
- Add Member To Role
- For Each Role
- For Each User in Role
- Is Member In Role
- Remove Member From Role
- Add Group to Lifecycle Policy
- Create Lifecycle Policy
- Delete Lifecycle Policy
- For Each Lifecycle Policy
- Is Group in Lifecycle Policy
- Remove Group From Lifecycle Policy
- Update Lifecycle Policy
- Add Member To Group
- For Each Group in Group
- For Each Parent Group
- For Each User In Group
- Is Member of Group
- Remove Member From Group
- Add Owner To Group
- For Each User in Group Owners
- Is Owner Of Group
- Remove Owner From Group
- Create Assigned Group
- Delete Group
- For Each Group
- Get Group By Id
- Group Exists
- Update Group
- For Each Direct Report
- Get Manager
- Set Manager
- Create User
- Delete User
- For Each User
- For Each User Group
- For Each User Role
- Get User
- Reset Password
- Update User
- User Exists
- Get Group by Name
- Assign License
- Remove License
- Azure Active Directory how-to guides
- Azure Windows Virtual Desktop
- Release Notes
- About the Azure Windows Virtual Desktop Activities Package
- Project Compatibility
- Windows Virtual Desktop Scope
- Create Host Pool
- Add Virtual Machine to Host Pool
- Update Host Pool
- Get Host Pool
- Delete Host Pool
- For Each Host Pool
- Get Session Host
- For Each Session Host
- Update Session Host
- Delete Session Host
- For Each User Session
- Disconnect User Session
- Delete User Session
- Send Message to User Session
- Get Application Group
- For Each Application Group
- Assign Users and Groups to Application Group
- Remove Users and Groups From Application Group
- Create Workspace
- Update Workspace
- Get Workspace
- For Each Workspace
- Delete Workspace
- Citrix
- Release Notes
- About the Citrix Activities Package
- Project Compatibility
- Citrix Scope
- Get Server List
- Get Storage Repositories
- Add Tag to VM
- Add VM to Folder
- Remove Tag From VM
- Remove VM From Folder
- Delete All VM Snapshots
- Delete VM Snapshot
- Get VM Snapshot List
- Revert VM to Snapshot
- Take VM Snapshot
- Create VM From Template
- Delete VM
- Get Template List
- Get VM by UUID
- Get VM List
- Power Off VM
- Power On VM
- Rename VM
- Restart VM
- Resume VM
- Suspend VM
- Citrix activities how-to guides
- Desktop triggers
- Exchange Server
- Google Cloud
- Release Notes
- About the Google Cloud Activities Package
- Project Compatibility
- Google Cloud Scope
- Create Bucket
- Update Bucket Properties
- Get Bucket
- For Each Bucket
- Delete Bucket
- Get Object
- Delete Object
- Copy Object
- Upload Object From File
- Download Object to File
- For Each Object in Bucket
- Create Instance
- Create Instance From Template
- Get Instance
- For Each Instance
- Start Instance
- Stop Instance
- Reset Instance
- Delete Instance
- Configure Robot
- Run Script on Instance
- Get Project
- For Each Project
- Create Role
- Delete Role
- For Each Grantable Role
- For Each Role
- Get Role
- Undelete Role
- Update Role
- Get IAM Policy
- Set IAM Policy
- Get Secret Data
- Google Cloud how-to guides
- Hyper V
- NetIQ eDirectory
- Release Notes
- About the NetIQ EDirectory Activities Package
- Project Compatibility
- NetIQ EDirectory Scope
- Add Object To Group
- Delete Object
- Get Object Distinguished Name
- Get Object Properties
- Get Objects by Filter
- Get Objects by LDAP Filter
- Is Object Member of Group
- Move Object
- Remove Object From Group
- Rename Object
- Update Object Properties
- Add Computer To Group
- Computer Exists
- Delete Computer
- Create Computer
- Get Computer Status
- Remove Computer From Group
- Set Computer Status
- Add Group To Group
- Create Group
- Delete Group
- Get Computers in Group
- Get Users in Group
- Group Exists
- Remove Group From Group
- Create Organizational Unit
- Delete Organizational Unit
- Add User To Group
- Change User Password
- Create User
- Delete User
- Force Password Change
- Get Password Expiration Date
- Get User Expiration Date
- Get User Groups
- Get User Status
- Remove User From Group
- Set User Expiration Date
- Set User Status
- User Exists
- Validate User Credentials
- System Center
- VMWare
- Release Notes
- About the VMware Activities Package
- Project Compatibility
- VMware Scope
- Get Datastore
- Get Datastore List
- Get Host
- Get Host List
- Delete All VM Snapshots
- Delete VM Snapshot
- Get VM Snapshot List
- Revert VM to Snapshot
- Take VM Snapshot
- Configure Robot
- Create VM From Template
- Convert Template to VM
- Convert VM to Template
- Customize VM
- Delete VM
- Get VM
- Get VM List
- Power Off VM
- Suspend VM
- Run Program in VM
- Restart VM
- Rename VM
- Power On VM
- Move VM To Folder
- Migrate VM
- Get Template List
- Export OVF Template
- Deploy OVF Template
- Assign Tag to VM
- Remove Tag From VM
- Assign Tag to Folder
- Remove Tag From Folder
- Create Folder
- Get Folder
- Rename Folder
- Move Folder
- Delete Folder
- Mount Tools Installer
- Unmount Tools Installer
- Upgrade Tools
- VMWare activities how-to guides
IT Automation Activities
Last updated Mar 8, 2024
Get VM
UiPath.VMware.Activities.GetVM
Retrieves details about the specified virtual machine or template.
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.
