protect workload

Manage the workloads

protect workload <COMMAND>

Commands:

• launch Launch a new workload.
• exec Execute a command inside the workload.
• attach Attach to a workload console.
• start Start a workload.
• stop Stop a workload.
• destroy Destroy a workload.
• list List workload information.
• watch Watch for workload changes.

launch Permalink for this section

protect workload launch [OPTIONS] --zone <ZONE> <OCI> [COMMAND]...

Arguments:

• <OCI> Container image for zone to use.
• [COMMAND]... Command to run the workload.

Options:

• --image-format <IMAGE_FORMAT> Image format [default: squashfs] [possible values: squashfs, erofs].
• --pull-overwrite-cache Overwrite image cache on pull.
• --pull-update Update image on pull.
• -n, --name <NAME> Name of the workload.
• -W, --wait Wait for the workload to be started.
• -t, --tty Allocate tty for the workload.
• -a, --attach Attach to workload console.
• -e, --env <ENV> Environment variables set in the workload.
• -m, --mounts <MOUNTS> Mount host directories into the workload.
• -w, --working-directory <WORKING_DIRECTORY> Working directory.
• --user <USER> User name or id.
• --group <GROUP> Group name or id.
• -z, --zone <ZONE> Zone to launch on, can be a name or id.

exec Permalink for this section

protect workload exec [OPTIONS] <WORKLOAD> [COMMAND]...

Arguments:

• <WORKLOAD> Workload 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.
• --user <USER> User name or id.
• --group <GROUP> Group name or id.

attach Permalink for this section

protect workload attach <WORKLOAD>

Arguments:

• <WORKLOAD> Workload to attach to, either the name or the uuid.

start Permalink for this section

protect workload start <WORKLOAD>

Arguments:

• <WORKLOAD> Workload to attach to, either the name or the uuid.

stop Permalink for this section

protect workload stop <WORKLOAD>

Arguments:

• <WORKLOAD> Workload to attach to, either the name or the uuid.

destroy Permalink for this section

protect workload destroy [OPTIONS] <WORKLOAD>

Arguments:

• <WORKLOAD> Workload to destroy, either the name or the uuid.

Options:

• -W, --wait Wait for the destruction of the workload to complete.
• -a, --all Destroy all workloads 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’, ‘running’, ‘completed’, ‘destroying’, ‘destroyed’ and ‘failed’, with or without the ‘workload state’ prefix. (for example --selector status.state=failedor--selector status.state=WORKLOAD_STATE_FAILED).

list Permalink for this section

protect workload list [OPTIONS] [WORKLOAD]

Arguments:

• [WORKLOAD] Limit to a single workload, 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’, ‘running’, ‘completed’, ‘destroying’, ‘destroyed’ and ‘failed’, with or without the ‘workload state’ prefix. (for example --selector status.state=failed or --selector status.state=WORKLOAD_STATE_FAILED).

watch Permalink for this section

protect workload watch [OPTIONS]

Options:

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