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 Get-OrchUserPrivilege Add-OrchUser Update-OrchUser Copy-OrchUser Remove-OrchUser Remove-OrchRoleFromUser Get-OrchCurrentUser Update-OrchCurrentUserURPassword Get-OrchLicenseNamedUser Get-OrchLicenseRuntime Enable-OrchLicenseRuntime Disable-OrchLicenseRuntime Get-PmAuditLog Get-PmLicensedUser Get-PmLicensedGroup Remove-PmLicensedGroup Add-PmLicenseToPmLicensedGroup Remove-PmAllocationFromPmLicensedGroup Remove-PmLicenseFromPmLicensedGroup 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 Search-OrchDirectory Search-PmDirectory Resolve-PmDirectoryNameBulk Get-PmUser Update-PmUser Remove-PmUser New-PmUser Copy-PmUser Get-PmRobotAccount Set-PmRobotAccount Copy-PmRobotAccount Remove-PmRobotAccount Get-PmGroup New-PmGroup Copy-PmGroup Remove-PmGroup Get-PmGroupMember Add-PmGroupMember Move-PmGroupMember Remove-PmGroupMember Get-PmExternalApiResource Get-PmExternalApplication Copy-PmExternalApplication Remove-PmExternalApplication Get-DuRole Get-DuDocumentType Get-DuClassifier Get-DuExtractor Get-DuUser Add-DuUser Remove-DuRoleFromDuUser 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 Open-OrchLogLocation

Functions

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

Dependencies

This module has no dependencies.

Release Notes

- Added Copy-PmGroup and Copy-PmExternalApplication cmdlets.

- The following cmdlets are now available for copying organization entities. When all of these cmdlets are executed, the final set of entities created in the destination will be the same, regardless of the order in which the cmdlets are run:
 - Copy-PmUser
 - Copy-PmRobotAccount
 - Copy-PmExternalApplication
 - Copy-PmGroup

- All of these cmdlets share the same usage pattern. For example, the following command copies all local users from Orch1: to Orch2:

 PS Orch1:\> Copy-PmUser * Orch2: -WhatIf

 - If the output looks correct, remove the -WhatIf switch and run the command again.

 - Note: If Orch1: and Orch2: belong to the same organization, no action will be taken.

- Copy-PmUser, Copy-PmRobotAccount, and Copy-PmExternalApplication automatically add copied entities to groups with the same name in the destination. If no such group exists, one is automatically created.

- Copy-PmGroup automatically adds local users, robot accounts, external applications, directory users, and directory groups with the same name to the copied group. However, if such entities with the same names do not exist in the destination, they will not be created automatically.

- Added Remove-PmExternalApplication cmdlet.
 - Note: External applications currently in use for the UiPathOrch connection cannot be deleted unless the -Force switch is specified.

- Updated Remove-PmUser to prevent deletion of users currently used for connecting via non-confidential apps in UiPathOrch.

- Fixed an issue where New-OrchProcess did not work in environments using API versions earlier than 19. This issue was introduced in version 0.9.10.9.
 - Note: You can check the Web API version of the target Orchestrator using the Get-OrchPSDrive cmdlet.

- Triggers copied with Copy-OrchTrigger or Copy-Item are now always created as disabled, even if the source trigger is enabled.

- When using the Orch-UpdateUser cmdlet with parameters that modify ExecutionSettings (such as -ES_TracingLevel or -ES_StudioNotifyServer), the settings were previously applied only to the user's UnattendedRobot property. Now, the cmdlet also applies the same values to the user's RobotProvision property. Additionally, these property updates are no longer applied to users whose Type is DirectoryExternalApplication.