Orchestrator にアセットをデプロイする

前提条件:

• Orchestrator にデプロイするアセットを含む CSV ファイルを作成します。

  CSV ファイルには、name、type、value、description の 4 つの列が必要です。

• CLI exe (Windows レガシの場合) または dll (Windows/Linux/macOS の場合) ファイルを実行します。

• 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。

CSV ファイルの詳細については、次の表の例をご覧ください。

name	type	value	説明
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

アセットを Orchestrator にデプロイするには、次の手順に従います。

1. uipcli assetを使用して、asset タスクを実行します。利用可能なサブタスクのリストが表示されます。
2. 必要なパラメーターを指定し、[ deploy ] サブタスクを実行します。次の表で、必要なパラメーターについて説明します。

パラメーター	説明
Assets File (pos. 0) (必須)	The name of the CSV file that contains the assets you want to deploy.
Orchestrator URL (pos. 1) (必須)	Orchestrator インスタンスの URL です。
Orchestrator Tenant (pos. 2)	The tenant of the Orchestrator instance where you want to deploy your assets. Required when targeting Automation Cloud. Optional for Automation Suite and standalone Orchestrator (on-premises MSI), where the tenant is part of the URL.
-u 、または --username ( 基本認証を使用する場合は必須、ユーザー名とパスワードを使用)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。
-p 、または --password ( 基本認証を使用する場合は必須、ユーザー名とパスワードを使用)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。
-t 、または--token ( トークンベースの認証 を使用する場合は 必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。
-a 、または--accountName ( トークンベースの認証 を使用する場合は 必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。
-A , or --accountForApp	Orchestrator Cloud RPA のアカウント名 (組織名) です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
-I または--applicationId ( 外部アプリケーション認証 を使用する場合は 必須 )	外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
-S または--applicationSecret ( 外部アプリケーション認証 を使用する場合は 必須 )	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。
--applicationScope ( 外部アプリケーション認証 の場合は 任意 )	アプリケーション スコープを単一のスペースで区切って列挙したリストです。任意: 外部アプリケーション認証を既定として使用する場合は、スコープが自動的に適用されます。外部アプリケーションの アプリケーション アカウント 、 アプリケーション ID 、 アプリケーション シークレット と組み合わせて使用する必要があります。
-o , or --organizationUnit	Orchestrator フォルダー (組織単位) の名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
-l , or --language	Orchestrator のユーザー インターフェイスで使用する言語です。
--traceLevel	イベントのトレースを表示します。
--identityUrl	The URL of your identity server. Required when the Orchestrator runs on UiPath Automation Suite or standalone Orchestrator (on-premises MSI). Not needed for Automation Cloud — the CLI resolves the identity server from the cloud URL.
--help	このコマンドのパラメーターと例を表示します。
--version	バージョン情報を表示します。
--ca-cert	Orchestrator と Identity Server の TLS 証明書を検証する際に使用される、1 つ以上の信頼されたルート CA 証明書ファイル (PEM、DER、または PKCS#7)。フラグを繰り返すか、複数のパスをコンマで区切ります。詳細については、「 カスタム証明書を信頼する 」をご覧ください。
--pinnedpubkey	サーバー リーフ証明書の公開キーをピン留めします。形式: sha256//<base64>です。標準の証明書検証に加えてチェックされます。詳細については、「 カスタム証明書を信頼する 」をご覧ください。

ヒント:

プライベート証明機関 (UiPath Automation Suite など) によって署名された Orchestrator インスタンスの場合、このコマンドは --ca-cert パラメーターと --pinnedpubkey パラメーターも受け付けます。シナリオと例については、「 カスタム証明書を信頼する 」をご覧ください。

注:

--applicationScope パラメーターを指定せずに外部アプリケーション認証を使用すると、CLI は以下の既定の Orchestrator スコープを自動的に適用します。

OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read

使用状況:

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 "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 "Information
• uipcli 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"