UIP またはセッション

uip or sessions Orchestrator セッション (ロボット (Attended および Unattended) と Orchestrator 間のライブ ホスト接続) を表示および管理します。これを使用して、接続されているホストの確認、ランタイムスロットの使用状況の検査、セッションのデバッグモードの切り替え、セッションのメンテナンス、または非アクティブなセッションのクリーンアップを行います。

概要

uip or sessions <verb> [options]

動詞

動詞	目的
list-attended-sessions	有人 (Studio/Assistant) セッションのリストは、テナント全体、またはフォルダーにスコープが設定されています。
list-machines-sessions	特定のマシンのセッションのリストをマシン キー別に一覧表示します。
list-usernames	アクティブなセッションを持つユーザーのユーザー名のリストを取得します。
list-unattended-sessions	無人セッションのランタイム (マシン間でのスロットの使用状況) のリストを取得します。
list-user-executors	Automation Executor (ロボット名) をユーザー名でグループ化して一覧表示します。
toggle-debug-mode	マシン セッションのデバッグ モードを有効化または無効化します。
delete-inactive	切断状態または応答していないセッションを (すべてまたは ID で) 削除します。
set-maintenance-mode	マシン セッションをメンテナンス モードにします。

すべての動詞は 、グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) に従います。終了コードは 標準コントラクトに従います。

uip または sessions list-attended-sessions

有人セッションのリストを取得 — Studio と Assistant の接続。フォルダー フラグを指定しない場合、すべてのフォルダーにわたるセッションを返します (グローバル ビュー)。--folder-key または --folder-pathを指定すると、そのフォルダーにスコープが設定されているセッションが返されます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-key	GUID	—	フォルダー スコープのリストのフォルダー キー。
—	--folder-path	パス	—	フォルダー パス (例: Shared)
—	--state	ENUM	—	Available、 Busy、 Disconnected、 Unknown。--stateしない場合、Disconnectedセッションは除外されます。
—	--machine-name	text	—	マシン名の contains-match
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	Id desc	OData の並べ替え式 (例: MachineName asc)。

例

# Attended sessions across the tenant, excluding Disconnected
uip or sessions list-attended-sessions

# Only Busy sessions in a specific folder
uip or sessions list-attended-sessions --folder-path "Shared" --state Busy

# Just machine names and states, script-friendly
uip or sessions list-attended-sessions \
    --output-filter 'Data[].{m:MachineName, s:State}'

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

{
  "Code": "SessionList",
  "Data": [
    {
      "Id": 501,
      "HostMachineName": "host-01",
      "MachineId": 101,
      "MachineName": "attended-01",
      "State": "Available",
      "Job": null,
      "ReportingTime": "2025-04-15T10:30:00Z",
      "Info": "",
      "IsUnresponsive": false,
      "LicenseErrorCode": "",
      "OrganizationUnitId": 42,
      "FolderName": "Shared",
      "RobotSessionType": "Attended",
      "Version": "23.10.0",
      "Source": "Studio",
      "DebugModeExpirationDate": "",
      "UpdateInfo": null,
      "InstallationId": "",
      "Platform": "Windows",
      "EndpointDetection": ""
    }
  ]
}

uip または sessions list-machines-sessions

1 台のマシンのセッションのリストをマシン キー別に一覧表示します。マシン キーは、 uip or machines listによって返される GUID です。任意で、フォルダーのスコープを設定します。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-key	GUID	—	フォルダー スコープのリストのフォルダー キー。
—	--folder-path	パス	—	フォルダー範囲のコンポーネントで使用するフォルダー パス。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	Id desc	OData の並べ替え式。

例

uip or sessions list-machines-sessions a1b2c3d4-0000-0000-0000-000000000001
uip or sessions list-machines-sessions a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Production"

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

{
  "Code": "SessionGetMachine",
  "Data": [
    {
      "Id": 601,
      "ServiceUserName": "svc-runner",
      "HostMachineName": "prod-worker-01",
      "MachineId": 101,
      "MachineName": "prod-worker-01",
      "State": "Available",
      "Job": null,
      "ReportingTime": "2025-04-15T10:30:00Z",
      "Info": "",
      "IsUnresponsive": false,
      "LicenseErrorCode": "",
      "OrganizationUnitId": 42,
      "FolderName": "Shared",
      "RobotSessionType": "Unattended",
      "Version": "23.10.0",
      "Source": "",
      "DebugModeExpirationDate": "",
      "UpdateInfo": null,
      "InstallationId": "",
      "Platform": "Windows",
      "EndpointDetection": ""
    }
  ]
}

uip またはセッション リスト - ユーザー名

現在 Orchestrator に接続されているユーザーのユーザー名を返します。「今活躍しているのは誰ですか?」と素早く答えるのに便利です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	—	並べ替え式 (既定では空)。

例

uip or sessions list-usernames
uip or sessions list-usernames --limit 200

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

{
  "Code": "SessionListUsernames",
  "Data": ["[e-mail]", "[e-mail]"]
}

uip または sessions list-unattended-sessions

無人セッション ランタイムのリストを取得 — 無人マシンのスロット使用量ビューです。フォルダー フラグを指定しない場合は、テナント全体のセッションを返します。--folder-key または --folder-pathを指定すると、そのフォルダーにスコープが設定されているセッションが返されます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-key	GUID	—	フォルダー スコープのリストのフォルダー キー。
—	--folder-path	パス	—	フォルダー パス (例: Shared)
—	--runtime-type	ENUM	—	ランタイムの種類でフィルター処理します (例: Unattended、 Attended、 Headless、 Serverless)。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	SessionId desc	OData の並べ替え式。

