System commands
system.boot_progress
ROLE: All Roles
Description | Display the system boot progress. | |
Syntax | system.boot_progress | |
Example | system.boot_progress | |
System state: ACTIVE (System is active) |
system.fips_best_practice_check
ROLE: All Roles
Description | Checks the compliance with FIPS best practices. | |
Syntax | system.fips_best_practice_check | |
Example | system.fips_best_practice_check | |
HTTPS Redirection OK (enabled) Certificate Strength OK (2048 bits) Encryption ERROR (disabled) Local Users Disabled ERROR (5 enabled) Local Users Password Hash OK (all SHA256) LDAP Connections Are Secured OK (enabled) |
system.info
ROLE: All Roles
Description | Display general system information. | |
Syntax | system.info | |
Example | Running the command using the grep operator | |
system.info --grep=replica | ||
Replicas 2 | ||
Example | Running the command with no operators | |
system.info | ||
| ||
Example | Querying for BBU information | |
system.info --grep=bbu | ||
BBU CHARGE PERCENT BBU 1: 100%, BBU 2: 100%, BBU 3: 100% Node BBU Protection Node 1: protected, Node 2: protected, Node 3: protected |
system.show_metrics
ROLE: All Roles
Description | System overall traffic This command displays the overall system traffic, broken down to NAS and SAN. For detailed traffic metrics, look for metrics.* commands. | |
Syntax | system.show_metrics [interval=Metrics Interval] [count=POSITIVE] | |
Arguments | court | A positive integer number, greater than zero |
interval | Metrics refresh interval. Max value is 60 | |
Example | system.show_metrics | |
TYPE OPERATIONS THROUGHPUT LATENCY |
system.shutdown
ROLE: Admin
Description | Initiate system shutdown process. |
---|---|
Syntax | system.shutdown |
Example | system.shutdown |
Output | Warning: You are about to shutdown the system. This will stop all IO services to hosted volumes. To avoid potential loss of data, please make sure that no application is accessing the system's volumes. Are you sure you wish to continue? y/n |
system.upgrade
ROLE: Admin
Description | Upload an upgrade package. | |
---|---|---|
Syntax | system.upgrade filename=STR | |
Arguments | filename | Any sequence of characters |
Example | ||
system.upgrade filename=upgrade-file-name |
Last edited: 2022-08-06 08:32:56 UTC
Comments