Citrix Scope
UiPath.Citrix.Activities.CitrixScope
Server Virtualization.CitrixConnects to a Citrix Hypervisor server and provides a scope for other Citrix activities.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| CitrixHypervisorServer | In | InArgument<String> |
✓ | ||
| Username | In | InArgument<String> |
✓ | ||
| Password | In | InArgument<Security.SecureString> |
✓ | ||
| Port | In | InArgument<Int32> |
Get Server List
UiPath.Citrix.Activities.CitrixGetServerList
Server Virtualization.Citrix.ServersRetrieves the list of all Citrix Hypervisor Servers from the pool associated with the current session.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Timeout | In | InArgument<Int32> |
✓ | ||
| ServerList | Out | OutArgument<UiPath.Citrix.Contracts.Server[]> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Get Storage Repositories
UiPath.Citrix.Activities.CitrixGetStorageRepositories
Server Virtualization.Citrix.ServersRetrieves details about the storage repositories associated with a Citrix Hypervisor Server.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Server | In | InArgument<UiPath.Citrix.Contracts.Server> |
|||
| Timeout | In | InArgument<Int32> |
✓ | ||
| StorageRepositories | Out | OutArgument<UiPath.Citrix.Contracts.StorageRepository[]> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Create VM From Template
UiPath.Citrix.Activities.CitrixCreateVMFromTemplate
Server Virtualization.Citrix.Virtual MachinesCreates a new virtual machine based on an existing template.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| HomeServerUUID | In | InArgument<String> |
✓ | ||
| StorageRepositoryUUID | In | InArgument<String> |
|||
| VirtualMachineName | In | InArgument<String> |
✓ | ||
| VirtualMachineDescription | In | InArgument<String> |
|||
| CustomTemplate | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Timeout | In | InArgument<Int32> |
✓ | ||
| VirtualMachine | Out | OutArgument<UiPath.Citrix.Contracts.VirtualMachine> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| PowerOnAfterCreation | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Delete VM
UiPath.Citrix.Activities.CitrixDeleteVM
Server Virtualization.Citrix.Virtual MachinesDeletes a specified virtual machine or template.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Timeout | In | InArgument<Int32> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| WaitForCompletion | property | Boolean |
|
| DeleteAssociatedDisks | property | Boolean |
|
| DeleteSnapshots | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Get Template List
UiPath.Citrix.Activities.CitrixGetTemplateList
Server Virtualization.Citrix.Virtual MachinesRetrieves a list of templates.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FilterValue | In | InArgument<String> |
|||
| Timeout | In | InArgument<Int32> |
✓ | ||
| TemplateList | Out | OutArgument<UiPath.Citrix.Contracts.VirtualMachine[]> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| FilterBy | property | UiPath.Citrix.Contracts.FilterByEnum |
|
| IncludeSubfolders | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Get VM by UUID
UiPath.Citrix.Activities.CitrixGetVMByUUID
Server Virtualization.Citrix.Virtual MachinesRetrieves the details of the specified virtual machine or template.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachineUUID | In | InArgument<String> |
✓ | ||
| Timeout | In | InArgument<Int32> |
✓ | ||
| VirtualMachine | Out | OutArgument<UiPath.Citrix.Contracts.VirtualMachine> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Get VM List
UiPath.Citrix.Activities.CitrixGetVMList
Server Virtualization.Citrix.Virtual MachinesRetrieves a list of virtual machines.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FilterValue | In | InArgument<String> |
|||
| Timeout | In | InArgument<Int32> |
✓ | ||
| VMList | Out | OutArgument<UiPath.Citrix.Contracts.VirtualMachine[]> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| FilterBy | property | UiPath.Citrix.Contracts.FilterByEnum |
|
| IncludeSubfolders | property | Boolean |
|
| PowerState | property | UiPath.Citrix.Contracts.PowerStateFilter |
|
| IncludeGuestOSDetails | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Power Off VM
UiPath.Citrix.Activities.CitrixPowerOffVM
Server Virtualization.Citrix.Virtual MachinesPowers off a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Timeout | In | InArgument<Int32> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ForcedShutDown | property | Boolean |
|
| WaitForCompletion | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Power On VM
UiPath.Citrix.Activities.CitrixPowerOnVM
Server Virtualization.Citrix.Virtual MachinesPowers on a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Timeout | In | InArgument<Int32> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| WaitForCompletion | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Rename VM
UiPath.Citrix.Activities.CitrixRenameVM
Server Virtualization.Citrix.Virtual MachinesRenames a virtual machine or template.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| NewName | In | InArgument<String> |
✓ | ||
| VirtualMachineResult | Out | OutArgument<UiPath.Citrix.Contracts.VirtualMachine> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Restart VM
UiPath.Citrix.Activities.CitrixRestartVM
Server Virtualization.Citrix.Virtual MachinesRestarts a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Timeout | In | InArgument<Int32> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ForcedReboot | property | Boolean |
|
| WaitForCompletion | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Resume VM
UiPath.Citrix.Activities.CitrixResumeVM
Server Virtualization.Citrix.Virtual MachinesResumes a suspended virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Timeout | In | InArgument<Int32> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| WaitForCompletion | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Suspend VM
UiPath.Citrix.Activities.CitrixSuspendVM
Server Virtualization.Citrix.Virtual MachinesSuspends a running virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Timeout | In | InArgument<Int32> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| WaitForCompletion | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Add Tag to VM
UiPath.Citrix.Activities.CitrixAddTagToVM
Server Virtualization.Citrix.Virtual Machines.OrganizationAdd a tag to the specified virtual machine or template.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Tag | In | InArgument<String> |
✓ | ||
| VirtualMachineResult | Out | OutArgument<UiPath.Citrix.Contracts.VirtualMachine> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Add VM to Folder
UiPath.Citrix.Activities.CitrixAddVMToFolder
Server Virtualization.Citrix.Virtual Machines.OrganizationAdds the specified virtual machine or template to a folder.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Folder | In | InArgument<String> |
✓ | ||
| VirtualMachineResult | Out | OutArgument<UiPath.Citrix.Contracts.VirtualMachine> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Remove Tag From VM
UiPath.Citrix.Activities.CitrixRemoveTagFromVM
Server Virtualization.Citrix.Virtual Machines.OrganizationRemove a tag from the specified virtual machine or template.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Tag | In | InArgument<String> |
✓ | ||
| VirtualMachineResult | Out | OutArgument<UiPath.Citrix.Contracts.VirtualMachine> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Remove VM from Folder
UiPath.Citrix.Activities.CitrixRemoveVMFromFolder
Server Virtualization.Citrix.Virtual Machines.OrganizationRemoves the specified virtual machine or template from a folder.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Folder | In | InArgument<String> |
✓ | ||
| VirtualMachineResult | Out | OutArgument<UiPath.Citrix.Contracts.VirtualMachine> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Delete All VM Snapshots
UiPath.Citrix.Activities.CitrixDeleteAllVMSnapshots
Server Virtualization.Citrix.Virtual Machines.SnapshotsDeletes all snapshots of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Timeout | In | InArgument<Int32> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| WaitForCompletion | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Delete VM Snapshot
UiPath.Citrix.Activities.CitrixDeleteVMSnapshot
Server Virtualization.Citrix.Virtual Machines.SnapshotsDeletes a given snapshot of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Snapshot | In | InArgument<UiPath.Citrix.Contracts.Snapshot> |
✓ | ||
| Timeout | In | InArgument<Int32> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| WaitForCompletion | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Get VM Snapshot List
UiPath.Citrix.Activities.CitrixGetVMSnapshotList
Server Virtualization.Citrix.Virtual Machines.SnapshotsRetrieves all snapshots of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Timeout | In | InArgument<Int32> |
✓ | ||
| Snapshots | Out | OutArgument<UiPath.Citrix.Contracts.Snapshot[]> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Revert VM to Snapshot
UiPath.Citrix.Activities.CitrixRevertVMToSnapshot
Server Virtualization.Citrix.Virtual Machines.SnapshotsReverts the virtual machine to a specified snapshot. If no snapshot exists, then the activity does nothing, and the virtual machine state remains unchanged.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| Snapshot | In | InArgument<UiPath.Citrix.Contracts.Snapshot> |
|||
| Timeout | In | InArgument<Int32> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| WaitForCompletion | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Take VM Snapshot
UiPath.Citrix.Activities.CitrixTakeVMSnapshot
Server Virtualization.Citrix.Virtual Machines.SnapshotsTakes a snapshot of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.Citrix.Contracts.VirtualMachine> |
✓ | ||
| SnapshotName | In | InArgument<String> |
✓ | ||
| SnapshotDescription | In | InArgument<String> |
|||
| Timeout | In | InArgument<Int32> |
|||
| Snapshot | Out | OutArgument<UiPath.Citrix.Contracts.Snapshot> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| SnapshotVMMemory | property | Boolean |
|
| Quiesce | property | Boolean |
|
| WaitForCompletion | property | Boolean |
|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |