UIP またはマシン

uip or machines は、マシン テンプレートを管理します。ロボットが実行される場所と、各種類のライセンス スロットの数を記述した、ロボット ホストの定義です。マシンはテナントスコープですが、特定のフォルダーに割り当てることができます。

概要

uip or machines <verb> [options]

動詞

動詞	目的
list	テナント内のマシン、または特定のフォルダーに割り当てられたマシンのリストを取得します。
get	キーで 1 台のマシンを取得します。
create	新しいマシン テンプレートを作成します (任意でサーバーレス)。
edit	マシンの名前、説明、またはスロット割り当てを編集します。
delete	1 つ以上のマシンを削除します。
assign	マシンをフォルダーに割り当てます。
unassign	フォルダーからマシンを削除します。

UIP またはマシンのリスト

マシンのリストを取得します。--folder-key または --folder-pathを指定しない場合は、テナント内のすべてのマシンを返します。どちらのフラグを使用しても、そのフォルダーに割り当てられているマシンのみを返します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-key	GUID	—	キーによるフォルダーのスコープ。
—	--folder-path	パス	—	パスによるフォルダーのスコープ。
-n	--name	text	—	マシン名の contains-match
—	--scope	ENUM	—	Default、 Shared、 PersonalWorkspace、 Cloud、 Serverless、 AutomationCloudRobot、 ElasticRobot。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	Id desc	OData の並べ替え。
—	--all-fields	フラグ	無効	完全な API ペイロードを返します。

例

uip or machines list --limit 10
uip or machines list --folder-path "Shared"
uip or machines list --scope Serverless \
    --output-filter 'Data[].{name:Name, slots:UnattendedSlots}'

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

{
  "Code": "MachineList",
  "Data": [
    {
      "Name": "prod-worker-01",
      "ID": 101,
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "Type": "Standard",
      "Scope": "Default",
      "Description": "",
      "UnattendedSlots": 3,
      "HeadlessSlots": 0,
      "NonProductionSlots": 0,
      "TestAutomationSlots": 0,
      "LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

uip またはマシンが取得

GUID キーでマシンを取得します。フォルダー コンテキストは不要 — マシンはテナントスコープです。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--all-fields	フラグ	無効	完全な API ペイロードを返します。

例

uip or machines get a1b2c3d4-0000-0000-0000-000000000001
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 --all-fields
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.UnattendedSlots'

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

{
  "Code": "MachineGet",
  "Data": {
    "Name": "prod-worker-01",
    "ID": 101,
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "Type": "Standard",
    "Scope": "Default",
    "Description": "",
    "UnattendedSlots": 3,
    "HeadlessSlots": 0,
    "NonProductionSlots": 0,
    "TestAutomationSlots": 0,
    "LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
  }
}

uip またはマシンが作成する

新しいマシン テンプレートを作成します。--name は必須です。[ --serverlessでは、マシンはクラウドでホストされる (ポータブル) テンプレートとして作成されます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-n	--name	text	必須	マシン名 (テナント内で一意である必要があります)。
-d	--description	text	—	マシンの説明。
—	--serverless	フラグ	無効	サーバーレス (クラウドでホストされる) マシンを作成します。
—	--unattended-slots	Number	—	Unattended ロボットのスロット。
—	--headless-slots	Number	—	ヘッドレスロボットスロット。
—	--non-production-slots	Number	—	非運用環境のロボット スロット。
—	--testing-slots	Number	—	テスト オートメーション ロボットのスロット。
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or machines create --name "staging-worker" --unattended-slots 2

uip or machines create --name "serverless-pool" --serverless \
    --unattended-slots 10

uip or machines create --name "qa-host" --unattended-slots 1 --testing-slots 2 \
    --output-filter 'Data.Key'

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

{
  "Code": "MachineCreated",
  "Data": {
    "Name": "staging-worker",
    "ID": 103,
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Type": "Template",
    "Scope": "Default",
    "Description": "",
    "UnattendedSlots": 2,
    "HeadlessSlots": 0,
    "NonProductionSlots": 0,
    "TestAutomationSlots": 0,
    "LicenseKey": ""
  }
}

UIP またはマシンの編集

マシンの名前、説明、またはスロット割り当てを編集します。提供されているオプションのみが更新されます。省略されたフィールドは変更されません。

引数

名前	Required	目的
<machine-key>	○	マシン キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-n	--name	text	—	新しいマシン名。
-d	--description	text	—	新しいマシンの説明。
—	--unattended-slots	Number	—	Unattended ロボットのスロット。
—	--headless-slots	Number	—	ヘッドレスロボットスロット。
—	--non-production-slots	Number	—	非運用環境のロボット スロット。
—	--testing-slots	Number	—	テスト オートメーション ロボットのスロット。
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 --unattended-slots 5
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
    --name "staging-worker-eu" --description "EU staging host"
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
    --unattended-slots 5 --output-filter 'Data.Status'

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

{
  "Code": "MachineUpdate",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Name": "staging-worker",
    "Status": "Updated successfully"
  }
}

uip またはマシンの削除

1 つ以上のマシンを削除します。1 つのキーで DeleteByIdを使用します。複数のキーで Bulk API を使用します。マシンは、削除する前にすべてのフォルダーから割り当て解除する必要があります。

引数

名前	Required	目的
<machine-keys...>	○	1 つ以上のマシン キー (GUID)。

オプション

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

例

uip or machines delete a1b2c3d4-0000-0000-0000-000000000010
uip or machines delete key-1 key-2 key-3
uip or machines delete key-1 key-2 --output-filter 'Data.Count'

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

{
  "Code": "MachineDelete",
  "Data": {
    "Deleted": [
      { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Name": "staging-worker" }
    ],
    "Count": 1,
    "Status": "Deleted successfully"
  }
}

uip またはマシンの割り当て

1 つのフォルダーに 1 台以上のマシンを割り当てます。--folder-path または --folder-keyが必要です。

引数

名前	Required	目的
<machine-keys...>	○	1 つ以上のマシン キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-path	パス	—	パスによるターゲット フォルダー
—	--folder-key	GUID	—	キーによるターゲット フォルダー。

例

uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or machines assign key-1 key-2 --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

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

{
  "Code": "MachineAssign",
  "Data": {
    "MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
    "FolderPath": "Shared",
    "Count": 1,
    "Status": "Assigned successfully"
  }
}

uip またはマシンの割り当て解除

フォルダーからマシンを削除します。マシンは削除されず、フォルダーの割り当てのみが削除されます。--folder-path または --folder-keyが必要です。

引数

名前	Required	目的
<machine-keys...>	○	1 つ以上のマシン キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-path	パス	—	割り当て解除するフォルダーです。
—	--folder-key	GUID	—	割り当て解除するフォルダーです。

例

uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or machines unassign key-1 key-2 --folder-path "Production"

uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Count'

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

{
  "Code": "MachineUnassign",
  "Data": {
    "MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
    "FolderPath": "Shared",
    "Count": 1,
    "Status": "Unassigned successfully"
  }
}

終了コード

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

関連コマンド

• uip or folders — 特にフォルダー側からマシンの割り当てを検査するfolders runtimes。
• uip or licenses — 特定のマシンのライセンスを有効化/無効化licenses toggle。
• uip or jobs — jobs start --machine-keys特定のマシンを対象としています。

参照

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