UiPathOrch

Author(s)

• Yoshifumi Tsuda

Cmdlets

Get-OrchLibrary Get-OrchLibraryVersion Remove-OrchLibrary Import-OrchLibrary Export-OrchLibrary Copy-OrchLibrary Get-OrchPackage Copy-OrchPackage Get-OrchPackageVersion Remove-OrchPackage Import-OrchPackage Export-OrchPackage Get-OrchJob Start-OrchJob Stop-OrchJob Open-OrchJob Get-OrchLog Get-OrchAuditLog Get-OrchJobMedia Export-OrchJobMedia Remove-OrchJobMedia Get-OrchProcess New-OrchProcess Update-OrchProcess Copy-OrchProcess Remove-OrchProcess Edit-OrchProcess Update-OrchProcessVersion Reset-OrchProcessVersion Get-OrchRobot Get-OrchUser Add-OrchUser Update-OrchUser Copy-OrchUser Remove-OrchUser Remove-OrchRoleFromUser Get-OrchCurrentUser Update-OrchCurrentUserURPassword Get-OrchLicenseNamedUser Get-OrchLicenseRuntime Enable-OrchLicenseRuntime Disable-OrchLicenseRuntime Get-OrchPmAuditLog Get-OrchPmLicensedUser Get-OrchPmLicensedGroup Remove-OrchPmLicensedGroup Add-OrchPmLicenseToPmLicensedGroup Remove-OrchPmAllocationFromPmLicensedGroup Remove-OrchPmLicenseFromPmLicensedGroup Get-OrchClassicRobot Get-OrchClassicEnvironment Get-OrchUserSession Get-OrchMachineSession Get-OrchUnattendedSession Enable-OrchMaintenanceMode Disable-OrchMaintenanceMode Get-OrchJobStats Get-OrchLicenseStats Get-OrchRole Set-OrchRole Remove-OrchRole Copy-OrchRole Get-OrchCalendar Remove-OrchCalendar Copy-OrchCalendar Add-OrchCalendarDate Remove-OrchCalendarDate Get-OrchPersonalWorkspace Remove-OrchPersonalWorkspace Get-OrchFolderUsage Get-OrchFolderUser Add-OrchFolderUser Copy-OrchFolderUser Move-OrchFolderUser Remove-OrchFolderUser Add-OrchRoleToFolderUser Remove-OrchRoleFromFolderUser Get-OrchMachine Update-OrchMachine New-OrchMachine Remove-OrchMachine Copy-OrchMachine Get-OrchMachineClientSecretId Add-OrchMachineClientSecret Remove-OrchMachineClientSecret Get-OrchFolderMachine Add-OrchFolderMachine Copy-OrchFolderMachine Remove-OrchFolderMachine Enable-OrchFolderMachineInherit Disable-OrchFolderMachineInherit Get-OrchFolderMachineAccountMapping Enable-OrchFolderMachineAccountMapping Disable-OrchFolderMachineAccountMapping Get-OrchAsset Set-OrchAsset Copy-OrchAsset Remove-OrchAsset Set-OrchCredentialAsset Get-OrchCredentialStore Copy-OrchCredentialStore Remove-OrchCredentialStore Get-OrchAssetLink Add-OrchAssetLink Get-OrchTrigger New-OrchTrigger Update-OrchTrigger Remove-OrchTrigger Copy-OrchTrigger Enable-OrchTrigger Disable-OrchTrigger Get-OrchApiTrigger Remove-OrchApiTrigger Copy-OrchApiTrigger Enable-OrchApiTrigger Disable-OrchApiTrigger Get-OrchQueue New-OrchQueue Update-OrchQueue Copy-OrchQueue Remove-OrchQueue Get-OrchQueueItem Import-OrchQueueItem Redo-OrchQueueItem Get-OrchTestSet Copy-OrchTestSet Remove-OrchTestSet Start-OrchTestSet Get-OrchTestCase Get-OrchTestCaseExecution Remove-OrchTestCase Get-OrchTestSetExecution Stop-OrchTestSetExecution Get-OrchTestSetSchedule Copy-OrchTestSetSchedule Remove-OrchTestSetSchedule Enable-OrchTestSetSchedule Disable-OrchTestSetSchedule Get-OrchTestDataQueue Copy-OrchTestDataQueue Remove-OrchTestDataQueue Get-OrchTestDataQueueItem Reset-OrchTestDataQueueItem Get-OrchAlert Get-OrchBucket New-OrchBucket Copy-OrchBucket Remove-OrchBucket Get-OrchBucketItem Get-OrchWebhook Copy-OrchWebhook Remove-OrchWebhook Enable-OrchWebhook Disable-OrchWebhook Get-OrchSetting Get-OrchExecutionSetting Get-OrchWebSetting Get-OrchAuthenticationSetting Get-OrchActivitySetting Get-OrchConnectionString Get-OrchLicense Get-OrchUpdateSetting Get-OrchActionCatalog Copy-OrchActionCatalog Remove-OrchActionCatalog Get-OrchPmUser Update-OrchPmUser Remove-OrchPmUser New-OrchPmUserBulk Copy-OrchPmUser Get-OrchPmRobotAccount Set-OrchPmRobotAccount Copy-OrchPmRobotAccount Remove-OrchPmRobotAccount Get-OrchPmGroup New-OrchPmGroup Remove-OrchPmGroup Add-OrchPmGroupMember Move-OrchPmGroupMember Remove-OrchPmGroupMember Get-OrchPmExternalApiResource Get-OrchPmExternalApplication Get-DuRole Get-DuUser Get-DuDocumentType Get-DuClassifier Get-DuExtractor Get-TmConfiguration Get-TmProjectSetting Get-TmProjectPermission Get-TmServerInfo Get-TmRequirement Remove-TmRequirement Get-TmTestCase Remove-TmTestCase Get-TmTestSet Remove-TmTestSet Clear-OrchCache Edit-OrchConfig Get-OrchPSDrive Set-OrchLocation

