UiPathOrch

Author(s)

• Yoshifumi Tsuda

Tags

UiPath Orchestrator RPA Automation PSDrive PSProvider Cloud OnPremises

Cmdlets

Import-OrchConfig New-OrchPSDrive Invoke-OrchApi Switch-OrchCurrentUser Get-OrchPSDrive Get-OrchProductVersion Resolve-OrchAuthError Get-OrchLibrary Get-OrchLibraryVersion Get-OrchLibraryDependency Remove-OrchLibrary Import-OrchLibrary Export-OrchLibrary Copy-OrchLibrary Get-OrchPackage Copy-OrchPackage Get-OrchPackageVersion Get-OrchPackageDependency Get-OrchPackageWorkflow Remove-OrchPackage Import-OrchPackage Export-OrchPackage Get-OrchJob Start-OrchJob Stop-OrchJob Restart-OrchJob Resume-OrchJob Open-OrchJob Get-OrchLog Get-OrchAuditLog Get-OrchJobMedia Export-OrchJobMedia Remove-OrchJobMedia Get-OrchProcess Get-OrchProcessDetail Get-OrchProcessDependency Get-OrchProcessWorkflow New-OrchProcess Update-OrchProcess Copy-OrchProcess Compare-OrchProcess Remove-OrchProcess Edit-OrchProcess Update-OrchProcessVersion Reset-OrchProcessVersion Get-OrchProcessRequirement Get-OrchRobot Get-OrchUser Compare-OrchUser Get-OrchUserDetail 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-PmAuthenticationSetting Get-PmLicense Get-PmLicenseAllocation Set-PmLicenseAllocation Get-PmLicenseProductAllocation Get-PmLicenseServiceAllocation Get-PmLicenseInventory Get-PmLicenseContract Get-PmGroupLicense Add-PmGroupLicense Remove-PmGroupLicense Remove-PmGroupLicenseAllocation Remove-PmLicensedGroup Get-PmUserLicense Add-PmUserLicense Remove-PmUserLicense Remove-PmLicensedUser Get-OrchClassicRobot Get-OrchClassicEnvironment Get-OrchUserSession Get-OrchMachineSession Get-OrchUnattendedSession Clear-OrchInactiveSession Get-OrchTask Get-OrchTaskAcrossFolder Set-OrchTask Remove-OrchTask Enable-OrchMaintenanceMode Disable-OrchMaintenanceMode Get-OrchJobStats Get-OrchLicenseStats Get-OrchRole Set-OrchRole Remove-OrchRole Copy-OrchRole Compare-OrchRole Get-OrchCalendar Remove-OrchCalendar Copy-OrchCalendar Compare-OrchCalendar Get-OrchCalendarDate Add-OrchCalendarDate Remove-OrchCalendarDate Get-OrchPersonalWorkspace Remove-OrchPersonalWorkspace Get-OrchFolderUsage Get-OrchFolderUser Compare-OrchFolderUser Add-OrchFolderUser Copy-OrchFolderUser Move-OrchFolderUser Remove-OrchFolderUser Add-OrchRoleToFolderUser Remove-OrchRoleFromFolderUser Get-OrchMachine Update-OrchMachine New-OrchMachine Remove-OrchMachine Copy-OrchMachine Compare-OrchMachine Get-OrchMachineClientSecretId Add-OrchMachineClientSecret Remove-OrchMachineClientSecret Get-OrchFolderMachine Compare-OrchFolderMachine Add-OrchFolderMachine Copy-OrchFolderMachine Remove-OrchFolderMachine Enable-OrchFolderMachineInherit Disable-OrchFolderMachineInherit Get-OrchFolderMachineAccountMapping Enable-OrchFolderMachineAccountMapping Disable-OrchFolderMachineAccountMapping Get-OrchAsset Set-OrchAsset Copy-OrchAsset Compare-OrchAsset Move-OrchAsset Remove-OrchAsset Set-OrchCredentialAsset Get-OrchCredentialAsset Set-OrchSecretAsset Get-OrchSecretAsset Remove-OrchAssetUserValue Get-OrchCredentialStore Copy-OrchCredentialStore Compare-OrchCredentialStore Update-OrchCredentialStore Remove-OrchCredentialStore Get-OrchAssetLink Add-OrchAssetLink Remove-OrchAssetLink Get-OrchBucketLink Add-OrchBucketLink Remove-OrchBucketLink Get-OrchQueueLink Add-OrchQueueLink Remove-OrchQueueLink Get-OrchTrigger Get-OrchTriggerDetail New-OrchTrigger Update-OrchTrigger Remove-OrchTrigger Copy-OrchTrigger Compare-OrchTrigger Enable-OrchTrigger Disable-OrchTrigger Test-OrchTrigger Get-OrchApiTrigger New-OrchApiTrigger Update-OrchApiTrigger Remove-OrchApiTrigger Copy-OrchApiTrigger Compare-OrchApiTrigger Enable-OrchApiTrigger Disable-OrchApiTrigger Get-OrchEventTrigger Compare-OrchEventTrigger Remove-OrchEventTrigger Enable-OrchEventTrigger Disable-OrchEventTrigger Get-OrchQueue New-OrchQueue Update-OrchQueue Copy-OrchQueue Compare-OrchQueue Move-OrchQueue Remove-OrchQueue Get-OrchQueueItem Import-OrchQueueItem Redo-OrchQueueItem Copy-OrchQueueItem Remove-OrchQueueItem Get-OrchTestSet Compare-OrchTestSet Get-OrchTestSetDetail New-OrchTestSet Copy-OrchTestSet Remove-OrchTestSet Start-OrchTestSet Get-OrchTestCase Get-OrchTestCaseExecution Get-OrchTestCaseAssertion Remove-OrchTestCase Get-OrchTestSetExecution Stop-OrchTestSetExecution Get-OrchTestSetSchedule Compare-OrchTestSetSchedule New-OrchTestSetSchedule Update-OrchTestSetSchedule Copy-OrchTestSetSchedule Remove-OrchTestSetSchedule Enable-OrchTestSetSchedule Disable-OrchTestSetSchedule Get-OrchTestDataQueue Compare-OrchTestDataQueue New-OrchTestDataQueue Copy-OrchTestDataQueue Remove-OrchTestDataQueue Get-OrchTestDataQueueItem Import-OrchTestDataQueueItem Reset-OrchTestDataQueueItem Get-OrchAlert Get-OrchBucket New-OrchBucket Copy-OrchBucket Compare-OrchBucket Move-OrchBucket Update-OrchBucket Remove-OrchBucket Get-OrchBucketItem Copy-OrchBucketItem Export-OrchBucketItem Import-OrchBucketItem Remove-OrchBucketItem Get-OrchWebhook New-OrchWebhook Copy-OrchWebhook Compare-OrchWebhook Update-OrchWebhook Remove-OrchWebhook Enable-OrchWebhook Disable-OrchWebhook Get-OrchWebhookEventType Test-OrchWebhook Get-OrchSetting Set-OrchSetting Get-OrchExecutionSetting Get-OrchWebSetting Get-OrchAuthenticationSetting Get-OrchActivitySetting Get-OrchConnectionString Get-OrchLicense Get-OrchUpdateSetting Get-OrchActionCatalog Compare-OrchActionCatalog New-OrchActionCatalog Copy-OrchActionCatalog Remove-OrchActionCatalog Search-OrchDirectory Search-PmDirectory Resolve-PmDirectoryNameBulk Get-PmUser Update-PmUser Remove-PmUser New-PmUser Copy-PmUser Get-PmRobotAccount New-PmRobotAccount Set-PmRobotAccount Copy-PmRobotAccount Remove-PmRobotAccount Get-PmUserPreference Set-PmUserPreference Copy-PmUserPreference Get-PmNotificationSubscription Set-PmNotificationSubscription Copy-PmNotificationSubscription 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-PmAccessAllowedMember 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 Get-TmTestExecution Get-OrchHelp Clear-OrchCache Get-OrchConfigPath Edit-OrchConfig Set-OrchLocation Get-OrchLogLocation Open-OrchLogLocation New-OrchUserMappingCsv Test-OrchUserMappingCsv

