Documentation Index Fetch the complete documentation index at: https://docs.nscale.com/llms.txt
Use this file to discover all available pages before exploring further.
Aliases: instances, instSubcommands
list — List instancesget — Get instance detailscreate — Create a new instanceupdate — Update an existing instancedelete — Delete an instancestart — Start an instancestop — Stop an instancereboot — Reboot an instancesnapshot — Create a snapshot from an instancessh — Open an SSH session to an instancesshkey — Get an instance’s SSH keyconsoleoutput — Get instance console outputconsolesession — Get a VNC console session URL
list List compute instances, optionally filtered by organization, project, network, or region.
nscale instances list [flags]
Flags Flag Description —org stringOrganization ID —project stringProject ID —network stringNetwork ID —region stringRegion ID —jsonEmit the full JSON payload (mutually exclusive with -q) -q, —query stringArrayjq filter for value extraction (see Query output with -q )
Example nscale instances list --org < org-i d > --region < region-i d >
get Get details for a specific instance.
nscale instances get --id < instance-i d > --org < org-i d >
Flags Flag Description —id stringInstance 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 compute instance. Accepts input from a JSON file or stdin. Optionally supply a cloud-init configuration or bind an SSH certificate authority.
nscale instances create [flags]
Flags Flag Description -f, —file stringPath to a JSON file —stdinRead JSON from standard input —cloud-init-path stringPath to a cloud-init YAML file —ssh-ca-id stringSSH certificate authority ID to bind (pass empty string to clear) —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 instances create --file instance.json nscale instances create --stdin < instance.json cat instance.json | nscale instances create --stdin
update Update an existing instance.
nscale instances update --id < instance-i d > [flags]
Flags Flag Description —id stringInstance ID —org stringOrganization ID -f, —file stringPath to a JSON file —stdinRead JSON from standard input —dry-runPreview the request payload without persisting -y, —yesAutomatically confirm update —jsonEmit the full JSON payload (mutually exclusive with -q) -q, —query stringArrayjq filter for value extraction (see Query output with -q )
Examples nscale instances update --id < instance-i d > --file instance.json nscale instances update --id < instance-i d > --stdin < instance.json cat instance.json | nscale instances update --id < instance-i d > --stdin
delete Delete an existing instance.
nscale instances delete --id < instance-i d > --org < org-i d > [flags]
Flags Flag Description --id stringInstance ID --org stringOrganization ID --dry-runPreview the request payload without persisting -y, --yesAutomatically confirm deletion
start Start a stopped instance.
nscale instances start --id < instance-i d > --org < org-i d > [flags]
Flags Flag Description --id stringInstance ID --org stringOrganization ID --dry-runPreview the request payload without persisting -y, --yesAutomatically confirm start
stop Stop a running instance.
nscale instances stop --id < instance-i d > --org < org-i d > [flags]
Flags Flag Description --id stringInstance ID --org stringOrganization ID --dry-runPreview the request payload without persisting -y, --yesAutomatically confirm stop
reboot Reboot an instance. Use --hard for a hard reboot.
nscale instances reboot --id < instance-i d > --org < org-i d > [flags]
Flags Flag Description --id stringInstance ID --org stringOrganization ID --hardUse hard reboot --dry-runPreview the request payload without persisting -y, --yesAutomatically confirm reboot
snapshot Create an image snapshot from an instance. Accepts input from a JSON file or stdin.
nscale instances snapshot --id < instance-i d > [flags]
Flags Flag Description —id stringInstance ID —org stringOrganization ID -f, —file stringPath to a JSON file —stdinRead JSON from standard input —dry-runPreview the request payload without persisting -y, —yesAutomatically confirm snapshot —jsonEmit the full JSON payload (mutually exclusive with -q) -q, —query stringArrayjq filter for value extraction (see Query output with -q )
Examples nscale instances snapshot --id < instance-i d > --file snapshot.json nscale instances snapshot --id < instance-i d > --stdin < snapshot.json cat snapshot.json | nscale instances snapshot --id < instance-i d > --stdin
ssh Open an interactive SSH session to an instance using the system SSH client.
nscale instances ssh --id < instance-i d > [flags]
Flags Flag Description --id stringInstance ID --org stringOrganization ID -l, --ssh-user stringSSH login user (default: "root")
Examples nscale instances ssh --id < instance-i d > nscale instances ssh --org < org-i d > nscale instances ssh --id < instance-i d > --ssh-user ubuntu nscale instances ssh --id < instance-i d > -l ubuntu nscale instances ssh -l ubuntu nscale instances ssh --id < instance-i d > -- -L 8443:127.0.0.1:443
sshkey Get the SSH key for an instance.
nscale instances sshkey --id < instance-i d > --org < org-i d >
Flags Flag Description —id stringInstance 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 )
consoleoutput Retrieve the serial console output of an instance.
nscale instances consoleoutput --id < instance-i d > --org < org-i d > [flags]
Flags Flag Description —id stringInstance ID —org stringOrganization ID —length intOutput length in bytes (0 uses API default) —jsonEmit the full JSON payload (mutually exclusive with -q) -q, —query stringArrayjq filter for value extraction (see Query output with -q )
consolesession Get a VNC console session URL for an instance.
nscale instances consolesession --id < instance-i d > --org < org-i d >
Flags Flag Description --id stringInstance ID --org stringOrganization ID
Instances (Console) Create and manage instances via the Console UI.
Custom Images Upload and use custom OS images for instances.
