Task
Manage a task, for shell scripts submitting tasks (import/export) and waiting for their completion.
opal task <CREDENTIALS> [OPTIONS] [EXTRAS]
Options
Option |
Description |
---|---|
|
The task ID. If not provided, it will be read from the standard input (from the JSON representation of the task or a plain value). |
|
Show JSON representation of the task |
|
Get the status of the task |
|
Wait for the task to complete (successfully or not) |
|
Cancel the task |
|
Delete the task |
Credentials
Authentication can be done by username/password credentials OR by personal access token OR by certificate/private key pair (two-way SSL authentication).
Option |
Description |
---|---|
|
Opal server base url |
|
Credentials auth: user name (requires a password) |
|
Credentials auth: user password (requires a user name) |
|
Token auth: user’s personal access token |
|
Two-way SSL auth: certificate/public key file (requires a private key) |
|
Two-way SSL auth: private key file (requires a certificate) |
Extras
Option |
Description |
---|---|
|
Show the command help’s message. |
|
Verbose output. |
|
Output pretty-print JSON |
Example
Get the full status of a task:
opal task -o https://opal-demo.obiba.org -u administrator -p password --id 1 --json
Get the status token of a task:
opal task -o https://opal-demo.obiba.org -u administrator -p password --id 1 --status
Wait for the task to complete and get its status token:
opal task -o https://opal-demo.obiba.org -u administrator -p password --id 1 --wait