Skip to content

ezgh compute instances launch

Launch an instance.

Updated View as Markdown
ezgh compute instances launch <name> --instance-type t --image <alias|img_id> [--ssh-key k…] [--user-data file] [flags]

Launch an instance from an image alias (ezgh compute images list) or an exact image ID (img_…) as one of the organization’s instance types (ezgh compute instance-types list). It prints the CreateInstance operation, or with --wait waits until the instance is running and prints it.

--ssh-key names the project’s SSH keys (by ID, UUID or name) to install; --user-data reads a file (- for stdin, at most 16 KiB), such as a cloud-init config, that is never recorded.

The root volume is the image’s minimum size and the block store’s default type unless --root-size and --root-volume-type say otherwise; --root-snapshot restores it from a snapshot in place of --image. --volume attaches existing volumes and --new-volume creates more (<GiB>[:<volume type>]); both repeat.

--root-device instance-store boots from the type’s first instance store disk (store0) instead of a root volume: only for types with instance store (ezgh compute instance-types list), the image must fit the disk, and the instance can be rebooted and terminated but never stopped or resized. Its contents, like every instance store disk, are lost when the instance is terminated or moves to another host.

By default the instance gets one new network interface (IPv6) with the project’s default firewall: --ipv4 adds a public IPv4 address, --firewall (repeatable) sets its firewalls instead, and --no-firewalls gives it none. --primary-subnet makes that interface private, in a VPC subnet, with its VPC’s default firewall: --ipv4 or --no-ipv4 and --ipv6 or --no-ipv6 then say whether it gets a public IPv4 address (mapped onto its private one) and a public IPv6 /64, each following the subnet’s auto-assign when not given; either needs the VPC’s network gateway, and an instance with a private primary has no public interface. --network-interface (repeatable) uses existing interfaces in place of a new one, the first as the primary. --subnet (repeatable) adds a new private interface in that VPC subnet after the primary, with its VPC’s default firewall. --private-ipv4 (repeatable) sets their addresses: the i-th --private-ipv4 is the i-th --subnet’s, counting each flag on its own, and a --subnet without one gets the lowest free address. Snapshots, volumes, interfaces, subnets and firewalls are named by ID (snp_…, vol_…, eni_…, sbn_…, fwl_…), UUID or name.

Part of ezgh compute instances.

Examples

ezgh compute instances launch web-1 --instance-type t0.small --image linux/ubuntu:26.04 --ssh-key laptop --wait
ezgh compute instances launch db-1 --instance-type t0.large --image linux/debian:13 --root-size 50 --new-volume 200:d0 --ipv4

Flags

Flag Type Default Description
--bot string attach a Bot (bot_…): code on the instance gets short-lived credentials for it
--firewall string, repeatable a firewall for the new interface (ID, UUID or name), in place of the project’s default (repeat)
--image string the image alias, such as linux/ubuntu:26.04, or an exact image ID (img_…)
--instance-type string the instance type, such as gp-1.large (required); ezgh compute instance-types list shows the organization’s
--ipv4 boolean give the new interface a public IPv4 address
--ipv6 boolean with --primary-subnet: give it a public IPv6 /64
--network-interface string, repeatable use an existing network interface (ID, UUID or name), the first as the primary (repeat)
--new-volume string, repeatable create and attach a volume: <GiB>[:<volume type>] (repeat)
--no-firewalls boolean no firewall on the new interface
--no-ipv4 boolean with --primary-subnet: no public IPv4 address, whatever the subnet’s auto-assign
--no-ipv6 boolean with --primary-subnet: no public IPv6 /64, whatever the subnet’s auto-assign
--primary-subnet string make the new interface private, in this VPC subnet (ID, UUID or name)
--private-ipv4 string, repeatable the private IPv4 address of the --subnet with the same index: the i-th is the i-th --subnet’s (repeat)
--root-device string where the root lives: volume (default) or instance-store, for instance types with instance store (no root volume; the instance can’t be stopped or resized)
--root-iops int the root volume’s provisioned IOPS, for types that take it
--root-size int the root volume’s size in GiB (default: the image’s minimum)
--root-snapshot string restore the root volume from this snapshot (ID, UUID or name) in place of --image
--root-throughput int the root volume’s provisioned throughput in MB/s, for types that take it
--root-volume-type string the root volume’s type (default: the block store’s default)
--ssh-key string, repeatable an SSH key of the project to install, by ID, UUID or name (repeat, at most 10)
--subnet string, repeatable add a new private interface in this VPC subnet (ID, UUID or name), after the primary (repeat)
--tag string, repeatable a tag, key=value (repeat)
--user-data string a file of user-data (cloud-init), - for stdin, at most 16 KiB
--volume string, repeatable attach an existing volume, by ID, UUID or name (repeat)
--wait boolean wait until it’s running, and print it then
--wait-timeout duration 10m0s how long --wait waits

This command also takes the global flags.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close