例

# All unattended runtimes in the tenant
uip or sessions list-unattended-sessions

# Serverless-only in a specific folder
uip or sessions list-unattended-sessions --folder-path "Shared" \
    --runtime-type Serverless

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

{
  "Code": "SessionListMachineSessions",
  "Data": [
    {
      "SessionId": 701,
      "MachineId": 101,
      "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
      "MachineName": "prod-worker-01",
      "MaintenanceMode": "Default",
      "HostMachineName": "prod-worker-01",
      "RuntimeType": "Unattended",
      "MachineType": "Standard",
      "MachineScope": "Default",
      "Status": "Available",
      "IsUnresponsive": false,
      "Runtimes": 3,
      "UsedRuntimes": 1,
      "ServiceUserName": "svc-runner",
      "ReportingTime": "2025-04-15T10:30:00Z",
      "Version": "23.10.0",
      "DebugModeExpirationDate": "",
      "Platform": "Windows",
      "EndpointDetection": "",
      "TriggersCount": 0
    }
  ]
}

uip または sessions list-user-executors

各ユーザーに割り当てられた Automation Executor のリストを表示します。ユーザー名でグループ化されたロボット (Executor) 名を返します — どのユーザーがどの Unattended ロボットを持っているかを検出するのに役立ちます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	—	並べ替え式 (既定では空)。

例

uip or sessions list-user-executors

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

{
  "Code": "SessionListUserExecutors",
  "Data": [
    { "UserName": "[e-mail]", "RobotNames": ["prod-worker-01", "prod-worker-02"] },
    { "UserName": "[e-mail]", "RobotNames": ["dev-serverless"] }
  ]
}

uip またはセッション toggle-debug-mode

マシン セッションのデバッグ モードを切り替えます。デバッグ モードを有効化すると、Studio インスタンスを実行中のセッションに接続できます。list-unattended-sessions または list-machines-sessions を使用してセッション ID を検索します。

引数

名前	Required	目的
<session-id>	○	セッション ID (整数)

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--enabled	true/false	— (必須)	デバッグ モードを有効または無効にします。
—	--minutes	Number	—	デバッグ モードをアクティブな状態に保つ時間 (分) です。

例

# Enable debug mode for 60 minutes
uip or sessions toggle-debug-mode 701 --enabled true --minutes 60

# Disable debug mode
uip or sessions toggle-debug-mode 701 --enabled false

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

{
  "Code": "SessionToggleDebugMode",
  "Data": {
    "SessionId": 701,
    "Enabled": true,
    "Status": "Debug mode updated successfully"
  }
}

uip またはセッション delete-inactive

切断状態または応答がない (非アクティブな) セッションを削除します。特定のセッションを対象にするために 1 つ以上のセッション ID を指定するか、すべての ID を省略してテナント内のすべての非アクティブなセッションを削除します。

引数

名前	Required	目的
[session-ids...]	×	セッション ID (整数)。非アクティブなセッションをすべて削除するには省略します。

オプション

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

例

# Delete specific inactive sessions
uip or sessions delete-inactive 701 702

# Delete every inactive session in the tenant
uip or sessions delete-inactive

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

明示的な ID の場合:

{
  "Code": "SessionDeleteInactive",
  "Data": {
    "SessionIds": [701, 702],
    "Count": 2,
    "Status": "Inactive sessions deleted successfully"
  }
}

ID なし:

{
  "Code": "SessionDeleteInactive",
  "Data": { "Status": "All inactive sessions deleted successfully" }
}

uip または sessions set-maintenance-mode

マシン セッションをメンテナンス モードにする (または削除する)。メンテナンスにより、新しいジョブがセッションに割り当てられなくなります。メンテナンスを有効化する場合、実行中のジョブをソフトストップするか強制終了するかを --stop-jobs-strategy で制御します。

引数

名前	Required	目的
<session-id>	○	セッション ID (整数)

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--maintenance-mode	ENUM	— (必須)	Default または Enabled。
—	--stop-jobs-strategy	ENUM	—	SoftStop (優雅)または Kill (即時)。メンテナンスを有効化する場合にのみ適用されます。

例

# Enable maintenance, soft-stop running jobs
uip or sessions set-maintenance-mode 701 \
    --maintenance-mode Enabled --stop-jobs-strategy SoftStop

# Take the session back out of maintenance
uip or sessions set-maintenance-mode 701 --maintenance-mode Default

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

{
  "Code": "SessionSetMaintenanceMode",
  "Data": {
    "SessionId": 701,
    "MaintenanceMode": "Enabled",
    "Status": "Maintenance mode updated successfully"
  }
}

関連コマンド

• uip or machines — マシン名をlist-machines-sessionsのキーに解決します。
• uip or users — ユーザーディレクトリセッションのユーザー名は、ここでユーザー レコードにマップされます。
• uip or jobs — セッションで実行されているジョブを調査します。

参照

• グローバルオプション — --output、 --output-filter、 --log-level、 --log-file。
• 終了コード — 標準の終了コード限月。
• セッションと資格情報 — テナント コンテキストの解決方法。