HyperV Scope
UiPath.HyperV.Activities.HyperVScope
Connects to a Hyper-V Host and provides a scope for other Hyper-V activities.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| HyperVHost | In | InArgument<String> |
|||
| Username | In | InArgument<String> |
|||
| Password | In | InArgument<Security.SecureString> |
Delete All VM Checkpoints
UiPath.HyperV.Activities.HyperVDeleteAllVMCheckpoints
Deletes all checkpoints of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.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 VM Checkpoint
UiPath.HyperV.Activities.HyperVDeleteVMCheckpoint
Deletes a given checkpoint of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| Checkpoint | In | InArgument<UiPath.HyperV.Models.Checkpoint> |
✓ | ||
| IncludeAllChildCheckpoints | In | InArgument<Boolean> |
|||
| 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 Checkpoint List
UiPath.HyperV.Activities.HyperVGetVMCheckpointList
Retrieves all checkpoints of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| Checkpoints | Out | OutArgument<List<UiPath.HyperV.Models.Checkpoint>> |
|||
| 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 Checkpoint
UiPath.HyperV.Activities.HyperVRevertVMCheckpoint
Reverts the virtual machine to a specified checkpoint. If no checkpoint exists, the activity does nothing and the virtual machine state remains unchanged.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| Checkpoint | In | InArgument<UiPath.HyperV.Models.Checkpoint> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Take VM Checkpoint
UiPath.HyperV.Activities.HyperVTakeVMCheckpoint
Takes a checkpoint of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| CheckpointName | In | InArgument<String> |
✓ | ||
| CheckpointDescription | In | InArgument<String> |
|||
| Checkpoint | Out | OutArgument<UiPath.HyperV.Models.Checkpoint> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Configure Robot
UiPath.HyperV.Activities.HyperVConfigureRobot
Connects the Robot in a given VM to Orchestrator.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| OrchestratorURL | In | InArgument<String> |
|||
| OrchestratorConnectionString | In | InArgument<String> |
|||
| MachineKey | In | InArgument<String> |
|||
| Username | In | InArgument<String> |
✓ | ||
| Password | In | InArgument<Security.SecureString> |
✓ | ||
| 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.HyperV.Activities.HyperVCreateVM
Provisions a new virtual machine from a template.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachineName | In | InArgument<String> |
✓ | ||
| VirtualMachineDescription | In | InArgument<String> |
|||
| Location | In | InArgument<String> |
|||
| Generation | In | InArgument<UiPath.Core.VMGeneration> |
|||
| VhdFile | In | InArgument<String> |
✓ | ||
| PowerOnAfterCreation | In | InArgument<Boolean> |
|||
| StartupMemoryInMB | In | InArgument<Nullable<Int32>> |
|||
| UseDynamicMemory | In | InArgument<Boolean> |
|||
| VirtualMachine | Out | OutArgument<UiPath.HyperV.Models.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 VM
UiPath.HyperV.Activities.HyperVDeleteVM
Deletes a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| DeleteAssociatedDisks | In | InArgument<Boolean> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Export VM
UiPath.HyperV.Activities.HyperVExportVM
Exports a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| Folder | In | InArgument<String> |
✓ | ||
| 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 by ID
UiPath.HyperV.Activities.HyperVGetVMByID
Retrieves the details of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachineId | In | InArgument<String> |
✓ | ||
| VirtualMachine | Out | OutArgument<UiPath.HyperV.Models.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.HyperV.Activities.HyperVGetVMList
Retrieves a list of virtual machines.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FilterBy | In | InArgument<String> |
|||
| FilterOperator | In | InArgument<String> |
|||
| FilterValue | In | InArgument<String> |
|||
| Generation | In | InArgument<String> |
|||
| State | In | InArgument<String> |
|||
| IncludeGuestOSDetails | In | InArgument<Boolean> |
|||
| VMList | Out | OutArgument<UiPath.HyperV.Models.VirtualMachine[]> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Import VM
UiPath.HyperV.Activities.HyperVImportVM
Imports a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VMFile | In | InArgument<String> |
✓ | ||
| CheckpointFolder | In | InArgument<String> |
✓ | ||
| ImportType | In | InArgument<UiPath.Core.VMImportType> |
✓ | ||
| VhdFolder | In | InArgument<String> |
✓ | ||
| VMName | In | InArgument<String> |
|||
| StorageFolder | In | InArgument<String> |
|||
| Location | In | InArgument<String> |
|||
| VirtualMachine | Out | OutArgument<UiPath.HyperV.Models.VirtualMachine> |
|||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Pause VM
UiPath.HyperV.Activities.HyperVPauseVM
Pauses a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Rename VM
UiPath.HyperV.Activities.HyperVRenameVM
Renames a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| NewName | In | InArgument<String> |
✓ | ||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Reset VM
UiPath.HyperV.Activities.HyperVResetVM
Resets a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Resume VM
UiPath.HyperV.Activities.HyperVResumeVM
Resumes a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Shutdown VM
UiPath.HyperV.Activities.HyperVShutdownVM
Shuts down the Operating System of the specified virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Start VM
UiPath.HyperV.Activities.HyperVStartVM
Starts a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |
Turn Off VM
UiPath.HyperV.Activities.HyperVTurnOffVM
Turns off a virtual machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VirtualMachine | In | InArgument<UiPath.HyperV.Models.VirtualMachine> |
✓ | ||
| ConnectionId | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Connector | property | String |
|
| BindingsKey | property | String |
|
| BindingsVersion | property | String |
|
| ConnectionClient | property | UiPath.ConnectionClient.IConnectionClient |