Configurations
Configurations
Every change you make to a system —— creating a volume, editing a schedule, deleting a user, and so on —— is tracked as a configuration. This chapter covers viewing that history and, for scripting, waiting on configurations to complete.
Configuration history
Configuration history is a durable, system-wide log: every configuration ever applied, who applied it, when, and whether it succeeded, failed, or is still pending or in progress.
Using the web interface
Open Monitoring > Configurations. Use the toolbar to filter by state (pending, in progress, success, failure) and to sort or limit the results shown.
Using the CLI
configurations list [--pending --inProgress --success --failure] [--top=<numbers>] [--descendingOrder]
| Option | Description |
|---|---|
--pending |
Include pending configurations. If no state flag is set, all states are included. |
--inProgress |
Include in-progress configurations. |
--success |
Include successful configurations. |
--failure |
Include failed configurations. |
--top=<numbers> |
Limit the number of results returned. |
--descendingOrder |
Sort results by start time, newest first. |
Examples
List everything, newest first:
configurations list --descendingOrder
Show only the 10 most recent failures:
configurations list --failure --top 10 --descendingOrder
Current session configurations
This shows the configurations submitted during your current CLI/API session specifically —— useful for scripts and automation that need to check on the jobs they just submitted, rather than searching the full system-wide history above. It isn't shown in the web interface, and running it interactively in the CLI requires an elevated session; it's intended primarily for automation against the REST API.
Using the CLI
configurations session list [--jobids=<numbers...>] [--sync|--async] [--top=<numbers>] [--descendingOrder]
| Option | Description |
|---|---|
--jobids=<numbers...> |
Filter by job ID. |
--sync |
Show only synchronous configurations. |
--async |
Show only asynchronous configurations. |
--top=<numbers> |
Limit the number of results returned. |
--descendingOrder |
Sort results by job ID, newest first. |
Example
configurations session list --async --descendingOrder
Waiting for asynchronous configurations
Some configurations run asynchronously —— the command returns immediately with a job ID while the work continues in the background. This command blocks your CLI session until every asynchronous configuration submitted so far has finished, which is useful in scripts that need to be sure earlier steps completed before moving on to the next one. It takes no parameters, and since it's a session-blocking action it doesn't apply to the web interface —— the GUI already shows live configuration progress without blocking anything.
Using the CLI
configurations session async_completion
Example —— run a batch of commands, then block until they've all finished before continuing a script:
applications volumes create --application training --volume videos --capacity 2TB --pool HDD-1 --n 8 --k 2
configurations session async_completion
See also: Systems ·· CLI Productivity Tools —— scripting commands together, including waiting on configurations from a script.