Functions

Enable-OrchUserAttended Disable-OrchUserAttended Enable-OrchPersonalWorkspace Disable-OrchPersonalWorkspace Find-OrchFolderNoUserAssigned Get-OrchJobVideo Format-OrchQueueItem Format-OrchTestDataQueueItem

PSEditions

Core

Dependencies

This module has no dependencies.

Release Notes

1.19.1

Fixed: triggers keep their robot assignment on on-premises servers and Automation Suite. 1.19.0
read it from an expanded trigger listing that only Automation Cloud fills, so there
Get-OrchTriggerDetail showed no robots, -ExportCsv wrote none and Copy-Item copied triggers without
them. Get-OrchTriggerDetail is back to one request per trigger.

Fixed: Update-OrchTrigger no longer clears a trigger's robot assignment, which any update did since
1.0.0.

Fixed: a 401 from a service other than Orchestrator (Identity, for the Pm cmdlets on 20.10) no
longer makes the whole drive fail until Import-OrchConfig.

Fixed: copying the same process twice in a session keeps its entry point.

Fixed on 20.10: exported trigger rows name their robots; a trigger priority is sent as Low / Normal
/ High; Copy-Item copies local-account folder users; Add-OrchFolderUser -Type User / Robot assigns
local accounts.

Changed: Get-OrchProcessDetail reads entry point paths from the listing, one request fewer per
process; Get-OrchTestSetDetail prints each folder as it arrives.

1.19.0

Added: Get-OrchProcessDependency and Get-OrchProcessWorkflow read the dependencies and the .xaml
files of the package a process runs -- the "Explore package" view, which Orchestrator has no
endpoint for, so the package is downloaded once and only the two lists are kept.
-Dependency takes wildcards: -Recurse -Dependency 'UiPath.UIAutomation*' names every process using
that activity package. Get-OrchPackageDependency, Get-OrchPackageWorkflow and
Get-OrchLibraryDependency ask the same of a feed package or a library.

