> ## 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.

# Serveurs multijoueurs

> Gérez les serveurs multijoueurs PlayFab, notamment les builds, les serveurs, les ressources, les images conteneur et les quotas.

La famille de commandes `playfab mps` est expérimentale. Son interface CLI peut changer
ou être supprimée en fonction des retours.

`playfab mps` gère les serveurs multijoueurs PlayFab (MPS) : les builds ainsi que leurs alias et
régions, les serveurs, les ressources, les certificats, les secrets, les images conteneur, les quotas et les machines
virtuelles (VM). Elle couvre les mêmes opérations que le module
[MpsPowershell](https://github.com/PlayFab/MpsPowershell) de PlayFab ; l'équivalent de son
`Set-PfTitle` est `xbox context set playfab-title-id <id>`. Consultez [Contexte](https://docs.xbox.com/fr/tools/xbox-cli/commands/context.md).

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

## Arborescence des commandes

Chaque commande s'exécute sous `xbox playfab mps`.

| Commande | Chemin de l'API PlayFab | Description |
| - | - | - |
| `title enable` | `/MultiplayerServer/EnableMultiplayerServersForTitle` | Active MPS pour le titre. |
| `title status` | `/MultiplayerServer/GetTitleEnabledForMultiplayerServersStatus` | Vérifie si MPS est activé pour le titre. |
| `build get` | `/MultiplayerServer/GetBuild` | Obtient un build. |
| `build list` | `/MultiplayerServer/ListBuildSummariesV2` | Répertorie une page de builds. |
| `build create` | Dépend de `--type` | Crée un build. Consultez [`mps build create`](#mps-build-create). |
| `build update-name` | `/MultiplayerServer/UpdateBuildName` | Renomme un build. |
| `build delete` | `/MultiplayerServer/DeleteBuild` | Supprime un build. |
| `build alias get` | `/MultiplayerServer/GetBuildAlias` | Obtient un alias de build. |
| `build alias list` | `/MultiplayerServer/ListBuildAliases` | Répertorie une page d'alias de build. |
| `build alias create` | `/MultiplayerServer/CreateBuildAlias` | Crée un alias de build. |
| `build alias update` | `/MultiplayerServer/UpdateBuildAlias` | Met à jour un alias de build. |
| `build alias delete` | `/MultiplayerServer/DeleteBuildAlias` | Supprime un alias de build. |
| `build region update` | `/MultiplayerServer/UpdateBuildRegion` | Met à jour l'une des régions d'un build. |
| `build region update-all` | `/MultiplayerServer/UpdateBuildRegions` | Met à jour toutes les régions d'un build. |
| `build region delete` | `/MultiplayerServer/DeleteBuildRegion` | Supprime une région d'un build. |
| `server get` | `/MultiplayerServer/GetMultiplayerServerDetails` | Obtient les détails d'une session de serveur. |
| `server list` | `/MultiplayerServer/ListMultiplayerServers` | Répertorie une page des sessions de serveur d'un build dans une région. |
| `server list-archived` | `/MultiplayerServer/ListArchivedMultiplayerServers` | Répertorie une page des sessions de serveur archivées d'un build. |
| `server request` | `/MultiplayerServer/RequestMultiplayerServer` | Demande une session de serveur. |
| `server shutdown` | `/MultiplayerServer/ShutdownMultiplayerServer` | Arrête une session de serveur. |
| `server get-logs` | `/MultiplayerServer/GetMultiplayerServerLogs` | Obtient les journaux d'un serveur arrêté. |
| `server get-session-logs` | `/MultiplayerServer/GetMultiplayerSessionLogsBySessionId` | Obtient les journaux d'un serveur arrêté par ID de session. |
| `asset list` | `/MultiplayerServer/ListAssetSummaries` | Répertorie une page de ressources. |
| `asset upload` | `/MultiplayerServer/GetAssetUploadUrl` | Charge un fichier local en tant que ressource. Consultez [`mps asset upload`](#mps-asset-upload). |
| `asset delete` | `/MultiplayerServer/DeleteAsset` | Supprime une ressource. |
| `asset get-upload-url` | `/MultiplayerServer/GetAssetUploadUrl` | Obtient une URL vers laquelle charger une ressource. |
| `asset get-download-url` | `/MultiplayerServer/GetAssetDownloadUrl` | Obtient une URL à partir de laquelle télécharger une ressource. |
| `certificate list` | `/MultiplayerServer/ListCertificateSummaries` | Répertorie une page de certificats. |
| `certificate upload` | `/MultiplayerServer/UploadCertificate` | Charge un certificat. Consultez [`mps certificate upload`](#mps-certificate-upload-and-mps-secret-upload). |
| `certificate delete` | `/MultiplayerServer/DeleteCertificate` | Supprime un certificat. |
| `secret list` | `/MultiplayerServer/ListSecretSummaries` | Répertorie une page de secrets. |
| `secret upload` | `/MultiplayerServer/UploadSecret` | Charge un secret. Consultez [`mps secret upload`](#mps-certificate-upload-and-mps-secret-upload). |
| `secret delete` | `/MultiplayerServer/DeleteSecret` | Supprime un secret. |
| `container-image list` | `/MultiplayerServer/ListContainerImages` | Répertorie une page d'images conteneur personnalisées. |
| `container-image list-tags` | `/MultiplayerServer/ListContainerImageTags` | Répertorie une page des balises d'une image conteneur. |
| `container-image untag` | `/MultiplayerServer/UntagContainerImage` | Supprime une balise d'une image conteneur. |
| `container-image repository delete` | `/MultiplayerServer/DeleteContainerImageRepository` | Supprime un dépôt d'images conteneur. |
| `container-registry credentials get` | `/MultiplayerServer/GetContainerRegistryCredentials` | Obtient les informations d'identification du registre de conteneurs. |
| `container-registry credentials rollover` | `/MultiplayerServer/RolloverContainerRegistryCredentials` | Remplace les informations d'identification du registre de conteneurs. |
| `quota get` | `/MultiplayerServer/GetTitleMultiplayerServersQuotas` | Obtient les quotas MPS du titre. |
| `quota change get` | `/MultiplayerServer/GetTitleMultiplayerServersQuotaChange` | Obtient une demande de modification de quota. |
| `quota change list` | `/MultiplayerServer/ListTitleMultiplayerServersQuotaChanges` | Répertorie toutes les demandes de modification de quota. |
| `quota change create` | `/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange` | Demande une modification de quota. |
| `qos-server list` | `/MultiplayerServer/ListQosServersForTitle` | Répertorie les serveurs QoS du titre. |
| `party-qos-server list` | `/MultiplayerServer/ListPartyQosServers` | Répertorie les serveurs QoS de PlayFab Party. |
| `virtual-machine list` | `/MultiplayerServer/ListVirtualMachineSummaries` | Répertorie une page de VM. |
| `remote-user create` | `/MultiplayerServer/CreateRemoteUser` | Crée un utilisateur distant pour se connecter à la VM d'un build. |
| `remote-user delete` | `/MultiplayerServer/DeleteRemoteUser` | Supprime un utilisateur distant. |
| `remote-login get-endpoint` | `/MultiplayerServer/GetRemoteLoginEndpoint` | Obtient le point de terminaison de connexion à distance d'une VM qui héberge un build. |
| `party request` | `/Party/RequestPartyService` | Demande une session PlayFab Party. |

## Corps de la requête

La plupart des commandes MPS envoient l'objet de requête JSON de l'opération, comme
[`playfab api`](https://docs.xbox.com/fr/tools/xbox-cli/commands/playfab/api) :

| Option | Description |
| - | - |
| `--body` | Le corps de la requête JSON, en ligne. Vaut `{}` par défaut lorsqu'aucune option de corps n'est passée. |
| `--body-file` | Chemin d'un fichier contenant le corps de la requête JSON, ou `-` pour le lire depuis stdin. |

`--body` et `--body-file` ne peuvent pas être combinées. `certificate upload` et `secret upload` acceptent
uniquement `--body-file`, et `asset upload` n'accepte ni l'une ni l'autre ; consultez leurs sections.

```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" }'
```

## Commandes destructrices

Ces commandes demandent d'abord une confirmation dans un terminal et nécessitent `--confirm` (`--yes`, `-y`) ailleurs :
`build delete`, `build alias delete`, `build region delete`, `server shutdown`,
`asset delete`, `certificate delete`, `secret delete`,
`container-image repository delete` et `remote-user delete`. Avec `--body-file -`, elles
nécessitent `--confirm` même dans un terminal. Les autres commandes MPS qui modifient des éléments s'exécutent sans
demander de confirmation. Consultez [Sécurité et opérations destructrices](https://docs.xbox.com/fr/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
```

## Pagination

Ces commandes de liste renvoient une page de résultats par appel :

* `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`

Lorsqu'il existe d'autres résultats, le `SkipToken` de la réponse est défini. Pour obtenir la page suivante, ajoutez
`"SkipToken"` avec cette valeur au corps de la requête, conservez ses autres champs, et répétez jusqu'à ce que
`SkipToken` soit renvoyé avec la valeur `null`. Définissez `"PageSize"` dans le corps de la requête pour modifier le nombre de
résultats par page.

Obtenir la première page de builds :

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

Si son `SkipToken` n'est pas `null`, obtenez la page suivante en passant ce jeton :

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

La sortie sous forme de tableau n'a pas de colonne pour `SkipToken` ; lorsqu'il existe d'autres résultats, le tableau est donc
suivi d'un avis sur stderr indiquant le jeton à envoyer.

## Sortie sous forme de tableau

Les commandes de ces tableaux acceptent `--output table` ; les autres commandes MPS ne l'acceptent pas. Consultez
[Sortie sous forme de tableau](https://docs.xbox.com/fr/tools/xbox-cli/commands.md#table-output).

| Commande | Colonnes |
| - | - |
| `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` |

Les commandes qui renvoient un seul enregistrement l'affichent sur une seule ligne :

| Commande | Colonnes |
| - | - |
| `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` (masquée) |
| `asset get-download-url` | `FILE NAME`, `DOWNLOAD URL` (masquée) |
| `container-registry credentials get` | `DNS NAME`, `USERNAME`, `PASSWORD` (masquée) |
| `quota change get` | `REQUEST ID`, `DESCRIPTION`, `PENDING`, `APPROVED` |
| `remote-login get-endpoint` | `IPV4 ADDRESS`, `PORT` |

Les colonnes masquées affichent `********`, car la valeur est une information d'identification. La sortie JSON renvoie
la valeur réelle.

```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` nécessite `--type`, qui sélectionne l'API PlayFab appelée, et accepte le
corps de la requête comme les autres commandes MPS :

| Valeur de `--type` | Chemin de l'API PlayFab |
| - | - |
| `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` et `mps secret upload`

`certificate upload` et `secret upload` n'acceptent leur corps de requête qu'avec
`--body-file <path>`, ou `--body-file -` pour stdin, car il contient un mot de passe PFX ou une
valeur secrète. Elles refusent `--body`, qui laisserait la valeur dans l'historique du shell et dans les listes
de processus. Aucune des deux n'accepte `--output table`.

| Commande | Champs de la requête |
| - | - |
| `certificate upload` | `GameCertificate` (`Name`, `Base64EncodedValue` et `Password` si le PFX en a un), `ForceUpdate`, `CustomTags` |
| `secret upload` | `GameSecret` (`Name`, `Value`, `ExpirationDate`), `ForceUpdate`, `CustomTags` |

`ForceUpdate` remplace un certificat ou un secret qui porte déjà ce nom. Gardez le fichier
de corps hors du contrôle de code source, et supprimez-le une fois chargé.

`certificate.json` contient le PFX encodé en Base64 et son mot de passe :

```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
```

Pour créer le corps sans écrire le secret dans un autre fichier, redirigez-le vers `--body-file -`.
Ici, `jq` lit la valeur depuis `api-key.txt` plutôt que depuis ses propres arguments ; la
valeur n'apparaît donc pas dans les listes de processus :

```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` charge un fichier local en tant que ressource de serveur multijoueur. Elle accepte des options plutôt
qu'un corps de requête, et écrit le nom de la ressource et l'état du chargement au format JSON.

| Option | Obligatoire | Description |
| - | - | - |
| `--file` | Oui | Chemin du fichier local à charger. |
| `--asset-name` | Oui | Nom de la ressource à créer dans PlayFab. |
| `--buffer-size` | Non | Taille des blocs de chargement en octets. Vaut `4194304` (4 Mio) par défaut. |

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


## Related topics

- [Serveurs](https://docs.xbox.com/fr/services/playfab/multiplayer/servers/index.md)
- [Comparaison des serveurs multijoueurs](https://docs.xbox.com/fr/services/playfab/multiplayer/servers/server-comparison.md)
- [Arrêter le serveur multijoueur](https://docs.xbox.com/fr/services/playfab/api-references/rest/multiplayer/multiplayer-server/shutdown-multiplayer-server.md)
- [Répertorier les serveurs multijoueurs](https://docs.xbox.com/fr/services/playfab/api-references/rest/multiplayer/multiplayer-server/list-multiplayer-servers.md)
- [Demander un serveur multijoueur](https://docs.xbox.com/fr/services/playfab/api-references/rest/multiplayer/multiplayer-server/request-multiplayer-server.md)
