en-US/about_UiPathOrch.help.txt
|
TOPIC
about_UiPathOrch SHORT DESCRIPTION PSDrives and cmdlets for managing UiPath Orchestrator from PowerShell. LONG DESCRIPTION UiPathOrch mounts Orchestrator tenants as PSDrives, enabling you to navigate folders, manage entities, and perform bulk operations using familiar PowerShell commands. 312 cmdlets cover four API systems: Orch Orchestrator OData API (248 cmdlets) Pm Platform Management / Identity Server API (46 cmdlets) Du Document Understanding API (7 cmdlets) Tm Test Manager API (11 cmdlets) Test Sets and Test Cases live on two different backends, so the prefix matters: Orch* test cmdlets (Get-OrchTestSet, Start-OrchTestSet, Get-OrchTestCase, ...) target Orchestrator's test-execution API (test sets/cases run inside folders), while Tm* cmdlets (Get-TmTestSet, Get-TmTestCase, Get-TmRequirement, ...) target the Test Manager API (Test Manager projects, requirements, and their artifacts). Pick the prefix that matches the product surface you are working in. KEY FEATURES - Mount multiple tenants simultaneously, each as a separate drive. - Navigate Orchestrator folder hierarchy with cd, dir, mkdir, rmdir. - Supports Automation Cloud and on-premises Orchestrator. - Bulk operations with wildcards and comma-separated values. - Cross-folder operations with -Path, -Recurse, and -Depth. - Tab completion for all parameter values (folder names, user names, asset names, etc.) via [Tab] or [Ctrl+Space]. - Parallel requests and in-memory caching for fast execution. - -WhatIf and -Confirm for safe destructive operations. - CSV export/import for bulk provisioning workflows. GETTING STARTED Step 1: Install the module Install-PSResource UiPathOrch Step 2: Set up credentials for your Orchestrator Register an external application (non-confidential or confidential) in the Orchestrator admin page, or prepare a Personal Access Token or username/password for older on-premises instances. See AUTHENTICATION TYPES below for details. Step 3: Configure Import-OrchConfig On first run the configuration file opens in Notepad. Fill in the drive name, Orchestrator URL, and authentication credentials. Save and run Import-OrchConfig again to mount the drive. Step 4: Connect cd Orch1: dir For full setup instructions, run: Get-OrchHelp CONFIGURATION FILE LOCATION Get-OrchConfigPath reports the configuration file in effect. By default it lives in the per-user module folder. Set the UIPATHORCH_CONFIG_PATH environment variable to read it from somewhere else - a network share, for example, so that several machines share one set of drive definitions: $env:UIPATHORCH_CONFIG_PATH = '\\fileserver\rpa\UiPathOrchConfig.json' Either the file or the folder holding it may be given - '\\fileserver\rpa' means the same thing. The value is read as a file first, and as a folder containing UiPathOrchConfig.json only if no file is there. Set it in $PROFILE, or as a user or system environment variable, so that it is in place before the module loads. Use a UNC path: a mapped drive letter is not visible to services, scheduled tasks, or another logon session. To switch files inside a running session: Import-OrchConfig -ConfigPath \\fileserver\rpa\UiPathOrchConfig.json That sets the same variable for the current process only; nothing is written to the persistent environment. The module only reads this file, so a read-only share works and several machines can use one file at once. The file does hold credentials in plain text, so a file shared between people should define only drives that authenticate interactively. Environment variables read by the module: UIPATHORCH_CONFIG_PATH Configuration file location. UIPATHORCH_SUPPRESS_CONFIG_CREATION Set to 1 to stop the module creating and opening a default configuration file when none exists. AUTHENTICATION TYPES Non-Confidential App Interactive login required, no app secret. Recommended for interactive use. Confidential App App secret required, no interactive login. For unattended scripts. Some user-info commands (e.g. Get-OrchCurrentUser) are not available. Personal Access Token Token-based authentication without OAuth app registration. On-Premises Supports Identity Server and legacy username/password authentication. NAVIGATING PSDRIVE UiPathOrch is a PowerShell provider. Orchestrator folders appear as a file system. cd Orch1:\ Go to root folder cd Shared Go to subfolder cd .. Go to parent folder dir List subfolders dir -Recurse List all subfolders recursively ii . Open current folder in browser Tenant-level entities (users, machines, libraries) appear in the root folder. Folder-level entities (processes, jobs, assets, queues, triggers) appear in each folder. MANAGING FOLDERS Folders are the provider's items, so the standard *-Item cmdlets work: New-Item Orch1:\Shared\Sub -ItemType Directory Create a folder Rename-Item Orch1:\Shared\Sub NewName Rename in place Move-Item Orch1:\A\Sub Orch1:\B Move under another folder Copy-Item Orch1:\A Orch1:\B -Recurse Copy a folder subtree Remove-Item Orch1:\Shared\Sub Delete (prompts if not empty) Set, read, or clear a folder's Description with the *-ItemProperty cmdlets (DisplayName is read-only here; change it with Rename-Item): Set-ItemProperty Orch1:\Shared -Name Description -Value 'Team folder' Get-ItemProperty Orch1:\Shared -Name Description Clear-ItemProperty Orch1:\Shared -Name Description Rename-Item renames in place and does not move: a -NewName containing a path (for example ..\Other) is rejected -- use Move-Item to move. FOLDER SCOPE PARAMETERS Most cmdlets accept these parameters to target specific folders: -Path Target folder (wildcards and comma-separated values) -Recurse Include all subfolders -Depth Limit subfolder depth Specify these BEFORE other parameters so that tab completion for subsequent parameters uses the correct folder context. WILDCARD AND BULK OPERATIONS You can target multiple entities using wildcards and comma-separated names in positional parameters: Get-OrchAsset Config* Get-OrchUser a*,y* Remove-OrchAsset old_* -WhatIf CACHE BEHAVIOR Standard cmdlets cache results after the first call. Subsequent calls return cached data instantly. Volume cmdlets (Get-OrchJob, Get-OrchQueueItem, Get-OrchLog) query the server when filter parameters are specified. To force a refresh: Clear-OrchCache ESSENTIAL COMMANDS Import-OrchConfig Load configuration and mount drives Edit-OrchConfig Open configuration file in editor Get-OrchPSDrive Show connected drives and scopes Get-OrchCurrentUser Verify authenticated user Clear-OrchCache Clear cached data Get-OrchHelp Show documentation summary Switch-OrchCurrentUser Sign in with a different account Get-Help <CmdletName> -Full Detailed cmdlet help Get-Help <CmdletName> -Examples Usage examples Get-Command -Module UiPathOrch List all cmdlets EXAMPLES Example 1: List assets across all folders PS Orch1:\> Get-OrchAsset -Recurse | Select-Object Path, Name, Value Example 2: Start a job with preview PS Orch1:\Shared> Start-OrchJob MyProcess -WhatIf Example 3: Export users to CSV PS Orch1:\> Get-OrchUser | Export-Csv c:\users.csv Example 4: Work across multiple tenants PS> $drives = (Get-PSDrive -PSProvider UiPathOrch).Name | ForEach-Object { "$_`:\" } PS> Get-OrchProcess -Recurse -Path $drives Example 5: Programmatic tab completion (for scripts and AI agents) PS> (TabExpansion2 'Get-OrchAsset -Path Orch1:\ -Name ').CompletionMatches TROUBLESHOOTING Connection issues Clear-OrchCache; retry the operation. Permission errors Check Get-OrchUserPrivilege and Get-OrchFolderUser. Drive mount issues Edit-OrchConfig; then Import-OrchConfig. Confidential app errors Normal for user-info commands. Use Get-OrchPSDrive to verify connection. Entra ID warning Use Switch-OrchCurrentUser to sign in via Entra ID. NOTE PowerShell 7.x is required. UiPath Assistant is not required. For comprehensive documentation including migration guides, CSV workflows, and troubleshooting details, run Get-OrchHelp and refer to the Docs folder. SEE ALSO Get-OrchHelp Folder Operations (cd, New-Item, Move/Copy, Set-ItemProperty Description): https://github.com/UiPath-Services/UiPathOrch/blob/master/docs/03-FolderOperations.md https://marketplace.uipath.com/listings/uipathorch https://www.powershellgallery.com/packages/UiPathOrch KEYWORDS UiPath Orchestrator PSDrive Automation |