Functions

Get-OrchTestDataQueueItemTable Enable-OrchUserAttended Disable-OrchUserAttended Enable-OrchPersonalWorkspace Disable-OrchPersonalWorkspace Find-OrchFolderNoUserAssigned Get-OrchJobVideo

Dependencies

This module has no dependencies.

Release Notes

- Several cmdlets with the verb Add have been renamed to use the verb New. When these cmdlets were initially created, the verb Add was chosen to align with the terminology used in the Orchestrator web interface, as it was considered more intuitive at the time. However, as the number of cmdlets increased, it was determined that New and Add should be used appropriately based on their functionality. We apologize for any inconvenience caused by this change.

- List of cmdlets renamed to use the verb New:
 - Add-OrchMachine -> New-OrchMachine
 - Add-OrchBucket -> New-OrchBucket
 - Add-OrchProcess -> New-OrchProcess
 - Add-OrchQueue -> New-OrchQueue
 - Add-OrchTrigger -> New-OrchTrigger
 - Add-OrchPmUserBulk -> New-OrchPmUserBulk
 - Add-OrchPmGroup -> New-OrchPmGroup

List of cmdlets where the verb was not changed:
 - Add-OrchUser
 - Add-OrchCalendarDate
 - Add-OrchMachineClientSecret
 - Add-OrchFolderMachine
 - Add-OrchFolderUser
 - Add-OrchRoleToFolderUser
 - Add-OrchAssetLink
 - Add-OrchPmGroupMember
 - Add-OrchPmLicenseToPmLicensedGroup
 - Start-OrchJob

- The above changes are only renaming the cmdlets, and their functionality remains completely unchanged. If you wish to use the cmdlets with their old names, you can set aliases. Aliases can be configured as follows:

 PS> Set-Alias Add-OrchProcess New-OrchProcess

- To configure the alias automatically when the PowerShell console starts, you can add the above command to your profile script. To edit the profile script, execute the following in the PowerShell console:

 PS> notepad $profile