> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# マルチプレイヤー サーバー

> ビルド、サーバー、アセット、コンテナー イメージ、クォータなど、PlayFab のマルチプレイヤー サーバーを管理します。

`playfab mps` コマンド ファミリーは試験段階 (Experimental) です。CLI インターフェイスは、フィードバックに基づいて変更または
削除される可能性があります。

`playfab mps` は、PlayFab のマルチプレイヤー サーバー (MPS) を管理します。対象は、ビルドとそのエイリアスおよび
リージョン、サーバー、アセット、証明書、シークレット、コンテナー イメージ、クォータ、仮想
マシン (VM) です。PlayFab の
[MpsPowershell](https://github.com/PlayFab/MpsPowershell) モジュールと同じ操作を扱います。このモジュールの
`Set-PfTitle` に相当するのは `xbox context set playfab-title-id <id>` です。[コンテキスト](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md)を参照してください。

```bash theme={null}
xbox --playfab-title-id ABC123 --output json-compact --data-only playfab mps build list
```

## コマンド ツリー

各コマンドは `xbox playfab mps` の下で実行されます。

| コマンド | PlayFab API パス | 説明 |
| - | - | - |
| `title enable` | `/MultiplayerServer/EnableMultiplayerServersForTitle` | タイトルに対して MPS を有効にします。 |
| `title status` | `/MultiplayerServer/GetTitleEnabledForMultiplayerServersStatus` | タイトルに対して MPS が有効かどうかを確認します。 |
| `build get` | `/MultiplayerServer/GetBuild` | ビルドを取得します。 |
| `build list` | `/MultiplayerServer/ListBuildSummariesV2` | ビルドを 1 ページ分一覧表示します。 |
| `build create` | `--type` によって異なります | ビルドを作成します。[`mps build create`](#mps-build-create) を参照してください。 |
| `build update-name` | `/MultiplayerServer/UpdateBuildName` | ビルドの名前を変更します。 |
| `build delete` | `/MultiplayerServer/DeleteBuild` | ビルドを削除します。 |
| `build alias get` | `/MultiplayerServer/GetBuildAlias` | ビルド エイリアスを取得します。 |
| `build alias list` | `/MultiplayerServer/ListBuildAliases` | ビルド エイリアスを 1 ページ分一覧表示します。 |
| `build alias create` | `/MultiplayerServer/CreateBuildAlias` | ビルド エイリアスを作成します。 |
| `build alias update` | `/MultiplayerServer/UpdateBuildAlias` | ビルド エイリアスを更新します。 |
| `build alias delete` | `/MultiplayerServer/DeleteBuildAlias` | ビルド エイリアスを削除します。 |
| `build region update` | `/MultiplayerServer/UpdateBuildRegion` | ビルドのリージョンの 1 つを更新します。 |
| `build region update-all` | `/MultiplayerServer/UpdateBuildRegions` | ビルドのすべてのリージョンを更新します。 |
| `build region delete` | `/MultiplayerServer/DeleteBuildRegion` | ビルドからリージョンを削除します。 |
| `server get` | `/MultiplayerServer/GetMultiplayerServerDetails` | サーバー セッションの詳細を取得します。 |
| `server list` | `/MultiplayerServer/ListMultiplayerServers` | リージョン内のビルドのサーバー セッションを 1 ページ分一覧表示します。 |
| `server list-archived` | `/MultiplayerServer/ListArchivedMultiplayerServers` | ビルドのアーカイブ済みサーバー セッションを 1 ページ分一覧表示します。 |
| `server request` | `/MultiplayerServer/RequestMultiplayerServer` | サーバー セッションをリクエストします。 |
| `server shutdown` | `/MultiplayerServer/ShutdownMultiplayerServer` | サーバー セッションをシャットダウンします。 |
| `server get-logs` | `/MultiplayerServer/GetMultiplayerServerLogs` | 終了したサーバーのログを取得します。 |
| `server get-session-logs` | `/MultiplayerServer/GetMultiplayerSessionLogsBySessionId` | セッション ID を指定して、終了したサーバーのログを取得します。 |
| `asset list` | `/MultiplayerServer/ListAssetSummaries` | アセットを 1 ページ分一覧表示します。 |
| `asset upload` | `/MultiplayerServer/GetAssetUploadUrl` | ローカル ファイルをアセットとしてアップロードします。[`mps asset upload`](#mps-asset-upload) を参照してください。 |
| `asset delete` | `/MultiplayerServer/DeleteAsset` | アセットを削除します。 |
| `asset get-upload-url` | `/MultiplayerServer/GetAssetUploadUrl` | アセットのアップロード先 URL を取得します。 |
| `asset get-download-url` | `/MultiplayerServer/GetAssetDownloadUrl` | アセットのダウンロード元 URL を取得します。 |
| `certificate list` | `/MultiplayerServer/ListCertificateSummaries` | 証明書を 1 ページ分一覧表示します。 |
| `certificate upload` | `/MultiplayerServer/UploadCertificate` | 証明書をアップロードします。[`mps certificate upload`](#mps-certificate-upload-and-mps-secret-upload) を参照してください。 |
| `certificate delete` | `/MultiplayerServer/DeleteCertificate` | 証明書を削除します。 |
| `secret list` | `/MultiplayerServer/ListSecretSummaries` | シークレットを 1 ページ分一覧表示します。 |
| `secret upload` | `/MultiplayerServer/UploadSecret` | シークレットをアップロードします。[`mps secret upload`](#mps-certificate-upload-and-mps-secret-upload) を参照してください。 |
| `secret delete` | `/MultiplayerServer/DeleteSecret` | シークレットを削除します。 |
| `container-image list` | `/MultiplayerServer/ListContainerImages` | カスタム コンテナー イメージを 1 ページ分一覧表示します。 |
| `container-image list-tags` | `/MultiplayerServer/ListContainerImageTags` | コンテナー イメージのタグを 1 ページ分一覧表示します。 |
| `container-image untag` | `/MultiplayerServer/UntagContainerImage` | コンテナー イメージからタグを削除します。 |
| `container-image repository delete` | `/MultiplayerServer/DeleteContainerImageRepository` | コンテナー イメージ リポジトリを削除します。 |
| `container-registry credentials get` | `/MultiplayerServer/GetContainerRegistryCredentials` | コンテナー レジストリの資格情報を取得します。 |
| `container-registry credentials rollover` | `/MultiplayerServer/RolloverContainerRegistryCredentials` | コンテナー レジストリの資格情報を置き換えます。 |
| `quota get` | `/MultiplayerServer/GetTitleMultiplayerServersQuotas` | タイトルの MPS クォータを取得します。 |
| `quota change get` | `/MultiplayerServer/GetTitleMultiplayerServersQuotaChange` | クォータ変更リクエストを取得します。 |
| `quota change list` | `/MultiplayerServer/ListTitleMultiplayerServersQuotaChanges` | すべてのクォータ変更リクエストを一覧表示します。 |
| `quota change create` | `/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange` | クォータの変更をリクエストします。 |
| `qos-server list` | `/MultiplayerServer/ListQosServersForTitle` | タイトルの QoS サーバーを一覧表示します。 |
| `party-qos-server list` | `/MultiplayerServer/ListPartyQosServers` | PlayFab Party の QoS サーバーを一覧表示します。 |
| `virtual-machine list` | `/MultiplayerServer/ListVirtualMachineSummaries` | VM を 1 ページ分一覧表示します。 |
| `remote-user create` | `/MultiplayerServer/CreateRemoteUser` | ビルドの VM にサインインするためのリモート ユーザーを作成します。 |
| `remote-user delete` | `/MultiplayerServer/DeleteRemoteUser` | リモート ユーザーを削除します。 |
| `remote-login get-endpoint` | `/MultiplayerServer/GetRemoteLoginEndpoint` | ビルドをホストしている VM のリモート サインイン エンドポイントを取得します。 |
| `party request` | `/Party/RequestPartyService` | PlayFab Party セッションをリクエストします。 |

## リクエスト本文

ほとんどの MPS コマンドは、[`playfab api`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playfab/api) と同様に、
操作の JSON リクエスト オブジェクトを送信します。

| オプション | 説明 |
| - | - |
| `--body` | インラインの JSON リクエスト本文。どちらの本文オプションも渡さない場合、既定値は `{}` です。 |
| `--body-file` | JSON リクエスト本文を含むファイルのパス。stdin から読み取る場合は `-`。 |

`--body` と `--body-file` を組み合わせることはできません。`certificate upload` と `secret upload` は
`--body-file` のみを受け付け、`asset upload` はどちらも受け付けません。それぞれのセクションを参照してください。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab mps build get --body '{ "BuildId": "11111111-2222-3333-4444-555555555555" }'
xbox --playfab-title-id ABC123 --data-only playfab mps server list --body '{ "BuildId": "11111111-2222-3333-4444-555555555555", "Region": "EastUs" }'
```

## 破壊的なコマンド

次のコマンドは、ターミナルでは最初に確認を求め、それ以外の環境では `--confirm` (`--yes`、`-y`) が必要です:
`build delete`、`build alias delete`、`build region delete`、`server shutdown`、
`asset delete`、`certificate delete`、`secret delete`、
`container-image repository delete`、`remote-user delete`。`--body-file -` を使用する場合は、
ターミナルでも `--confirm` が必要です。変更を行うその他の MPS コマンドは、確認を求めずに
実行されます。[安全性と破壊的な操作](https://docs.xbox.com/ja-jp/tools/xbox-cli/safety.md)を参照してください。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab mps build delete --body '{ "BuildId": "11111111-2222-3333-4444-555555555555" }' --confirm
```

## ページング

次の list コマンドは、呼び出しごとに結果を 1 ページ返します。

* `build list`、`build alias list`
* `server list`、`server list-archived`
* `asset list`、`certificate list`、`secret list`
* `container-image list`、`container-image list-tags`
* `virtual-machine list`

さらに結果がある場合は、応答の `SkipToken` が設定されます。次のページを取得するには、その値を持つ
`"SkipToken"` をリクエスト本文に追加し、その他のフィールドはそのままにして、`SkipToken` が
`null` で返されるまで繰り返します。1 ページに含める結果の数を変更するには、リクエスト本文で
`"PageSize"` を設定します。

ビルドの最初のページを取得します。

```bash theme={null}
xbox --playfab-title-id ABC123 --data-only playfab mps build list --body '{ "PageSize": 50 }'
```

`SkipToken` が `null` でない場合は、そのトークンを渡して次のページを取得します。

```bash theme={null}
xbox --playfab-title-id ABC123 --data-only playfab mps build list --body '{ "PageSize": 50, "SkipToken": "<SkipToken from the previous page>" }'
```

テーブル出力には `SkipToken` の列がないため、さらに結果がある場合は、テーブルの後に、
送信するトークンを含む通知が stderr に出力されます。

## テーブル出力

次の表に示すコマンドは `--output table` を受け付けます。その他の MPS コマンドは受け付けません。
[テーブル出力](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands.md#table-output)を参照してください。

| コマンド | 列 |
| - | - |
| `build list` | `BUILD ID`、`NAME`、`CREATED` |
| `build alias list` | `ALIAS ID`、`NAME` |
| `server list` | `SERVER ID`、`REGION`、`STATE`、`SESSION ID` |
| `server list-archived` | `SERVER ID`、`REGION`、`STATE`、`LAST TRANSITION` |
| `asset list` | `FILE NAME` |
| `certificate list` | `NAME`、`THUMBPRINT` |
| `secret list` | `NAME`、`VERSION`、`EXPIRES` |
| `container-image list` | `IMAGE` |
| `container-image list-tags` | `TAG` |
| `quota change list` | `REQUEST ID`、`DESCRIPTION`、`PENDING`、`APPROVED` |
| `qos-server list` | `REGION`、`SERVER URL` |
| `party-qos-server list` | `REGION`、`SERVER URL` |
| `virtual-machine list` | `VM ID`、`STATE`、`HEALTH` |

単一のレコードを返すコマンドは、そのレコードを 1 行で表示します。

| コマンド | 列 |
| - | - |
| `title status` | `STATUS` |
| `build get` | `BUILD ID`、`NAME`、`STATUS`、`OS`、`VM SIZE` |
| `build alias get` | `ALIAS ID`、`NAME` |
| `server get` | `SERVER ID`、`STATE`、`REGION`、`SESSION ID`、`IPV4 ADDRESS` |
| `asset get-upload-url` | `FILE NAME`、`UPLOAD URL` (マスク) |
| `asset get-download-url` | `FILE NAME`、`DOWNLOAD URL` (マスク) |
| `container-registry credentials get` | `DNS NAME`、`USERNAME`、`PASSWORD` (マスク) |
| `quota change get` | `REQUEST ID`、`DESCRIPTION`、`PENDING`、`APPROVED` |
| `remote-login get-endpoint` | `IPV4 ADDRESS`、`PORT` |

マスクされた列の値は資格情報であるため、`********` と表示されます。JSON 出力では
実際の値が返されます。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab mps build list --output table
```

```text theme={null}
BUILD ID                              NAME            CREATED
------------------------------------  --------------  ------------------------
11111111-2222-3333-4444-555555555555  combat-sandbox  2026-04-26T22:15:16.7Z
22222222-3333-4444-5555-666666666666  lobby-service   2026-06-23T22:00:37.702Z
```

## `mps build create`

`build create` には、呼び出す PlayFab API を選択する `--type` が必要です。また、他の MPS コマンドと同様に
リクエスト本文を受け取ります。

| `--type` の値 | PlayFab API パス |
| - | - |
| `managed` | `/MultiplayerServer/CreateBuildWithManagedContainer` |
| `custom` | `/MultiplayerServer/CreateBuildWithCustomContainer` |
| `process` | `/MultiplayerServer/CreateBuildWithProcessBasedServer` |

```bash theme={null}
xbox --playfab-title-id ABC123 playfab mps build create --type managed --body-file managed-build.json
```

## `mps certificate upload` と `mps secret upload`

`certificate upload` と `secret upload` のリクエスト本文には PFX のパスワードまたはシークレットの値が含まれるため、
リクエスト本文は `--body-file <path>` (stdin の場合は `--body-file -`) でのみ受け付けます。
`--body` を使用すると値がシェルの履歴やプロセスの一覧に残るため、`--body` は拒否されます。
どちらのコマンドも `--output table` を受け付けません。

| コマンド | リクエスト フィールド |
| - | - |
| `certificate upload` | `GameCertificate` (`Name`、`Base64EncodedValue`、および PFX にパスワードがある場合は `Password`)、`ForceUpdate`、`CustomTags` |
| `secret upload` | `GameSecret` (`Name`、`Value`、`ExpirationDate`)、`ForceUpdate`、`CustomTags` |

`ForceUpdate` を指定すると、同じ名前の既存の証明書またはシークレットが置き換えられます。本文ファイルは
ソース管理に含めず、アップロードが完了したら削除してください。

`certificate.json` には、Base64 でエンコードされた PFX とそのパスワードが含まれます。

```json theme={null}
{
  "GameCertificate": {
    "Name": "nod-arena-tls",
    "Base64EncodedValue": "<Base64-encoded PFX>",
    "Password": "<PFX password>"
  }
}
```

```bash theme={null}
xbox --playfab-title-id ABC123 playfab mps certificate upload --body-file certificate.json
```

シークレットを別のファイルに書き込まずに本文を作成するには、本文を `--body-file -` にパイプします。
この例では、`jq` は自身の引数ではなく `api-key.txt` から値を読み取るため、
値はプロセスの一覧に表示されません。

```bash theme={null}
jq -n --rawfile value api-key.txt \
  '{GameSecret: {Name: "nod-arena-api-key", Value: ($value | rtrimstr("\n"))}}' \
  | xbox --playfab-title-id ABC123 playfab mps secret upload --body-file -
```

## `mps asset upload`

`asset upload` は、ローカル ファイルをマルチプレイヤー サーバーのアセットとしてアップロードします。リクエスト本文ではなく
オプションを受け取り、アセット名とアップロードの状態を JSON として書き込みます。

| オプション | 必須 | 説明 |
| - | - | - |
| `--file` | はい | アップロードするローカル ファイルのパス。 |
| `--asset-name` | はい | PlayFab に作成するアセットの名前。 |
| `--buffer-size` | いいえ | アップロードのブロック サイズ (バイト単位)。既定値は `4194304` (4 MiB) です。 |

```bash theme={null}
xbox --playfab-title-id ABC123 playfab mps asset upload --file gameserver.zip --asset-name gameserver.zip
```


## Related topics

- [マルチプレイヤー サーバーの比較](https://docs.xbox.com/ja-jp/services/playfab/multiplayer/servers/server-comparison.md)
- [PlayFab マルチプレイヤー サーバーの用語](https://docs.xbox.com/ja-jp/services/playfab/multiplayer/servers/server-terms.md)
- [マルチプレイヤー サーバーのライフサイクル](https://docs.xbox.com/ja-jp/services/playfab/multiplayer/servers/multiplayer-game-server-lifecycle.md)
- [マルチプレイヤー サーバーのサンプルとリソース](https://docs.xbox.com/ja-jp/services/playfab/multiplayer/servers/server-samples-resources.md)
- [マルチプレイヤー サーバー ログのアーカイブと取得](https://docs.xbox.com/ja-jp/services/playfab/multiplayer/servers/archiving-and-retrieving-multiplayer-server-logs.md)
