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

# Multiplayer Servers

> Gerencie os PlayFab Multiplayer Servers, incluindo builds, servidores, ativos, imagens de contêiner e cotas.

A família de comandos `playfab mps` é Experimental. Sua interface de CLI pode mudar
ou ser removida com base em comentários.

`playfab mps` gerencia os PlayFab Multiplayer Servers (MPS): builds e seus aliases e
regiões, servidores, ativos, certificados, segredos, imagens de contêiner, cotas e máquinas
virtuais (VMs). Ele abrange as mesmas operações que o módulo
[MpsPowershell](https://github.com/PlayFab/MpsPowershell) do PlayFab; o equivalente ao seu
`Set-PfTitle` é `xbox context set playfab-title-id <id>`. Consulte [Contexto](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/context.md).

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

## Árvore de comandos

Cada comando é executado em `xbox playfab mps`.

| Comando | Caminho da API do PlayFab | Descrição |
| - | - | - |
| `title enable` | `/MultiplayerServer/EnableMultiplayerServersForTitle` | Habilita o MPS para o título. |
| `title status` | `/MultiplayerServer/GetTitleEnabledForMultiplayerServersStatus` | Verifica se o MPS está habilitado para o título. |
| `build get` | `/MultiplayerServer/GetBuild` | Obtém um build. |
| `build list` | `/MultiplayerServer/ListBuildSummariesV2` | Lista uma página de builds. |
| `build create` | Depende de `--type` | Cria um build. Consulte [`mps build create`](#mps-build-create). |
| `build update-name` | `/MultiplayerServer/UpdateBuildName` | Renomeia um build. |
| `build delete` | `/MultiplayerServer/DeleteBuild` | Exclui um build. |
| `build alias get` | `/MultiplayerServer/GetBuildAlias` | Obtém um alias de build. |
| `build alias list` | `/MultiplayerServer/ListBuildAliases` | Lista uma página de aliases de build. |
| `build alias create` | `/MultiplayerServer/CreateBuildAlias` | Cria um alias de build. |
| `build alias update` | `/MultiplayerServer/UpdateBuildAlias` | Atualiza um alias de build. |
| `build alias delete` | `/MultiplayerServer/DeleteBuildAlias` | Exclui um alias de build. |
| `build region update` | `/MultiplayerServer/UpdateBuildRegion` | Atualiza uma das regiões de um build. |
| `build region update-all` | `/MultiplayerServer/UpdateBuildRegions` | Atualiza todas as regiões de um build. |
| `build region delete` | `/MultiplayerServer/DeleteBuildRegion` | Remove uma região de um build. |
| `server get` | `/MultiplayerServer/GetMultiplayerServerDetails` | Obtém os detalhes de uma sessão de servidor. |
| `server list` | `/MultiplayerServer/ListMultiplayerServers` | Lista uma página das sessões de servidor de um build em uma região. |
| `server list-archived` | `/MultiplayerServer/ListArchivedMultiplayerServers` | Lista uma página das sessões de servidor arquivadas de um build. |
| `server request` | `/MultiplayerServer/RequestMultiplayerServer` | Solicita uma sessão de servidor. |
| `server shutdown` | `/MultiplayerServer/ShutdownMultiplayerServer` | Desliga uma sessão de servidor. |
| `server get-logs` | `/MultiplayerServer/GetMultiplayerServerLogs` | Obtém os logs de um servidor encerrado. |
| `server get-session-logs` | `/MultiplayerServer/GetMultiplayerSessionLogsBySessionId` | Obtém os logs de um servidor encerrado pela ID da sessão. |
| `asset list` | `/MultiplayerServer/ListAssetSummaries` | Lista uma página de ativos. |
| `asset upload` | `/MultiplayerServer/GetAssetUploadUrl` | Carrega um arquivo local como ativo. Consulte [`mps asset upload`](#mps-asset-upload). |
| `asset delete` | `/MultiplayerServer/DeleteAsset` | Exclui um ativo. |
| `asset get-upload-url` | `/MultiplayerServer/GetAssetUploadUrl` | Obtém uma URL para a qual carregar um ativo. |
| `asset get-download-url` | `/MultiplayerServer/GetAssetDownloadUrl` | Obtém uma URL da qual baixar um ativo. |
| `certificate list` | `/MultiplayerServer/ListCertificateSummaries` | Lista uma página de certificados. |
| `certificate upload` | `/MultiplayerServer/UploadCertificate` | Carrega um certificado. Consulte [`mps certificate upload`](#mps-certificate-upload-and-mps-secret-upload). |
| `certificate delete` | `/MultiplayerServer/DeleteCertificate` | Exclui um certificado. |
| `secret list` | `/MultiplayerServer/ListSecretSummaries` | Lista uma página de segredos. |
| `secret upload` | `/MultiplayerServer/UploadSecret` | Carrega um segredo. Consulte [`mps secret upload`](#mps-certificate-upload-and-mps-secret-upload). |
| `secret delete` | `/MultiplayerServer/DeleteSecret` | Exclui um segredo. |
| `container-image list` | `/MultiplayerServer/ListContainerImages` | Lista uma página de imagens de contêiner personalizadas. |
| `container-image list-tags` | `/MultiplayerServer/ListContainerImageTags` | Lista uma página das marcas de uma imagem de contêiner. |
| `container-image untag` | `/MultiplayerServer/UntagContainerImage` | Remove uma marca de uma imagem de contêiner. |
| `container-image repository delete` | `/MultiplayerServer/DeleteContainerImageRepository` | Exclui um repositório de imagens de contêiner. |
| `container-registry credentials get` | `/MultiplayerServer/GetContainerRegistryCredentials` | Obtém as credenciais do registro de contêiner. |
| `container-registry credentials rollover` | `/MultiplayerServer/RolloverContainerRegistryCredentials` | Substitui as credenciais do registro de contêiner. |
| `quota get` | `/MultiplayerServer/GetTitleMultiplayerServersQuotas` | Obtém as cotas de MPS do título. |
| `quota change get` | `/MultiplayerServer/GetTitleMultiplayerServersQuotaChange` | Obtém uma solicitação de alteração de cota. |
| `quota change list` | `/MultiplayerServer/ListTitleMultiplayerServersQuotaChanges` | Lista todas as solicitações de alteração de cota. |
| `quota change create` | `/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange` | Solicita uma alteração de cota. |
| `qos-server list` | `/MultiplayerServer/ListQosServersForTitle` | Lista os servidores de QoS do título. |
| `party-qos-server list` | `/MultiplayerServer/ListPartyQosServers` | Lista os servidores de QoS do PlayFab Party. |
| `virtual-machine list` | `/MultiplayerServer/ListVirtualMachineSummaries` | Lista uma página de VMs. |
| `remote-user create` | `/MultiplayerServer/CreateRemoteUser` | Cria um usuário remoto para entrar na VM de um build. |
| `remote-user delete` | `/MultiplayerServer/DeleteRemoteUser` | Exclui um usuário remoto. |
| `remote-login get-endpoint` | `/MultiplayerServer/GetRemoteLoginEndpoint` | Obtém o ponto de extremidade de entrada remota de uma VM que hospeda um build. |
| `party request` | `/Party/RequestPartyService` | Solicita uma sessão do PlayFab Party. |

## Corpo da solicitação

A maioria dos comandos MPS envia o objeto de solicitação JSON da operação, como
[`playfab api`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab/api):

| Opção | Descrição |
| - | - |
| `--body` | O corpo da solicitação JSON, embutido. O padrão é `{}` quando nenhuma das opções de corpo é passada. |
| `--body-file` | Caminho para um arquivo que contém o corpo da solicitação JSON, ou `-` para lê-lo de stdin. |

`--body` e `--body-file` não podem ser combinadas. `certificate upload` e `secret upload` aceitam
somente `--body-file`, e `asset upload` não aceita nenhuma delas; consulte as seções correspondentes.

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

## Comandos destrutivos

Estes comandos pedem confirmação primeiro em um terminal e exigem `--confirm` (`--yes`, `-y`) em outros contextos:
`build delete`, `build alias delete`, `build region delete`, `server shutdown`,
`asset delete`, `certificate delete`, `secret delete`,
`container-image repository delete` e `remote-user delete`. Com `--body-file -`, eles
exigem `--confirm` mesmo em um terminal. Outros comandos MPS que alteram algo são executados sem
pedir confirmação. Consulte [Segurança e operações destrutivas](https://docs.xbox.com/pt-BR/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
```

## Paginação

Estes comandos de listagem retornam uma página de resultados por chamada:

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

Quando há mais resultados, o `SkipToken` da resposta é definido. Para obter a próxima página, adicione
`"SkipToken"` com esse valor ao corpo da solicitação, mantenha os outros campos e repita até que
`SkipToken` volte como `null`. Defina `"PageSize"` no corpo da solicitação para alterar quantos
resultados uma página contém.

Obtenha a primeira página de builds:

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

Se o `SkipToken` dela não for `null`, obtenha a próxima página passando esse token:

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

A saída em tabela não tem coluna para `SkipToken`; portanto, quando há mais resultados, a tabela é
seguida por um aviso em stderr com o token a ser enviado.

## Saída em tabela

Os comandos destas tabelas aceitam `--output table`; os outros comandos MPS não. Consulte
[Saída em tabela](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands.md#table-output).

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

Os comandos que retornam um único registro o mostram como uma linha:

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

As colunas ocultadas imprimem `********`, porque o valor é uma credencial. A saída JSON retorna
o valor real.

```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` exige `--type`, que seleciona a API do PlayFab que ele chama, e aceita o
corpo da solicitação como os outros comandos MPS:

| Valor de `--type` | Caminho da API do 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` e `mps secret upload`

`certificate upload` e `secret upload` aceitam o corpo da solicitação somente com
`--body-file <path>`, ou `--body-file -` para stdin, porque ele contém uma senha de PFX ou um
valor secreto. Eles recusam `--body`, que deixaria o valor no histórico do shell e nas
listagens de processos. Nenhum deles aceita `--output table`.

| Comando | Campos da solicitação |
| - | - |
| `certificate upload` | `GameCertificate` (`Name`, `Base64EncodedValue` e `Password`, se o PFX tiver uma), `ForceUpdate`, `CustomTags` |
| `secret upload` | `GameSecret` (`Name`, `Value`, `ExpirationDate`), `ForceUpdate`, `CustomTags` |

`ForceUpdate` substitui um certificado ou segredo que já tenha o nome. Mantenha o arquivo de
corpo fora do controle do código-fonte e exclua-o depois que ele for carregado.

`certificate.json` contém o PFX codificado em Base64 e sua senha:

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

Para criar o corpo sem gravar o segredo em outro arquivo, redirecione-o para `--body-file -`.
Aqui, `jq` lê o valor de `api-key.txt` em vez de seus próprios argumentos, de modo que o
valor fica fora das listagens de processos:

```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` carrega um arquivo local como um ativo de servidor multijogador. Ele aceita opções em vez
de um corpo de solicitação e grava o nome do ativo e o status do carregamento como JSON.

| Opção | Obrigatória | Descrição |
| - | - | - |
| `--file` | Sim | Caminho para o arquivo local a ser carregado. |
| `--asset-name` | Sim | Nome do ativo a ser criado no PlayFab. |
| `--buffer-size` | Não | Tamanho do bloco de carregamento em bytes. O padrão é `4194304` (4 MiB). |

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


## Related topics

- [List Multiplayer Servers](https://docs.xbox.com/api-reference/multiplayerserver/list-multiplayer-servers.md)
- [Request Multiplayer Server](https://docs.xbox.com/api-reference/multiplayerserver/request-multiplayer-server.md)
- [Shutdown Multiplayer Server](https://docs.xbox.com/api-reference/multiplayerserver/shutdown-multiplayer-server.md)
- [PFMultiplayerServerRequestMultiplayerServerResponse](https://docs.xbox.com/pt-BR/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverrequestmultiplayerserverresponse.md)
- [PFMultiplayerServerRequestMultiplayerServerAsync](https://docs.xbox.com/pt-BR/services/playfab/api-references/c/pfmultiplayerserver/functions/pfmultiplayerserverrequestmultiplayerserverasync.md)
