fredcli environment get-status

Retrieve status information for the FRED Cloud environment

Synopsis

fredcli environment get-status

Get usage and quota information for the FRED cloud platform.

fredcli environment get-status [options]

Options

--output <output>

Choose output format, either human readable text, or json.

Default

text

Options

text | json

Description

Display the nodes running and queued nodes in the FRED Cloud environment. This shows both standard and memory nodes, corresponding to the standard and high memory collection of sizes available in the fredcli batch submit command.

The following information is provided:

  • Running Nodes is the number of EC2 nodes currently executing in the environment.

  • Running CPUs is the total number of CPU cores across the running nodes. This also shows the maximum CPU quota for the indicated node type.

  • Queued Batches is the batches queued and not yet running in the environment.

  • Queued CPUs is the total number of CPU cores across the queued batchs.

Note that a node in the process of starting up or shutting down may appear in both the Running and Queued categories. As such, the total number of CPUs may exceed the indicated maximum number of CPUs in such cases.

Examples

The following example shows the text output when nothing is running in the environment.

$ fredcli env get-status
|     TYPE |   RUNNING NODES |   RUNNING CPUS |   QUEUED BATCHES |   QUEUED CPUS |
|----------|-----------------|----------------|------------------|---------------|
| standard |               0 |       0 / 3536 |                0 |             0 |
|   memory |               0 |        0 / 512 |                0 |             0 |
$

As another example, here the same status with output type JSON.

$ fredcli env get-status --output json
{"quotas": {"standard": {"cpu": 3536}, "memory": {"cpu": 512}}, "runningNodes":
{"standard": {"count": 0, "cpu": 0}, "memory": {"count": 0, "cpu": 0}}, "queued
Batches": {"standard": {"count": 0, "cpu": 0}, "memory": {"count": 0, "cpu": 0}
}}
$

See Also

fredcli batch get-status