playfab mps command family is Experimental. Its CLI interface might change
or be removed based on feedback.
playfab mps manages PlayFab Multiplayer Servers (MPS): builds and their aliases and
regions, servers, assets, certificates, secrets, container images, quotas, and virtual
machines (VMs). It covers the same operations as PlayFab’s
MpsPowershell module; the equivalent of its
Set-PfTitle is xbox context set playfab-title-id <id>. See Context.
Command tree
Each command runs underxbox playfab mps.
Request body
Most MPS commands send the operation’s JSON request object, likeplayfab api:
--body and --body-file can’t be combined. certificate upload and secret upload take
only --body-file, and asset upload takes neither; see their sections.
Destructive commands
These commands ask first in a terminal, and need--confirm (--yes, -y) elsewhere:
build delete, build alias delete, build region delete, server shutdown,
asset delete, certificate delete, secret delete,
container-image repository delete, and remote-user delete. With --body-file -, they
need --confirm even in a terminal. Other MPS commands that change things run without
asking. See Safety and destructive operations.
Paging
These list commands return one page of results per call:build list,build alias listserver list,server list-archivedasset list,certificate list,secret listcontainer-image list,container-image list-tagsvirtual-machine list
SkipToken is set. To get the next page, add
"SkipToken" with that value to the request body, keep its other fields, and repeat until
SkipToken comes back null. Set "PageSize" in the request body to change how many
results a page holds.
Get the first page of builds:
SkipToken isn’t null, get the next page by passing that token:
SkipToken, so when more results exist, the table is
followed by a notice on stderr with the token to send.
Table output
The commands in these tables accept--output table; other MPS commands don’t. See
Table output.
Commands that return a single record show it as one row:
Redacted columns print
********, because the value is a credential. JSON output returns
the real value.
mps build create
build create requires --type, which selects the PlayFab API it calls, and takes the
request body like other MPS commands:
mps certificate upload and mps secret upload
certificate upload and secret upload take their request body only with
--body-file <path>, or --body-file - for stdin, because it holds a PFX password or a
secret value. They refuse --body, which would leave the value in shell history and
process listings. Neither accepts --output table.
ForceUpdate replaces a certificate or secret that already has the name. Keep the body
file out of source control, and delete it once it’s uploaded.
certificate.json holds the Base64-encoded PFX and its password:
--body-file -.
Here, jq reads the value from api-key.txt rather than from its own arguments, so the
value stays out of process listings:
mps asset upload
asset upload uploads a local file as a multiplayer server asset. It takes options rather
than a request body, and writes the asset name and upload status as JSON.
