uipath-dev - UiPath.PowerShell 20.12.1.5
An easy to use PowerShell API client for UiPath Orchestrator
PM> Install-Package UiPath.PowerShell -Version 20.12.1.5 -Source https://www.myget.org/F/uipath-dev/api/v3/index.json
> nuget.exe install UiPath.PowerShell -Version 20.12.1.5 -Source https://www.myget.org/F/uipath-dev/api/v3/index.json
> dotnet add package UiPath.PowerShell --version 20.12.1.5 --source https://www.myget.org/F/uipath-dev/api/v3/index.json
source https://www.myget.org/F/uipath-dev/api/v3/index.json
nuget UiPath.PowerShell ~> 20.12.1.5
Copy to clipboard
> choco install UiPath.PowerShell --version 20.12.1.5 --source https://www.myget.org/F/uipath-dev/api/v2
Import-Module PowerShellGet
Register-PSRepository -Name "uipath-dev" -SourceLocation "https://www.myget.org/F/uipath-dev/api/v2"
Install-Module -Name "UiPath.PowerShell" -RequiredVersion "20.12.1.5" -Repository "uipath-dev"
Copy to clipboard
UiPath Orchestrator PowerShell library
A PowerShell library for interacting with UiPath Orchestrator.
PS C:\>Install-PackageProvider -Name NuGet -Force
PS C:\>Register-PSRepository -Name UiPath -SourceLocation https://www.myget.org/F/uipath-dev/api/v2
PS C:\>Install-Module -Repository UiPath -Name UiPath.Powershell -Force
PS C:\>Import-Module UiPath.PowerShell
Login to UiPath Automation Cloud using interactive login
PS C:\>Get-UiPathAuthToken -Session
Login to UiPath Automation Cloud using API keys
PS C:\>Get-UiPathAuthToken -Session -ClientId <your_client_id> -UserKey <your_user_key>
#Login to your on-premise deployed Orchestrator
PS C:\>Get-UiPathAuthToken -Session -URL <orchestrator_url> -Username <username> -Password <password>
Using the UiPath.PowerShell module
The full documentation is in docs
Use the PowerShell Get-Command
to obtain all cmdlets exported by the module:
PS C:\>Get-Command -Module UiPath.PowerShell
You can obtain each command syntax using PowerShell's own Get-Help
:
PS C:\>Get-Help Add-UiPathRobot
To start using the library, you need to connect first to a running Orchestrator instance. Use the Get-UiPathAuthToken
cmdlet:
PS C:\>Get-UiPathAuthToken -URL <orchestratorurl> -Username <OrchestratorUser> -Password <password> -Session
To connect to an Orchestrator instance using integrated AD and SSO, use the -WindowsCredentials
argument to obtain the token. The library will authenticate to Orchestrator as the Windows user running the PowerShell session:
PS C:\>Get-UiPathAuthToken -URL <orchestratorurl> -WindowsCredentials -Session
The -Session
flag makes the authentication persist on the PowerShell session for up to 30 minutes. After this you will not have to authenticate again each cmdlet. Some examples:
Use Get-UiPathAuthToken ... -TenantName <tenantName>
for multi-tenant Orchetsrator deployments.
Use Get-UiPathAuthToken ... -OrganizationUnit <OUName>
for Orchetsrator deployments with OrganizationUnits enabled.
If you don't specify any argument, the authentication will be an interactive authentication with the UiPath Cloud service.
PS C:\> Get-UiPathRobot | Format-Table
Id LicenseKey MachineName Name Description
-- ---------- ----------- ---- -----------
132 RERUSANU PwdRobot1
133 RERUSANU PwdRobot2
134 RERUSANU PwdRobot3
For more example, see the docs
Getting Started
Automated install
Register the UiPath Gallery as a NuGet module provider
The UiPath.PowerShell module can be installed as a NuGet package. You will need to run once these commands first:
PS C:\>Install-PackageProvider -Name NuGet -Force -Scope CurrentUser
PS C:\>Register-PSRepository -Name UiPath -SourceLocation https://www.myget.org/F/uipath-dev/api/v2
Note that in the example above the use of -Scope CurrentUser
means that the NuGet package provider is registered only for the current user. This does not require administrative privilegs, but the registration is transient. You may opt instead to run from an elevated prompt and remove the -Scope CurrentUser
for a permanent registration.
You can validate that the NuGet package provider and the UiPath Gallery repository are registered:
PS C:\>Get-PackageProvider -Name NuGet
Name Version DynamicOptions
---- ------- --------------
NuGet 2.8.5.208 Destination, ExcludeVersion, Scope, SkipDependencies, Headers, FilterOnTag...
PS C:>Get-PSRepository
Name InstallationPolicy SourceLocation
---- ------------------ --------------
PSGallery Untrusted https://www.powershellgallery.com/api/v2
UiPath Untrusted https://www.myget.org/F/uipath-dev/api/v2
Install the UiPath.PowerShell module using the UiPath repository
PS C:\>Install-Module -Repository UiPath -Name UiPath.Powershell -Force -Scope CurrentUser
PS C:\>Import-Module UiPath.PowerShell
This command will download, install and import the UiPath.PowerShell module. Again, you can opt to use a global scope by removing the -Scope CurrentUser
argument, but this will require running the command an elevated prompt.
You can validate that the module was downloaded, installed and loaded:
PS c:\>Get-Module UiPath.PowerShell
ModuleType Version Name ExportedCommands
---------- ------- ---- ----------------
Binary 18.3.2.... UiPath.PowerShell {Add-UiPathAsset, Add-UiPathEnvironment, Add-UiPathEnviron...
Manual Install
Download the package from https://www.myget.org/feed/uipath-dev/package/nuget/UiPath.PowerShell, extract the content, and then run:
PS c:\>Import-Module UiPath.PowerShell.dll
License
This project is copyright UiPath INC and licensed under the MIT License - see the LICENSE.md file for details.
Prerequisites for building from source
To build the project, In addition to the C# SDK (the solution is Visual Studio 2017 based) you will need autorest. To use the library you won't need anything but the build artifacts.
- .NETStandard 2.0: 2.0.0.0
OwnersAlessandro Muresan ddpana |
AuthorsUiPath |
Project URLhttps://github.com/uipath/orchestrator-powershell |
LicenseMIT |
TagsPSModule |
Info303994 total downloads |
188 downloads for version 20.12.1.5 |
Download (3.29 MB) |
Found on the current feed only |
Package history
Version | Size | Last updated | Downloads | Mirrored? | |||
---|---|---|---|---|---|---|---|
20.12.1.15 | 2.13 MB | Mon, 20 Sep 2021 09:15:09 GMT | 80135 | ||||
20.12.1.14 | 2.13 MB | Mon, 20 Sep 2021 08:14:56 GMT | 187 | ||||
20.12.1.11 | 2.13 MB | Fri, 17 Sep 2021 17:48:58 GMT | 38 | ||||
20.12.1.10 | 3.29 MB | Fri, 08 Jan 2021 15:27:38 GMT | 34698 | ||||
20.12.1.9 | 3.29 MB | Mon, 14 Dec 2020 16:13:02 GMT | 4464 | ||||
20.12.1.8 | 3.29 MB | Fri, 11 Dec 2020 09:31:27 GMT | 630 | ||||
20.12.1.5 | 3.29 MB | Thu, 10 Dec 2020 16:02:33 GMT | 188 | ||||
20.12.1.4 | 3.29 MB | Thu, 10 Dec 2020 15:47:49 GMT | 8 | ||||
20.12.1.3 | 3.29 MB | Thu, 10 Dec 2020 15:47:41 GMT | 20 | ||||
20.4.2.13 | 3.3 MB | Fri, 27 Nov 2020 13:39:14 GMT | 2971 | ||||
20.4.2.11 | 3.3 MB | Mon, 09 Nov 2020 19:06:20 GMT | 4246 | ||||
20.4.2.10 | 2.83 MB | Mon, 09 Nov 2020 18:58:49 GMT | 4 | ||||
20.4.2.5 | 2.83 MB | Sun, 01 Nov 2020 09:26:32 GMT | 2106 | ||||
20.4.2.4 | 2.83 MB | Sun, 01 Nov 2020 08:38:08 GMT | 5 | ||||
20.4.2.3 | 2.83 MB | Sun, 01 Nov 2020 08:35:51 GMT | 3 | ||||
20.4.2.2 | 2.83 MB | Sun, 01 Nov 2020 08:35:22 GMT | 4 | ||||
20.4.2.1 | 2.83 MB | Sun, 01 Nov 2020 06:43:48 GMT | 5 | ||||
20.4.1.5 | 2.83 MB | Sat, 31 Oct 2020 21:24:49 GMT | 145 | ||||
20.4.1.2 | 2.83 MB | Tue, 06 Oct 2020 10:52:37 GMT | 7396 | ||||
20.4.0.26 | 5.93 MB | Fri, 02 Oct 2020 08:41:00 GMT | 855 | ||||
20.4.0.24 | 5.92 MB | Fri, 02 Oct 2020 06:23:05 GMT | 9 | ||||
20.4.0.21 | 5.92 MB | Mon, 14 Sep 2020 10:24:19 GMT | 5283 | ||||
20.4.0.20 | 5.92 MB | Tue, 28 Jul 2020 08:55:13 GMT | 14543 | ||||
20.4.0.18 | 5.92 MB | Wed, 15 Jul 2020 17:19:31 GMT | 3103 | ||||
20.4.0.15 | 5.92 MB | Fri, 26 Jun 2020 12:04:55 GMT | 7366 | ||||
20.4.0.14 | 5.91 MB | Fri, 26 Jun 2020 12:05:53 GMT | 9 | ||||
20.4.0.10 | 5.91 MB | Tue, 23 Jun 2020 11:23:04 GMT | 778 | ||||
20.4.0.8 | 5.91 MB | Tue, 23 Jun 2020 10:46:37 GMT | 11 | ||||
20.2.0.56 | 5.32 MB | Fri, 19 Jun 2020 19:21:55 GMT | 1186 | ||||
20.2.0.55 | 5.32 MB | Fri, 19 Jun 2020 18:51:47 GMT | 7 | ||||
20.2.0.53 | 5.32 MB | Fri, 19 Jun 2020 18:27:04 GMT | 14 | ||||
20.2.0.29 | 6.67 MB | Wed, 10 Jun 2020 13:26:46 GMT | 2356 | ||||
20.2.0.27 | 6.67 MB | Wed, 10 Jun 2020 12:54:54 GMT | 19 | ||||
20.2.0.18 | 6.61 MB | Fri, 29 May 2020 07:20:55 GMT | 3012 | ||||
20.2.0.14 | 6.61 MB | Thu, 16 Apr 2020 13:54:31 GMT | 54936 | ||||
20.2.0.13 | 6.61 MB | Thu, 09 Apr 2020 09:29:08 GMT | 901 | ||||
20.2.0.11 | 6.61 MB | Wed, 08 Apr 2020 10:23:05 GMT | 144 | ||||
19.10.0.13 | 7.44 MB | Wed, 26 Feb 2020 14:13:29 GMT | 3850 | ||||
19.10.0.11 | 7.43 MB | Mon, 13 Jan 2020 13:21:58 GMT | 5279 | ||||
19.10.0.6 | 7.43 MB | Fri, 22 Nov 2019 13:22:51 GMT | 4647 | ||||
19.4.0.41 | 7.39 MB | Fri, 01 Nov 2019 07:38:37 GMT | 5405 | ||||
19.4.0.38 | 6.39 MB | Thu, 10 Oct 2019 14:17:45 GMT | 8273 | ||||
19.4.0.35 | 6.39 MB | Thu, 03 Oct 2019 10:41:21 GMT | 2284 | ||||
19.4.0.33 | 6.39 MB | Thu, 26 Sep 2019 13:06:49 GMT | 4139 | ||||
19.4.0.31 | 4.39 MB | Sun, 22 Sep 2019 11:10:17 GMT | 1720 | ||||
19.4.0.27 | 6.39 MB | Mon, 09 Sep 2019 12:06:36 GMT | 5456 | ||||
19.4.0.25 | 6.39 MB | Thu, 05 Sep 2019 19:30:36 GMT | 1649 | ||||
19.4.0.24 | 6.39 MB | Thu, 05 Sep 2019 15:17:02 GMT | 23 | ||||
19.4.0.18 | 4.3 MB | Tue, 30 Jul 2019 02:01:48 GMT | 8126 | ||||
19.4.0.17 | 3.7 MB | Wed, 10 Apr 2019 17:31:29 GMT | 17259 | ||||
19.4.0.15 | 3.7 MB | Wed, 10 Apr 2019 14:55:03 GMT | 17 | ||||
19.4.0.13 | 3.7 MB | Wed, 10 Apr 2019 14:43:15 GMT | 12 | ||||
19.4.0.11 | 3.7 MB | Wed, 10 Apr 2019 12:55:16 GMT | 14 | ||||
19.4.0.6 | 2.03 MB | Wed, 10 Apr 2019 10:41:55 GMT | 13 | ||||
19.4.0.4 | 2.02 MB | Wed, 10 Apr 2019 10:16:22 GMT | 13 | ||||
19.4.0.2 | 2.02 MB | Wed, 10 Apr 2019 05:58:30 GMT | 16 | ||||
19.1.0.28 | 2.02 MB | Fri, 29 Mar 2019 20:57:39 GMT | 119 | ||||
19.1.0.24 | 2.02 MB | Tue, 05 Mar 2019 13:52:09 GMT | 417 | ||||
19.1.0.17 | 2.02 MB | Thu, 21 Feb 2019 11:45:59 GMT | 383 | ||||
19.1.0.11 | 2.02 MB | Wed, 13 Feb 2019 12:58:53 GMT | 549 | ||||
19.1.0.7 | 2.02 MB | Fri, 01 Feb 2019 17:00:14 GMT | 634 | ||||
19.1.0.2 | 2.02 MB | Tue, 22 Jan 2019 18:36:22 GMT | 525 | ||||
18.4.1.64221 | 1.76 MB | Fri, 21 Dec 2018 21:45:41 GMT | 587 | ||||
18.4.1.64219 | 1.76 MB | Sun, 16 Dec 2018 21:37:51 GMT | 309 | ||||
18.4.1.64217 | 1.76 MB | Sun, 16 Dec 2018 21:25:46 GMT | 11 | ||||
18.4.1.64215 | 2.57 MB | Wed, 12 Dec 2018 14:17:32 GMT | 204 | ||||
18.4.1.62303 | 2.57 MB | Tue, 11 Dec 2018 17:29:03 GMT | 33 | ||||
18.4.1.62252 | 2.57 MB | Tue, 11 Dec 2018 16:55:20 GMT | 14 | ||||
18.3.3.62246 | 2.57 MB | Tue, 11 Dec 2018 16:40:27 GMT | 17 | ||||
18.3.3.59650 | 2.54 MB | Fri, 07 Dec 2018 15:14:11 GMT | 141 | ||||
18.3.3.56444 | 2.03 MB | Tue, 04 Dec 2018 10:22:53 GMT | 50 | ||||
18.3.3.50596 | 2.03 MB | Mon, 03 Dec 2018 15:16:22 GMT | 21 |