Task Management Commands

yo task info

Show the basic information and script contents for a task.

usage: yo task info [-h] task

Positional Arguments

task

name of task to give info on

yo task join

Wait for all tasks on a given instance to complete.

usage: yo task join [-h] [--name NAME] [--exact-name] [--no-exact-name] [name_pos]

Positional Arguments

name_pos

Name of the instance to filter by

Named Arguments

--name, -n

Name of the instance to filter by

--exact-name, -E

Do not standardize the name by prefixing it with your system username if necessary.

--no-exact-name

Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)

yo task list

List every task and its basic metadata

usage: yo task list [-h]

yo task run

Run a long-running task script on an instance.

usage: yo task run [-h] [--name NAME] [--exact-name] [--no-exact-name] [-w] [name_pos] task

Positional Arguments

name_pos

Name of the instance to filter by

task

name of the task to execute

Named Arguments

--name, -n

Name of the instance to filter by

--exact-name, -E

Do not standardize the name by prefixing it with your system username if necessary.

--no-exact-name

Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)

-w, --wait

should we wait until the task is finished?

Default: False

yo task status

Report the status of all tasks on an instance.

usage: yo task status [-h] [--name NAME] [--exact-name] [--no-exact-name] [name_pos]

Positional Arguments

name_pos

Name of the instance to filter by

Named Arguments

--name, -n

Name of the instance to filter by

--exact-name, -E

Do not standardize the name by prefixing it with your system username if necessary.

--no-exact-name

Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)

yo task wait

Wait for a task to complete on an instance.

usage: yo task wait [-h] [--name NAME] [--exact-name] [--no-exact-name] [name_pos] task

Positional Arguments

name_pos

Name of the instance to filter by

task

name of the task to execute

Named Arguments

--name, -n

Name of the instance to filter by

--exact-name, -E

Do not standardize the name by prefixing it with your system username if necessary.

--no-exact-name

Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)