For the complete documentation index, see llms.txt. This page is also available as Markdown.

Instances

Instances are virtual machines running on AceCloud infrastructure. The ace instance command provides full lifecycle management: creation, power control, resizing, snapshotting, networking, and more.

Aliases: ace instance, ace i, ace vm


Table of Contents


List Instances

List all instances in the current project and region.

Aliases: ls

Output columns: ID, Name, Status, Power State, Flavor, IP Addresses.

JSON output:


Get Instance Details

Retrieve a comprehensive overview of a single instance, similar to the web portal detail page.

Aliases: show, describe

The output includes sections for:

  • Overview — ID, name, status, power state, VM state, lock status

  • Flavor — ID, name, vCPUs, RAM, disk

  • Image — ID, name (or "booted from volume")

  • Network — All attached networks with IP addresses, types, and MAC addresses

  • Security Groups — Names of all assigned security groups

  • Attached Volumes — Volume IDs with delete-on-termination status

  • SSH & Config — Key pair name, config drive, disk config

  • Placement & Timestamps — Availability zone, created/updated/launched times

  • Metadata — Key-value metadata pairs

  • Tags — Instance tags


Create an Instance

Create a new virtual machine.

Required Flags

Flag
Description

--name

Instance name (1-255 characters)

--flavor

Flavor name or UUID (e.g. C4i.medium)

--image

Image name or UUID (e.g. Ubuntu-22.04-LTS)

--network

VPC/network UUID (repeatable for multiple networks)

--security-group

Security group UUID (repeatable for multiple groups)

Optional Flags

Flag
Default
Description

--description

Instance description (max 255 characters)

--key

SSH key pair name for login

--count

1

Number of instances to create (1-10)

--boot-size

20

Boot volume size in GB

--volume-type

NVMe based High IOPS Storage

Boot volume storage type

--source-type

image

Boot source: image, snapshot, or volume

--billing-type

hourly

Billing type

--availability-zone

nova

Availability zone

--config-drive

false

Enable config drive

Examples

Both --flavor and --image accept either a human-readable name or a UUID. The CLI automatically resolves names to UUIDs before making the API call.


Update an Instance

Update the name or description of an existing instance.

Flag
Description

--name

New instance name

--description

New instance description

At least one of --name or --description must be provided.


Delete Instances

Delete one or more instances.

Aliases: rm


Power Management

Start

Start a stopped (shutoff) instance.

Stop

Stop (shutoff) a running instance.

Reboot

Reboot an instance. By default, performs a soft reboot (graceful OS shutdown). Use --hard to force a hard reboot.

Flag
Default
Description

--hard

false

Perform a hard (forced) reboot instead of soft

Suspend / Unsuspend

Suspend an instance to save resources while preserving state, or resume a suspended instance.

Lock / Unlock

Lock an instance to prevent accidental modifications, or unlock it to allow changes.

Recovery Mode

Toggle recovery mode on or off. Exactly one of --on or --off must be specified.

Flag
Description

--on

Enable recovery mode

--off

Disable recovery mode

Recovery mode may not be available in all regions.

Batch Shutoff

Shut off or start multiple instances in a single command.

Flag
Description

--on

Start (power on) all specified instances

--off

Shut off (power off) all specified instances (default behavior)


Resize

Resizing changes the flavor (CPU, RAM, disk) of an instance. This is a two-step process: initiate the resize, then confirm or revert it.

Resize an Instance

Initiate a resize to a new flavor.

Both flavor names and UUIDs are accepted. The CLI resolves names automatically.

After initiating, the instance enters a VERIFY_RESIZE state. You must confirm or revert.

Confirm Resize

Confirm the resize after verifying the instance works correctly.

Revert Resize

Revert to the previous flavor if something went wrong.

Resize workflow:

  1. ace instance resize <id> <new-flavor> — initiates the resize

  2. Wait for status to become VERIFY_RESIZE

  3. ace instance resize-confirm <id> — makes it permanent

  4. Or ace instance resize-revert <id> — rolls back to old flavor


Rebuild

Rebuild an instance with a new image. This reinstalls the operating system while keeping the same instance ID, flavor, and network configuration.

Flag
Description

--image

Required. Image name or UUID to rebuild with

Rebuilding an instance destroys all data on the boot disk. Back up important data first.


Snapshots and Images

Create Snapshot

Create a snapshot of an instance's current state.

Flag
Description

--name

Optional snapshot name

Save as Image

Save an instance as a reusable image that can be used to launch new instances.

Flag
Description

--name

Optional image name

save-image may not be available in all regions.


Console and Logs

Console URL

Get a web console URL for an instance. Open the URL in a browser for VNC-like access.

Outputs the console URL directly (or JSON with -o json).

Instance Logs

View the console/boot logs of an instance.

Action Logs

View the history of actions performed on an instance (create, stop, start, resize, etc.).


Volumes

List Attached Volumes

List all volumes attached to an instance.

Output columns: ID, Name, Size, Status, Type, Device.

Attach Volume

Attach an existing volume to an instance.

Flag
Description

--volume

Required. Volume UUID to attach

Detach Volume

Detach a volume from an instance.

Flag
Description

--volume

Required. Volume UUID to detach


Network Interfaces

List Interfaces

List all network interfaces attached to an instance.

Output columns: Port ID, IP Address, Status, Network ID, MAC Address.

Attach Interface

Attach a new network interface to an instance, either by port or by network.

Flag
Default
Description

--type

port

Interface type: port or network

--port

Port UUID (when type is port)

--network

Network UUID (when type is network)

Detach Interface

Detach a network interface from an instance by port ID.


Security Groups

List all security groups assigned to an instance.

Output columns: ID, Name, Rules count, Description.


Summary

Show a summary of instance counts across the current project.

Output: Total instance count and active instance count.


Example Workflow

A complete workflow for provisioning an instance from scratch:


Command Reference

Command
Description

ace instance list

List all instances

ace instance get <id>

Get instance details

ace instance create

Create a new instance

ace instance update <id>

Update name/description

ace instance delete <id> [id...]

Delete instance(s)

ace instance start <id>

Start an instance

ace instance stop <id>

Stop an instance

ace instance reboot <id>

Reboot an instance

ace instance suspend <id>

Suspend an instance

ace instance unsuspend <id>

Resume a suspended instance

ace instance lock <id>

Lock an instance

ace instance unlock <id>

Unlock an instance

ace instance recovery <id>

Toggle recovery mode

ace instance batch-shutoff <id> [id...]

Batch start/stop instances

ace instance resize <id> <flavor>

Resize to new flavor

ace instance resize-confirm <id>

Confirm pending resize

ace instance resize-revert <id>

Revert pending resize

ace instance rebuild <id>

Rebuild with new image

ace instance snapshot <id>

Create a snapshot

ace instance save-image <id>

Save as reusable image

ace instance console <id>

Get console URL

ace instance logs <id>

View instance logs

ace instance action-logs <id>

View action history

ace instance volumes <id>

List attached volumes

ace instance attach-volume <id>

Attach a volume

ace instance detach-volume <id>

Detach a volume

ace instance interfaces <id>

List network interfaces

ace instance attach-interface <id>

Attach a network interface

ace instance detach-interface <id> <port>

Detach a network interface

ace instance security-groups <id>

List security groups

ace instance summary

Show instance count summary

Last updated