Instances - Nscale

Aliases: instances, inst

Subcommands

list — List instances
get — Get instance details
create — Create a new instance
update — Update an existing instance
delete — Delete an instance
start — Start an instance
stop — Stop an instance
reboot — Reboot an instance
snapshot — Create a snapshot from an instance
ssh — Open an SSH session to an instance
sshkey — Get an instance’s SSH key
consoleoutput — Get instance console output
consolesession — 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 string`	Organization ID
`—project string`	Project ID
`—network string`	Network ID
`—region string`	Region ID
`—json`	Emit the full JSON payload (mutually exclusive with `-q`)
`-q, —query stringArray`	jq filter for value extraction (see Query output with `-q`)

Example

nscale instances list --org <org-id> --region <region-id>

get

Get details for a specific instance.

nscale instances get --id <instance-id> --org <org-id>

Flags

Flag	Description
`—id string`	Instance ID
`—org string`	Organization ID
`—json`	Emit the full JSON payload (mutually exclusive with `-q`)
`-q, —query stringArray`	jq 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 string`	Path to a JSON file
`—stdin`	Read JSON from standard input
`—cloud-init-path string`	Path to a cloud-init YAML file
`—ssh-ca-id string`	SSH certificate authority ID to bind (pass empty string to clear)
`—dry-run`	Preview the request payload without persisting
`-y, —yes`	Automatically confirm creation
`—json`	Emit the full JSON payload (mutually exclusive with `-q`)
`-q, —query stringArray`	jq 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-id> [flags]

Flags

Flag	Description
`—id string`	Instance ID
`—org string`	Organization ID
`-f, —file string`	Path to a JSON file
`—stdin`	Read JSON from standard input
`—ssh-ca-id string`	SSH certificate authority ID to bind to the instance (pass an empty string to clear)
`—dry-run`	Preview the request payload without persisting
`-y, —yes`	Automatically confirm update
`—json`	Emit the full JSON payload (mutually exclusive with `-q`)
`-q, —query stringArray`	jq filter for value extraction (see Query output with `-q`)

Examples

nscale instances update --id <instance-id> --file instance.json
nscale instances update --id <instance-id> --stdin < instance.json
cat instance.json | nscale instances update --id <instance-id> --stdin

delete

Delete an existing instance.

nscale instances delete --id <instance-id> --org <org-id> [flags]

Flags

Flag	Description
`--id string`	Instance ID
`--org string`	Organization ID
`--dry-run`	Preview the request payload without persisting
`-y, --yes`	Automatically confirm deletion

start

Start a stopped instance.

nscale instances start --id <instance-id> --org <org-id> [flags]

Flags

Flag	Description
`--id string`	Instance ID
`--org string`	Organization ID
`--dry-run`	Preview the request payload without persisting
`-y, --yes`	Automatically confirm start

stop

Stop a running instance.

nscale instances stop --id <instance-id> --org <org-id> [flags]

Flags

Flag	Description
`--id string`	Instance ID
`--org string`	Organization ID
`--dry-run`	Preview the request payload without persisting
`-y, --yes`	Automatically confirm stop

reboot

Reboot an instance. Use --hard for a hard reboot.

nscale instances reboot --id <instance-id> --org <org-id> [flags]

Flags

Flag	Description
`--id string`	Instance ID
`--org string`	Organization ID
`--hard`	Use hard reboot
`--dry-run`	Preview the request payload without persisting
`-y, --yes`	Automatically confirm reboot

snapshot

Create an image snapshot from an instance. Accepts input from a JSON file or stdin.

nscale instances snapshot --id <instance-id> [flags]

Flags

Flag	Description
`—id string`	Instance ID
`—org string`	Organization ID
`-f, —file string`	Path to a JSON file
`—stdin`	Read JSON from standard input
`—dry-run`	Preview the request payload without persisting
`-y, —yes`	Automatically confirm snapshot
`—json`	Emit the full JSON payload (mutually exclusive with `-q`)
`-q, —query stringArray`	jq filter for value extraction (see Query output with `-q`)

Examples

nscale instances snapshot --id <instance-id> --file snapshot.json
nscale instances snapshot --id <instance-id> --stdin < snapshot.json
cat snapshot.json | nscale instances snapshot --id <instance-id> --stdin

ssh

Open an interactive SSH session to an instance using the system SSH client.

nscale instances ssh --id <instance-id> [flags]

Flags

Flag	Description
`--id string`	Instance ID
`--org string`	Organization ID
`-l, --ssh-user string`	SSH login user (default: `"root"`)

Examples

nscale instances ssh --id <instance-id>
nscale instances ssh --org <org-id>
nscale instances ssh --id <instance-id> --ssh-user ubuntu
nscale instances ssh --id <instance-id> -l ubuntu
nscale instances ssh -l ubuntu
nscale instances ssh --id <instance-id> -- -L 8443:127.0.0.1:443

sshkey

Get the SSH key for an instance.

nscale instances sshkey --id <instance-id> --org <org-id>

Flags

Flag	Description
`—id string`	Instance ID
`—org string`	Organization ID
`—json`	Emit the full JSON payload (mutually exclusive with `-q`)
`-q, —query stringArray`	jq filter for value extraction (see Query output with `-q`)

consoleoutput

Retrieve the serial console output of an instance.

nscale instances consoleoutput --id <instance-id> --org <org-id> [flags]

Flags

Flag	Description
`—id string`	Instance ID
`—org string`	Organization ID
`—length int`	Output length in bytes (0 uses API default)
`—json`	Emit the full JSON payload (mutually exclusive with `-q`)
`-q, —query stringArray`	jq filter for value extraction (see Query output with `-q`)

consolesession

Get a VNC console session URL for an instance.

nscale instances consolesession --id <instance-id> --org <org-id>

Flags

Flag	Description
`--id string`	Instance ID
`--org string`	Organization ID

Instances (Console)

Create and manage instances via the Console UI.

Custom Images

Upload and use custom OS images for instances.

​Subcommands

​list

​Flags

​Example

​get

​Flags

​create

​Flags

​Examples

​update

​Flags

​Examples

​delete

​Flags

​start

​Flags

​stop

​Flags

​reboot

​Flags

​snapshot

​Flags

​Examples

​ssh

​Flags

​Examples

​sshkey

​Flags

​consoleoutput

​Flags

​consolesession

​Flags

​Related

Instances (Console)

Custom Images

Subcommands

list

Flags

Example

get

Flags

create

Flags

Examples

update

Flags

Examples

delete

Flags

start

Flags

stop

Flags

reboot

Flags

snapshot

Flags

Examples

ssh

Flags

Examples

sshkey

Flags

consoleoutput

Flags

consolesession

Flags

Related