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 Add-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 Add-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 Add-OrchTrigger Update-OrchTrigger Remove-OrchTrigger Copy-OrchTrigger Enable-OrchTrigger Disable-OrchTrigger Get-OrchApiTrigger Remove-OrchApiTrigger Copy-OrchApiTrigger Enable-OrchApiTrigger Disable-OrchApiTrigger Get-OrchQueue Add-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 Add-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 Add-OrchPmUserBulk Copy-OrchPmUser Get-OrchPmRobotAccount Set-OrchPmRobotAccount Copy-OrchPmRobotAccount Remove-OrchPmRobotAccount Get-OrchPmGroup Add-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

- When an SSL error, such as the absence of an installed certificate, occurs, the process can now continue by ignoring the error. To ignore SSL errors, add the following to the PSDrive in the configuration file:
 "IgnoreSslErrors": true

- The Add-OrchFolderUser cmdlet now displays an appropriate message if it fails to retrieve roles.

- The Copy-Item and Copy-OrchFolderMachine cmdlets now display an appropriate message if a machine with the same name is already assigned to the destination folder.

- Some operations failed when the target Orchestrator version was outdated. These issues have been resolved, and the cmdlets now handle operations appropriately based on the API version. The correspondence between cmdlets and API versions is as follows:

 - Add-OrchQueue:
   - ApiVer <  16: Does not set RetentionAction and RetentionPeriod, and Calls POST /odata/QueueDefinitions
   - ApiVer >= 16: Sets RetentionAction and RetentionPeriod, and Calls POST /odata/QueueDefinitions/UiPath.Server.Configuration.OData.CreateQueue

 - Get-OrchProcess -ExpandDetails, Update-OrchProcess, Copy-OrchProcess, Copy-Item:
   - ApiVer <  17: Does not call GET /odata/ReleaseRetention({releaseId})
   - ApiVer >= 17: Calls GET /odata/ReleaseRetention({releaseId})

 - Add-OrchProcess, Copy-Item:
   - ApiVer <  17: Calls POST /odata/Releases
   - ApiVer >= 17: Calls POST /odata/Releases/UiPath.Server.Configuration.OData.CreateRelease

 - Get-OrchTestCase, Get-OrchTestSet, Get-OrchTestSetSchedule, Get-OrchTestSetExecution:
   - ApiVer <  18: No action is taken.
   - ApiVer >= 18: Retrieve entities.