Skip to content
Snippets Groups Projects
Commit 75ab4190 authored by Jan Siwiec's avatar Jan Siwiec
Browse files

Edit cli-client-tools.md

parent 15116a07
Branches
No related tags found
No related merge requests found
Pipeline #43979 failed
# SCS CLI Client Tools # SCS CLI Client Tools
## Configuration
System wide configuration -> `etc/scs-cli-client-tools/config.toml`
User configuration -> `$XDG_CONFIG_HOME/scs-cli-client-tools/config.toml`
## it4ifree ## it4ifree
`MUNGE_SOCK` - the path to the munged socket.
`CLUSTERNAME` - name of the cluster `it4ifree` is running on.
`API_URL` - set this environment variable to the API address.
[default: `https://scs.it4i.cz/api/v2/`]
---
```code
List project resource usage data from SCS IS. List project resource usage data from SCS IS.
Also available at [https://scs.it4i.cz][a]. Also available at [https://scs.it4i.cz][a].
Usage: it4ifree [OPTIONS] Usage: it4ifree `[OPTIONS]`
```code
Options: Options:
-p, --percent -p, --percent
-P, --project <PROJECT> -P, --project <PROJECT>
...@@ -70,19 +58,18 @@ Options: ...@@ -70,19 +58,18 @@ Options:
## it4imotd ## it4imotd
`API_URL` - set this environment variable to the API address. [default: `https://scs.it4i.cz/api/v2/`] The command shows IT4I messages of the day.
```code
The command shows IT4I messages of the day
Usage: it4imotd [OPTIONS] Usage: it4imotd `[OPTIONS]`
```code
Options: Options:
-w, --width <WIDTH> [default: 78] -w, --width <WIDTH> [default: 78]
-c, --category <CATEGORY> [possible values: public-service-announcement, service-recovered-up, critical-service-down, service-hard-down, auxiliry-service-down, planned-outage, service-degraded, important, notice] -c, --category <CATEGORY> [possible values: public-service-announcement, service-recovered-up, critical-service-down, service-hard-down, auxiliry-service-down, planned-outage, service-degraded, important, notice]
-h, --help Print help -h, --help Print help
-V, --version Print version -V, --version Print version
``` ```
### Example Output of 'it4imotd'
```code ```code
Critical service down: Unplanned Power Outage Critical service down: Unplanned Power Outage
...@@ -97,18 +84,14 @@ any inconvenience. ...@@ -97,18 +84,14 @@ any inconvenience.
## it4ifsusage ## it4ifsusage
`MUNGE_SOCK` - the path to the munged socket.
`CLUSTERNAME` - name of the cluster `it4ifsusage` is running on.
`API_URL` - set this environment variable to the API address. [default: `https://scs.it4i.cz/api/v2/`]
```code
The command shows filesystem usage of IT4I cluster storage systems The command shows filesystem usage of IT4I cluster storage systems
User quotas are always active, expiration timestamps signify an end of a temporary quota increase. User quotas are always active, expiration timestamps signify an end of a temporary quota increase.
Project quotas are active during the lifetime of a project. Project quotas are active during the lifetime of a project.
Usage: it4ifsusage [OPTIONS] Usage: it4ifsusage `[OPTIONS]`
```code
Options: Options:
-s, --status <STATUS> [default: active] [possible values: active, expired, all] -s, --status <STATUS> [default: active] [possible values: active, expired, all]
-j, --json Output to json instead of a table -j, --json Output to json instead of a table
...@@ -116,6 +99,8 @@ Options: ...@@ -116,6 +99,8 @@ Options:
-V, --version Print version -V, --version Print version
``` ```
### Example Output of 'it4ifsusage'
```code ```code
╭────────────┬───────────────┬─────────────┬────────────┬─────────────┬──────────────┬───────────────┬────────────┬────────────────────────────╮ ╭────────────┬───────────────┬─────────────┬────────────┬─────────────┬──────────────┬───────────────┬────────────┬────────────────────────────╮
│ Quota Type ┆ Cluster / PID ┆ File System ┆ Space Used ┆ Space Limit ┆ Entries Used ┆ Entries Limit ┆ Expiration ┆ Last Update │ │ Quota Type ┆ Cluster / PID ┆ File System ┆ Space Used ┆ Space Limit ┆ Entries Used ┆ Entries Limit ┆ Expiration ┆ Last Update │
...@@ -130,9 +115,9 @@ Options: ...@@ -130,9 +115,9 @@ Options:
## it4idedicatedtime ## it4idedicatedtime
```code Usage: it4idedicatedtime `[OPTIONS]`
Usage: it4idedicatedtime [OPTIONS]
```code
Options: Options:
-s, --status <STATUS> [default: active] [possible values: active, planned] -s, --status <STATUS> [default: active] [possible values: active, planned]
-c, --cluster <CLUSTER> [default: all] [possible values: all, barbora, karolina, comp-sys, dgx] -c, --cluster <CLUSTER> [default: all] [possible values: all, barbora, karolina, comp-sys, dgx]
...@@ -141,6 +126,8 @@ Options: ...@@ -141,6 +126,8 @@ Options:
-V, --version Print version -V, --version Print version
``` ```
### Example Output of 'it4idedicatedtime'
```code ```code
╭─────────┬─────────────────────┬─────────────────────┬─────────────────────╮ ╭─────────┬─────────────────────┬─────────────────────┬─────────────────────╮
│ Cluster ┆ Start ┆ End ┆ Last Update │ │ Cluster ┆ Start ┆ End ┆ Last Update │
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment