protect zone

3 min read

Copy Markdown for LLMs

Manage the zones.

protect zone <COMMAND>

Commands:

• attach Attach to the zone console.
• list List zone information.
• launch Launch a new zone.
• destroy Destroy a zone.
• exec Execute a command inside the zone.
• logs View the logs of a zone.
• metrics Read metrics from the zone.
• top Dashboard for running zones.
• watch Watch for zone changes.
• update-resources Update the available resources to a zone.

attach Permalink for this section

protect zone attach <ZONE>

Arguments:

• <ZONE> Zone to show logs for, either the name or the uuid.

list Permalink for this section

protect zone list [OPTIONS] [ZONE]

Arguments:

• [ZONE] Limit to a single zone, either the name or the uuid.

Options:

• -o, --output <OUTPUT> Output format [default: table] [possible values: table, json, json-pretty, jsonl, yaml, key-value, simple].
• -l, --selector <SELECTOR> A selector for filtering the result set. Currently only supports ‘=’ and the ‘status.state’ field. Supported states include ‘creating’, ‘created’, ‘ready’, ’exited’, ‘destroying’, ‘destroyed’ and ‘failed’, with or without the ‘zone state’ prefix. (for example --selector status.state=failed or --selector status.state=ZONE_STATE_FAILED).

launch Permalink for this section

protect zone launch [OPTIONS]

Options:

• --pull-overwrite-cache Overwrite image cache on pull.
• --pull-update Update image on pull.
• -n, --name <NAME> Name of the zone.
• -C, --max-cpus <MAX_CPUS> Maximum vCPUs available for the zone [default: 4].
• -c, --target-cpus <TARGET_CPUS> Target vCPUs for the zone to use [default: 1].
• -M, --max-memory <MAX_MEMORY> Maximum memory available to the zone, in megabytes [default: 1024].
• -m, --target-memory <TARGET_MEMORY> Target memory for the zone to use, in megabytes [default: 1024].
• -D, --device <DEVICE> Devices to request for the zone.
• -a, --attach Attach to the zone after zone starts, implies –wait.
• -W, --wait Wait for the zone to be ready, implied by –attach.
• -k, --kernel <KERNEL> OCI kernel image for zone to use.
• -I, --initrd <INITRD> OCI initrd image for zone to use.
• -w, --working-directory <WORKING_DIRECTORY>. Working directory.
• --kernel-verbose Enable verbose logging on the kernel.
• --kernel-cmdline-append <KERNEL_CMDLINE_APPEND> Additional kernel cmdline options.
• --assume-network-reservation <ASSUME_NETWORK_RESERVATION> Assume an already allocated network reservation.
• --retain-network-reservation Retain network reservation after zone destruction.
• -R, --resource-adjustment-policy <RESOURCE_ADJUSTMENT_POLICY> Resource adjustment policy [possible values: static, dynamic].
• -V, --virt-backend <VIRT_BACKEND> Virtualization backend [possible values: pv, pvh].

destroy Permalink for this section

protect zone destroy [OPTIONS] <ZONE>

Arguments:

• [ZONE] Limit to a single zone, either the name or the uuid.

Options:

• -W, --wait Wait for the destruction of the zone to complete.
• -A, --all Destroy all zones matching the input.
• -l, --selector <SELECTOR> A selector for filtering the result set. Currently only supports ‘=’ and the ‘status.state’ field. Supported states include ‘creating’, ‘created’, ‘ready’, ’exited’, ‘destroying’, ‘destroyed’ and ‘failed’, with or without the ‘zone state’ prefix. (for example --selector status.state=failed or --selector status.state=ZONE_STATE_FAILED).

exec Permalink for this section

protect zone exec [OPTIONS] <ZONE> [COMMAND]...

Arguments:

• <ZONE> Zone to exec inside, either the name or the uuid.
• [COMMAND]... Command to run inside the zone.

Options:

• -e, --env <ENV> Environment variables.
• -w, --working-directory <WORKING_DIRECTORY> Working directory.
• -t, --tty Allocate tty.

logs Permalink for this section

protect zone logs [OPTIONS] <ZONE>

Arguments:

• <ZONE> Zone to show logs for, either the name or the uuid.

Options:

• -f, --follow Follow output from the zone.

metrics Permalink for this section

protect zone metrics [OPTIONS] <ZONE>

Arguments:

• <ZONE> Zone to show logs for, either the name or the uuid.

Options:

• -o, --output <OUTPUT> Output format [default: tree] [possible values: tree, json, json-pretty, yaml, key-value].

top Permalink for this section

protect zone top

watch Permalink for this section

protect zone watch [OPTIONS]

Options:

• -o, --output <OUTPUT> Output format [default: simple] [possible values: simple, json, key-value].

update-resources Permalink for this section

protect zone update-resources [OPTIONS] <ZONE>

Arguments:

• <ZONE> Zone to update resources of, either the name or the uuid.
• -C, --max-cpus <MAX_CPUS>. Maximum vCPUs available to the zone (0 means previous value) [default: 0].
• -c, --target-cpus <TARGET_CPUS> Target vCPUs for the zone to use (0 means previous value) [default: 0].
• -M, --max-memory <MAX_MEMORY>. Maximum memory available to the zone, in megabytes (0 means previous value) [default: 0].
• -m, --target-memory <TARGET_MEMORY>. Target memory for the zone to use, in megabytes (0 means previous value) [default: 0].
• -p, --adjustment-policy <ADJUSTMENT_POLICY> Adjustment policy [possible values: static, dynamic].

Last updated on 2026-07-07