- Overview
- UiPath CLI
- About UiPath CLI
- Downloading UiPath CLI
- Compatibility matrix
- Running UiPath CLI
- Managing NuGet feeds
- About UiPath CLI tasks
- Packing projects into a package
- Analyzing a project
- Deploying a package to Orchestrator
- Running a job inside Orchestrator
- Testing a package or running a test set
- Testing multiple packages
- Deploying assets to Orchestrator
- Deleting assets from Orchestrator
- Running tasks using JSON configuration
- Restoring automation dependencies
- Troubleshooting UiPath CLI
- Azure DevOps extension
- Jenkins plugin
CI/CD integrations user guide
Deploying assets to Orchestrator
Prerequisites:
-
Create a CSV file that contains the assets that you want to deploy to Orchestrator.
The CSV file must have the following three columns:
name,type,value, anddescription. -
Run the CLI
exe(for Windows) ordll(for Linux) file. -
Add the required Orchestrator API access application scopes.
For more information about the CSV file, check the example in the following table.
| name | type | value | description |
|---|---|---|---|
| asset_1_name | text | "i have a comment" | asset_1_description |
| asset_2_name | integer | 1 | asset_2_description |
| asset_3_name | bool | false | asset_3_description |
| asset_4_name | credential | username:password | asset_4_description |
To deploy assets to Orchestrator, take the following steps:
- Run the
assettask, usinguipcli asset. You can notice a list of the available sub-tasks. - Specify the required parameters and run the
deploysub-task. The following table describes the required parameters.
| Parameter | Description |
|---|---|
-u , or --username ( Required if you use Basic Authentication , through a username and a password) | The username used for authenticating to Orchestrator. You must pair it with the corresponding password. |
-p , or --password ( Required if you use Basic Authentication , through a username and a password) | The password used for authenticating to Orchestrator. You must pair it with the corresponding username. |
-t , or --token ( Required if you use token-based authentication ) | The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID . |
-a , or --accountName ( Required if you use token-based authentication ) | The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID . |
-A , or --accountForApp | The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID , Application Secret , and Application scope for external application. |
-I , or --applicationId ( Required if you use external application authentication ) | The external Application Id. You must pair it with the Application Account , Application Secret , and Application scope . |
-S , or --applicationSecret ( Required if you use external application authentication ) | The external Application Secret. You must pair it with the Application Account , Application ID , and Application scope . |
--applicationScope ( Required if you use external application authentication ) | The list of application scopes, separated by single spaces. You must pair it with the Application Account , Application ID , and Application Secret for external application. |
-o , or --organizationUnit | The name of the Orchestrator folder (organization unit). AccountingTeam\TeamJohn . |
-l , or --language | The language used in the Orchestrator user interface. |
|
| Display the trace of the events. |
--identityUrl ( Required for PaaS or MSI deployments) | The URL of your identity server. |
|
| Displays the parameters and examples for this command. |
|
| Display version information. |
Assets File (pos. 0) ( Required ) | The name of the CSV file that contains the assets you want to delete. |
Orchestrator URL (pos.1) ( Required ) | The URL of the Orchestrator instance. |
|
| The tenant of the Orchestrator instance, where you want to manage your assets. |
Usage:
uipcli asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]uipcli asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]Minimal command examples:
uipcli asset deploy "C:\userprofile\assets.csv" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"uipcli asset deploy "C:\userprofile\assets.csv" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel "Information"uipcli asset deploy "C:\userprofile\assets.csv" "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Informationuipcli asset deploy "C:\userprofile\assets.csv" "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"
