PowerShell cmdlets for Orchestrator

PowerShell provider and cmdlets for managing Orchestrator.

This PowerShell module enables you to mount multiple Orchestrator tenants as PSDrives, allowing you to navigate through their folders using commands like cd, dir, mkdir, rmdir within the pwsh console. Beyond simple folder navigation, it facilitates the manipulation of various entities through a range of cmdlets and wildcards. Notably, this module functions even in environments where Studio/Assistant is not installed.

Please be aware that this module is still in development and has not undergone comprehensive testing.

How to Install

1. Install PowerShell 7.x

https://learn.microsoft.com/ja-jp/powershell/scripting/install/installing-powershell-on-windows

2.   Install UiPathOrch in pwsh console

PS>Set-ExecutionPolicy bypass -Scope CurrentUser

PS>Install-Package UiPathOrch

3.   Import UiPathOrch in pwsh console

PS>Import-Package UiPathOrch

4.   Create external app in Orchestrator admin page and fill the config file.

5.   Reopen pwsh console and import the module again.

PS>Import-Package UiPathOrch

Now you can use Orch1: drive to manage Orchestrator.

Detailed install steps are explained in the PDFs attached in this page.

Documents

The PDF files attached here are included with the PowerShell module UiPathOrch and are updated as necessary. Therefore, we recommend referring to the PDFs included with UiPathOrch once you have installed it.

Folders

• Browse, new, remove, and move modern folders
• Browse and remove classic folders

Library Packages

• Get Library Packages’ Names and Versions in the tenant's Library feed
• Remove Library Packages

Process Packages

• Get the Tenant's Package Feed and the Process Package Names and Versions in the Folder with the Feeds
• Remove Process Packages
• Update the process packages assigned to a folder to the latest version
• Update Process Packages Assigned to a folder to a Specific Version
• Rollback a Process Package Assigned to a folder to a Previous Version

Licenses

• Get Named User License
• Get Runtime License
• Enable/Disable Runtime License

Jobs

• Open Job details in the Browser
• Remove Jobs in Each Folder
• Start and Stop/Kill Jobs
• Get logs for each Job

Job Recordings

• Get Job Recordings
• Remove Job Recording

Roles

• Get and Remove Roles
• Get what permissions a role includes
• Copy roles across tenants
• Users
• Get and Remove Tenant Users
• Add (assign) and Remove (unassign) users to/from folders
• Add and Remove roles to/from folder users
• Get the current user connected to the tenant in the current PowerShell session
• Update the current user's password for the Unattended Robot

Assets

• Get, Add, Update, and Remove Assets
• Get, Add, Update, and Remove credential assets (credential store can be specified)
• Add, Update, and remove per-user and per-machine assets/credential assets
• Importing/exporting CSV file
• Get and Remove Credential Stores

Queues

• Get and Remove Queues
• Get Queue Items

Triggers

• Get and Remove Triggers in folders
• Enabling and disabling triggers

Tests

• Get Test Sets, Test Cases, and Test Executions

Misc

• Get Robots
• Get Audit logs
• Get Alerts