Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
docs.it4i.cz
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
SCS
docs.it4i.cz
Merge requests
!491
Update 2 files
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
Update 2 files
portalandapi
into
master
Overview
0
Commits
4
Pipelines
1
Changes
4
Merged
Jan Siwiec
requested to merge
portalandapi
into
master
2 months ago
Overview
0
Commits
4
Pipelines
1
Changes
4
Expand
/docs.it4i/apiv2.md
/mkdocs.yml
0
0
Merge request reports
Compare
master
master (base)
and
latest version
latest version
595eb424
4 commits,
2 months ago
4 files
+
356
−
297
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
Files
4
Search (e.g. *.vue) (Ctrl+P)
docs.it4i/general/tools/cli-client-tools.md
0 → 100644
+
151
−
0
Options
# 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
`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.
Also available at [https://scs.it4i.cz][a].
Usage: it4ifree [OPTIONS]
Options:
-p, --percent
-P, --project <PROJECT>
-u, --per-user
-s, --status <STATUS> [possible values: active, planned, expired, all]
-S, --show-status Show status of project resource
--no-status Hide status of project resource
-q, --qos Show a column with the QoS value for resource
-i, --icons <ICONS> When enabled shows emojis for better readability [default: auto] [possible values: always, auto, never]
-j, --json Print in json format
-h, --help Print help
-V, --version Print version
```
### Example Output of 'it4ifree'
```
code
╭─────────────┬──────────────┬───────────────┬──────────────────────────┬────────────┬───────┬──────────────╮
│ Project PID ┆ Resource ┆ Resource Type ┆ Validity Period ┆ Allocation ┆ Usage ┆ Time left │
╞═════════════╪══════════════╪═══════════════╪══════════════════════════╪════════════╪═══════╪══════════════╡
│ OPEN-21-48 ┆ Barbora CPU ┆ Node Hours ┆ 2024-11-15 to 2025-08-11 ┆ 20000.00 ┆ 0.00 ┆ 145d 14h 25m │
│ ┆ Karolina CPU ┆ Node Hours ┆ 2024-11-15 to 2025-08-11 ┆ 20000.00 ┆ 0.00 ┆ 145d 14h 25m │
│ ┆ Karolina GPU ┆ Node Hours ┆ 2024-11-15 to 2025-08-11 ┆ 6900.00 ┆ 0.00 ┆ 145d 14h 25m │
╰─────────────┴──────────────┴───────────────┴──────────────────────────┴────────────┴───────┴──────────────╯
```
### Example Output of 'it4ifree -u -s all'
```
code
╭───────────────────┬──────────────┬───────────────┬──────────────────────────┬────────────┬───────────────┬────────────┬──────────────╮
│ Project PID ┆ Resource ┆ Resource Type ┆ Validity Period ┆ Allocation ┆ User / Total ┆ Usage ┆ Time left │
╞═══════════════════╪══════════════╪═══════════════╪══════════════════════════╪════════════╪═══════════════╪════════════╪══════════════╡
│ OPEN-21-16 [PI] ┆ Karolina GPU ┆ Node Hours ┆ 2023-01-01 to 2023-12-31 ┆ 50000.00 ┆ =Usage Total= ┆ 25000.00 ┆ 25d 4h 12m │
│ ┆ ┆ ┆ ┆ ┆ user1 ┆ 10000.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ user2 ┆ 7500.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ user3 ┆ 7500.00 ┆ │
│ OPEN-22-05 ┆ Barbora CPU ┆ Legacy NCH ┆ 2022-06-01 to 2023-06-01 ┆ 10000.00 ┆ =Usage Total= ┆ 8000.00 ┆ 118d 18h 49m │
│ ┆ ┆ ┆ ┆ ┆ user4 ┆ 3000.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ user5 ┆ 5000.00 ┆ │
│ OPEN-23-10 ┆ Karolina CPU ┆ Node Hours ┆ 2023-03-01 to 2024-03-01 ┆ 75000.00 ┆ =Usage Total= ┆ 30000.00 ┆ 15d 11h 19m │
│ ┆ ┆ ┆ ┆ ┆ user6 ┆ 15000.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ user7 ┆ 15000.00 ┆ │
│ OPEN-20-08 ┆ Barbora GPU ┆ Legacy NCH ┆ 2020-05-01 to 2023-05-01 ┆ 20000.00 ┆ =Usage Total= ┆ 20000.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ user8 ┆ 10000.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ user9 ┆ 10000.00 ┆ │
╰───────────────────┴──────────────┴───────────────┴──────────────────────────┴────────────┴───────────────┴────────────┴──────────────╯
```
## it4imotd
`API_URL`
- set this environment variable to the API address. [default:
`https://scs.it4i.cz/api/v2/`
]
```
code
The command shows IT4I messages of the day
Usage: it4imotd [OPTIONS]
Options:
-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]
-h, --help Print help
-V, --version Print version
```
```
code
Critical service down: Unplanned Power Outage
Posted: 2024-09-13 12:35:18
Outage: 2024-12-17 14:27:43 to 2025-12-17 18:27:43
Affected systems: Barbora, Karolina
Due to an unplanned power outage, several nodes on both the Karolina and
Barbora clusters went down, which affected some running jobs. We apologize for
any inconvenience.
```
## 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
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.
Usage: it4ifsusage [OPTIONS]
Options:
-s, --status <STATUS> [default: active] [possible values: active, expired, all]
-j, --json Output to json instead of a table
-h, --help Print help
-V, --version Print version
```
```
code
╭────────────┬───────────────┬─────────────┬────────────┬─────────────┬──────────────┬───────────────┬────────────┬────────────────────────────╮
│ Quota Type ┆ Cluster / PID ┆ File System ┆ Space Used ┆ Space Limit ┆ Entries Used ┆ Entries Limit ┆ Expiration ┆ Last Update │
╞════════════╪═══════════════╪═════════════╪════════════╪═════════════╪══════════════╪═══════════════╪════════════╪════════════════════════════╡
│ User ┆ Barbora ┆ /home ┆ 86 KB ┆ 25 GB ┆ 20 ┆ 500,000 ┆ ┆ 2025-03-19 10:50:20 │
│ User ┆ Barbora ┆ /scratch ┆ 0 B ┆ 10 TB ┆ 0 ┆ 10,000,000 ┆ ┆ 2025-03-19 10:50:31 │
│ User ┆ Karolina ┆ /home ┆ 641.7 MB ┆ 25 GB ┆ 15,462 ┆ 500,000 ┆ ┆ 2025-03-19 10:40:34 │
│ User ┆ Karolina ┆ /scratch ┆ 0 B ┆ 0 B ┆ 0 ┆ 0 ┆ ┆ 2025-03-19 10:40:49 │
│ Project ┆ OPEN-18-36 ┆ proj3 ┆ 642.9 GB ┆ 1 TB ┆ 577,894 ┆ 1,000,000 ┆ 2039-01-19 ┆ 2025-03-19 10:40:02.722305 │
╰────────────┴───────────────┴─────────────┴────────────┴─────────────┴──────────────┴───────────────┴────────────┴────────────────────────────╯
```
## it4idedicatedtime
```
code
Usage: it4idedicatedtime [OPTIONS]
Options:
-s, --status <STATUS> [default: active] [possible values: active, planned]
-c, --cluster <CLUSTER> [default: all] [possible values: all, barbora, karolina, comp-sys, dgx]
-j, --json
-h, --help Print help
-V, --version Print version
```
```
code
╭─────────┬─────────────────────┬─────────────────────┬─────────────────────╮
│ Cluster ┆ Start ┆ End ┆ Last Update │
╞═════════╪═════════════════════╪═════════════════════╪═════════════════════╡
│ Barbora ┆ 2023-07-19 07:00:00 ┆ 2025-07-23 23:22:00 ┆ 2023-07-16 23:23:33 │
╰─────────┴─────────────────────┴─────────────────────┴─────────────────────╯
```
[
a
]:
https://scs.it4i.cz
\ No newline at end of file
Loading