Appearance
systemslab experiment set-job-state
| Description | Set the state of an external job in an experiment. |
|---|---|
| Usage | systemslab experiment set-job-state [OPTIONS] <EXPERIMENT> <STATE> |
Description
The systemslab experiment set-job-state command sets the state of an external job in an experiment. This command can only be used for external jobs.
Options
| Option | Default | Description |
|---|---|---|
<EXPERIMENT> | The experiment that we are modifying. | |
<STATE> | The state to which we are updating the job's state. Valid values are: complete, failed, error, cancelled. | |
--run <RUN> | Update the job state for a specific run. If not specified then the latest job run in the experiment will be used. | |
--job <UUID> | The ID of the job we want to update. Conflicts with --job-name. | |
--job-name <NAME> | The name of the job we want to update. If there are multiple jobs with the same name use --job-index to select one. Conflicts with --job. | |
--job-index <INDEX> | The index of the job to update. Requires --job-name. |
Common Options
| Option | Default | Description |
|---|---|---|
--systemslab-url | The URL at which to access the systemslab server. | |
--color | auto | Controls when color is used in the output. Possible values are auto, always, and never. |
--output-format | long | Output format to use when outputting messages. long will result output designed to be human-readable while short is short output meant to be used within scripts. |
Environment Variables
| Variable | Description |
|---|---|
SYSTEMSLAB_URL | Specify the URL used to contact the SystemsLab server. Equivalent to --systemslab-url. |