Skip to main content
Aliases: placements, placement
Placements are gated behind a feature flag. The placements command is hidden and unavailable unless the feature is enabled for your organization.

Subcommands

  • list — List placements
  • get — Get placement details
  • create — Create a new placement
  • delete — Delete a placement
  • servers — List servers in a placement
  • server-reboot — Reboot a server in a placement
  • server-stop — Stop a server in a placement

list

List placements, optionally filtered by organization, project, or reservation.
nscale placements list [flags]

Flags

FlagDescription
—org stringOrganization ID
—project stringProject ID
—reservation stringReservation ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

Example

nscale placements list --org <org-id> --reservation <reservation-id>

get

Get details for a specific placement.
nscale placements get --id <placement-id> --org <org-id>

Flags

FlagDescription
—id stringPlacement ID
—org stringOrganization ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

create

Create a new placement. Accepts input from a JSON file or stdin, with an optional cloud-init configuration for the placed servers.
nscale placements create [flags]

Flags

FlagDescription
-f, —file stringPath to a JSON file
—stdinRead JSON from standard input
—cloud-init-path stringPath to a cloud-init YAML file
—dry-runPreview the request payload without persisting
-y, —yesAutomatically confirm creation
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

Examples

nscale placements create --file placement.json
nscale placements create --stdin < placement.json
cat placement.json | nscale placements create --stdin
nscale placements create --file placement.json --cloud-init-path cloud-init.yaml

delete

Delete an existing placement.
nscale placements delete --id <placement-id> --org <org-id> [flags]

Flags

FlagDescription
--id stringPlacement ID
--org stringOrganization ID
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm deletion

Example

nscale placements delete --id <placement-id> --org <org-id> --yes

servers

List the servers in a placement.
nscale placements servers --id <placement-id> --org <org-id>

Flags

FlagDescription
—id stringPlacement ID
—org stringOrganization ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

server-reboot

Reboot an existing server in a placement. Use --hard for a hard reboot.
nscale placements server-reboot --id <placement-id> --server <server-id> --org <org-id> [flags]

Flags

FlagDescription
--id stringPlacement ID
--server stringServer ID
--org stringOrganization ID
--hardUse hard reboot
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm reboot

Example

nscale placements server-reboot --id <placement-id> --server <server-id> --org <org-id> --yes

server-stop

Stop an existing server in a placement.
nscale placements server-stop --id <placement-id> --server <server-id> --org <org-id> [flags]

Flags

FlagDescription
--id stringPlacement ID
--server stringServer ID
--org stringOrganization ID
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm stop

Example

nscale placements server-stop --id <placement-id> --server <server-id> --org <org-id> --yes

Reservations

Reserve GPU capacity and check available reservation units.