Changed: Remove-OrchPackage names the processes that block a delete, after Orchestrator's own
"referred in active processes" refusal.

Changed: Get-OrchTriggerDetail reads a folder in one request (200 triggers: 401 requests and 25.6 s
became 1 and 0.32 s), and ExecutorRobots carries the robots' names. Get-OrchProcessDetail skips the
retention request when the release detail already has it (API 19+) and caches retention;
Get-OrchTestSetDetail fetches in parallel and caches. Rows from parallel reads appear as they
arrive instead of mostly at the end.

Changed: progress bars have a fixed noun label, with the destination inside the bar, and nested
bars are shown under the bar they belong to. Copy-Item's folder bar counts folders.

Fixed: one Ctrl+C stops Copy-Item, where it used to begin the next folder.

Fixed: tables grouped by Path no longer clip later rows to the width of a folder's first row.

1.18.0

Added: Set-PmLicenseAllocation allocates robot runtimes and consumable units to one tenant
(-AppTestRobot, -PlatformUnits, -ScreenPlayRuns, ..., or -Products @{ CODE = qty }). The API
replaces a service's whole allocation, so the cmdlet re-sends the tenant's current codes with the
requested ones overlaid; a code it cannot place in a service is reported, never guessed.

Added: Get-PmLicenseProductAllocation reports one tenant's allocation per product code, including
the codes at 0, and Get-PmLicenseServiceAllocation groups it by the service that grants each code
-- the codes one write re-sends together.

Added: New-OrchMachine and Update-OrchMachine can set every runtime slot the API models:
-AppTestSlots (the App Testing runtime Test Cloud application testing runs on), -HostingSlots,
-HeadlessSlots, -PerformanceTestSlots, -AgentSlots, -FunctionSlots, -AutomationCloudSlots and
-AutomationCloudTestAutomationSlots. The four newest are refused on an older server with a message
naming the version. Nothing else is pre-empted: probing a 21.10.4 server (Web API 13.0) showed the
inherited "introduced in" notes wrong in both directions.

Changed: when the machine PATCH endpoint answers "machineDto must not be null", naming nothing, a
warning beside the untouched error lists the properties the request set and the server's version.

Fixed: the Pm* license cmdlets work on Automation Suite, which their help denied.

Fixed: drive-scoped warnings quote their target, so a drive name's own colon no longer runs into
the one the sentence needs ("local:\:").

1.17.0

With the August 3, 2026 Automation Cloud release, UiPath made OpenAPI 3.0 the Orchestrator API
description: /orchestrator_/openapi/public.json is now the default, and the Swagger 2.0 document
(/swagger/v20.0/swagger.json) is deprecated from that release and removed in September 2026
(Automation Suite: 2.2610). The OpenAPI document still describes Web API 20.0, yet it differs from
the October 2025 snapshot of the v20 swagger, and this release follows it where the change is
visible to the module. Every change leaves a drive on Web API 11-19 doing exactly what it did:
new fields are stripped before a write to such a server, new parameters are refused there with a
message naming the version, and the notices stay silent.

Added: Set-OrchAsset -ValueType Json creates and updates the Json asset type the v20 document
introduced. -Value is the JSON text, checked for well-formedness before anything is sent; the
server echoes it in Value, so Get-OrchAsset, its CSV export and the CSV round-trip need nothing
new. A drive below v20 refuses the type with a message naming the drive and its version.

Added: Stop-OrchJob -BatchExecutionKey stops every job of one Start-OrchJob batch in a single
request, and Get-OrchTaskAcrossFolder -JobKey narrows the cross-folder task list to the tasks one
job raised (the value is the job's Key, as Get-OrchLog -JobKey already takes it, with the same tab
completion). Both need v20.

Added: the entities carry the fields the v20 document added (Machine.FunctionSlots and
MachineSettings, Release.RuntimeProfile, Job.FolderKey / TargetRuntime / CreatorUser, the
trigger's BindingKey, Asset.ValueJsonSchema and a few read-only ones); writes below v20 strip them.

Changed: Invoke-OrchApi -Uri completion follows the OpenAPI document. The 14 endpoints it adds
(GetByKey on Jobs, Releases, Buckets and Users, GetProcessVersion, /api/Assets/name/{name}/value,
the VideoRecording API) are offered on v20 tenants; the 13 it dropped (the classic-robot
/odata/Robots({key}) family, ToggleEnabledStatus, /odata/OrganizationUnits, ...) are no longer
offered there and stay offered on v11-v19 drives, where they still exist.

Changed: user and test-set reads no longer $expand the classic-folder navigations
OrganizationUnits and Environment on v20, where the document dropped them -- the way
ReleaseDto.Environment went before, which a 26.3 server already refuses. v20 has no classic
folders, so nothing is lost.

Changed: the Test* cmdlets say once per drive that Orchestrator has deprecated its Test
Automation API in favour of Test Manager. They keep working; Clear-OrchCache resets the notice.