uip or licenses

「uip or licenses」の構文とオプション - ランタイムおよび指定ユーザーに対する Orchestrator のライセンス割り当てを検査および管理します。

uip or licenses Orchestrator のライセンス割り当てを検査および管理します。ランタイム ライセンスと Named User ライセンスの割り当てのリストを表示し、マシン ライセンスのオン/オフを切り替えて、テナント ライセンスの全体的な概要を表示します (ロボットの種類ごとに許可または使用されます)。

概要

uip or licenses <verb> [options]

動詞

動詞	目的
list	特定のロボットの種類 (ランタイムまたは名前付きユーザー) に対するライセンスの割り当てのリストを取得します。
toggle	特定の種類のランタイム ロボットに対してマシン ライセンスを有効化または無効化します。
info	テナントのライセンスの概要 (サブスクリプション プラン、許可/使用される機能) を表示します。

ロボットの種類の参照

--type フラグは、次の種類のロボットを受け入れます。コマンドの動作は、次の 2 つのバケットに分かれます。

• ランタイムの種類 — マシン レベルの割り当て: 「 Unattended」、「 NonProduction」、「 Headless」、「 TestAutomation」
• 名前付きユーザータイプ — ユーザーレベルの割り当て: Attended、 Development、 Studio、 StudioX、 RpaDeveloper、 CitizenDeveloper。

licenses list 両方のバケットを受け入れます。 licenses toggle はランタイム型のみを受け入れます。

uip or licenses list

特定のロボットの種類に対するライセンスの割り当てのリストを取得します。

• ランタイムの種類の場合、各行は接続されたロボットがインストールされたマシンです。MachineName、MachineType、Runtimes、IsOnline、IsLicensed、および Enabled が返されます。
• 名前付きユーザー型の場合、各行はユーザーです。UserName、LastLoginDate、MachinesCount、IsLicensed、および MachineNames が返されます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--type	ENUM	必須	ロボットの種類 (上記のリストを参照)。
—	--licensed	フラグ	無効	ライセンスされたエントリのみ。--unlicensedと相互に排他的です。
—	--unlicensed	フラグ	無効	ライセンスのないエントリのみ。--licensedと相互に排他的です。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	—	OData の並べ替え ( MachineName descなど)。

例

uip or licenses list --type Unattended --limit 50
uip or licenses list --type Attended --unlicensed
uip or licenses list --type Unattended \
    --output-filter 'Data[?IsOnline].MachineName'

データシェイプ(--output json)

ランタイムの種類:

{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "MachineName": "prod-worker-01",
      "MachineType": "Standard",
      "Runtimes": 3,
      "IsOnline": true,
      "IsLicensed": true,
      "Enabled": true
    }
  ]
}

ネームド ユーザーの種類:

{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[e-mail]",
      "LastLoginDate": "2025-04-15T10:30:00Z",
      "MachinesCount": 2,
      "IsLicensed": true,
      "MachineNames": ["studio-01", "studio-02"]
    }
  ]
}

uip or licenses toggle

特定の種類のランタイム ロボットに対してマシン ライセンスを有効化または無効化します。名前付きユーザー型は拒否されます。マシン キー (GUID) を受け入れます — API を呼び出す前に内部的にマシン名に解決されます。

--enable または --disable のいずれか 1 つを指定する必要があります。

引数

名前	Required	目的
<machine-key>	○	マシン キー (GUID)。[ machines list] で検索します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--type	ENUM	必須	ランタイム ロボットの種類のみ: Unattended、 NonProduction、 Headless、 TestAutomation。
—	--enable	フラグ	—	ライセンスを有効化します。
—	--disable	フラグ	—	ライセンスを無効化します。

例

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type NonProduction --disable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable --output-filter 'Data.Status'

データシェイプ(--output json)

{
  "Code": "LicenseToggle",
  "Data": {
    "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "MachineName": "prod-worker-01",
    "RobotType": "Unattended",
    "Enabled": true,
    "Status": "Licensing enabled"
  }
}

uip or licenses info

テナント ライセンスの概要 (サブスクリプション プラン、ロボットの種類ごとの使用数と使用済み数、有効期限ステータス、ライセンス機能) を表示します。割り当てる前に全体的なキャパシティを確認する場合に使用します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or licenses info
uip or licenses info --output-filter 'Data.Used'
uip or licenses info --output table

データシェイプ(--output json)

{
  "Code": "LicenseInfo",
  "Data": {
    "IsExpired": false,
    "SubscriptionPlan": "Enterprise",
    "Allowed": { "Unattended": 10, "Attended": 20 },
    "Used": { "Unattended": 4, "Attended": 7 },
    "LicensedFeatures": ["AISuite", "TestManager"]
  }
}

終了コード

「終了コード」を参照してください。動詞固有の上書きはありません。

関連コマンド

• uip or machines — マシンとスロットの割り当てを管理します。
• uip or users — users create と users edit--license-type です。

参照

• グローバル オプション。