There are some commands that OSC has created custom versions of to be more useful to OSC users.
OSCfinger is a command developed at OSC for use on OSC's systems and is similar to the standard finger command. It allows various account information to be viewed.
owens | PITZER |
---|---|
X |
X |
OSCfinger takes the following options and parameters.
$ OSCfinger -h usage: OSCfinger.py [-h] [-e] [-g] USER positional arguments: USER optional arguments: -h, --help show this help message and exit -e Extend search to include gecos/full name (user) or category/institution (group) -g, --group Query group instead of users Query user: OSCfinger foobar Query by first or last name: OSCfinger -e Foo OSCfinger -e Bar Query group: OSCfinger -g PZS0001 Query group by category or insitituion: OSCfinger -e -g OSC
The OSCfinger command can be used to view account information given a username.
$ OSCfinger jsmith Login: xxx Name: John Smith Directory: xxx Shell: /bin/bash E-mail: xxx Primary Group: PPP1234 Groups:
The OSCfinger command can also reveal details about a project using the -g
flag.
$ OSCfinger -g PPP1234 Group: PPP1234 GID: 1234 Status: ACTIVE Type: Academic Principal Investigator: xxx Admins: NA Members: xxx Category: NA Institution: OHIO SUPERCOMPUTER CENTER Description: xxx ---
If the username is not known, a lookup can be initiated using the -e
flag.
This example is shown using the lookup for a first and last name.
$ OSCfinger -e "John Smith" Login: jsmith Name: John Smith Directory: xxx Shell: /bin/bash E-mail: NA Primary Group: PPP1234 Groups: xxx Password Changed: Jul 04 1776 15:47 (calculated) Password Expires: Aug 21 1778 12:05 AM Login Disabled: FALSE Password Expired: FALSE ---
One can also lookup users with only the last name:
$ OSCfinger -e smith Login: jsmith Name: John Smith Directory: xxx Shell: /bin/bash E-mail: NA Primary Group: PPP1234 Groups: --- Login: asmith Name: Anne Smith Directory: xxx Shell: /bin/bash E-mail: xxx Primary Group: xxx Groups: ---
Only the first name can also be used, but many accounts are likely to be returned.
$ OSCfinger -e John Login: jsmith Name: John Smith Directory: xxx Shell: /bin/bash E-mail: xxx Primary Group: PPP1234 Groups: --- Login: xxx Name: John XXX Directory: xxx Shell: /bin/bash E-mail: xxx Primary Group: xxx Groups: --- Login: xxx Name: John XXX Directory: xxx Shell: /bin/ksh E-mail: xxx Primary Group: xxx Groups: --- ...(more accounts below)...
While in a slurm environment, the OSCfinger command shows some additional information:
$ OSCfinger jsmith Login: xxx Name: John Smith Directory: xxx Shell: /bin/bash E-mail: xxx Primary Group: PPP1234 Groups: SLURM Enabled: TRUE SLURM Clusters: pitzer SLURM Accounts: PPP1234, PPP4321 SLURM Default Account: PPPP1234
It's important to note that the default account in slurm will be used if an account is not specified at job submission.
OSCgetent is a command developed at OSC for use on OSC's systems and is similar to the standard getent command. It lets one view group information.
owens | PITZER |
---|---|
X |
X |
OSCgetent takes the following options and parameters.
$ OSCgetent -h usage: OSCgetent.py [-h] {group} [name [name ...]] positional arguments: {group} name optional arguments: -h, --help show this help message and exit Query group: OSCgetent.py group PZS0708 Query multiple groups: OSCgetent.py group PZS0708 PZS0709
The OSCgetent command can be used to view group(s) members:
$ OSCgetent group PZS0712 PZS0712:*:5513:amarcum,amarcumtest,amarcumtest2,guilfoos,hhamblin,kcahill,xwang
$ OSCgetent group PZS0712 PZS0708 PZS0708:*:5509:djohnson,ewahl,kearley,kyriacou,linli,soottikkal,tdockendorf,troy PZS0712:*:5513:amarcum,amarcumtest,amarcumtest2,guilfoos,hhamblin,kcahill,xwang
OSCprojects is a command developed at OSC for use on OSC's systems and is used to view your logged in accounts project information.
owens | PITZER |
---|---|
X |
X |
OSCprojects does not take any arguments or options:
$ OSCprojects OSC projects for user amarcumtest2: Project Status Members ------- ------ ------- PZS0712 ACTIVE amarcumtest2,amarcumtest,guilfoos,amarcum,xwang PZS0726 ACTIVE amarcumtest2,xwangtest,amarcum
This command returns the current users projects, whether those projects are active/restricted and the current members of the projects.
OSCusage is command developed at OSC for use on OSC's systems. It allows for a user to see information on their project's usage, including different users and their jobs.
owens | PITZER |
---|---|
X | X |
OSCusage takes the following options and parameters.
$ OSCusage --help usage: OSCusage.py [-h] [-u USER] [-s {opt,pitzer,glenn,bale,oak,oakley,owens,ruby}] [-A] [-P PROJECT] [-q] [-H] [-r] [-n] [-v] [start_date] [end_date] positional arguments: start_date start date (default: 2021-03-16) end_date end date (default: 2021-03-17) optional arguments: -h, --help show this help message and exit -u USER, --user USER username to run as. Be sure to include -P or -A. (default: amarcum) -s {opt,pitzer,glenn,bale,oak,oakley,owens,ruby}, --system {opt,pitzer,glenn,bale,oak,oakley,owens,ruby} -A Show all -P PROJECT, --project PROJECT project to query (default: PZS0712) -q show user data -H show hours -r show raw -n show job ID -v do not summarize -J, --json Print data as JSON -C, --current-unbilled show current unbilled usage -p {month,quarter,annual}, --period {month,quarter,annual} Period used when showing unbilled usage (default: month) -N JOB_NAME, --job-name JOB_NAME Filter jobs by job name, supports substring match and regex (does not apply to JSON output)
Usage Examples: Specify start time: OSCusage 2018-01-24 Specify start and end time: OSCusage 2018-01-24 2018-01-25 View current unbilled usage: OSCusage -C -p month
Running OSCusage with no options or parameters specified will provide the usage information in Dollars for the current day.
$ OSCusage ---------------- ------------------------------------ Usage Statistics for project PZS0712 Time 2021-03-16 to 2021-03-17 PI guilfoos@osc.edu Remaining Budget -1.15 ---------------- ------------------------------------ User Jobs Dollars Status ------------ ------ --------- -------- amarcum 0 0.0 ACTIVE amarcumtest 0 0.0 ACTIVE amarcumtest2 0 0.0 ACTIVE guilfoos 0 0.0 ACTIVE hhamblin 0 0.0 ACTIVE kcahill 0 0.0 ACTIVE wouma 0 0.0 ACTIVE xwang 12 0.0 ACTIVE -- -- -- TOTAL 12 0.0
If you specify a timeframe you can get utilization information specifically for jobs that completed within that period.
$ OSCusage 2020-01-01 2020-07-01 -H ---------------- ------------------------------------ Usage Statistics for project PZS0712 Time 2020-01-01 to 2020-07-01 PI Brian Guilfoos <guilfoos@osc.edu> Remaining Budget -1.15 ---------------- ------------------------------------ User Jobs core-hours Status ------------ ------ ------------ ---------- amarcum 86 260.3887 ACTIVE amarcumtest 0 0.0 ACTIVE amarcumtest2 0 0.0 RESTRICTED guilfoos 9 29.187 ACTIVE hhamblin 1 1.01 ACTIVE kcahill 7 40.5812 ACTIVE wouma 63 841.2503 ACTIVE xwang 253 8148.2638 ACTIVE -- -- -- TOTAL 419 9320.681
Specify -q
to show only the current user's usage. This stacks with -u
to specify which user you want to see.
$ OSCusage -u xwang -q 2020-01-01 2020-07-01 -H ---- ------------------------------- Usage Statistics for user xwang Time 2020-01-01 to 2020-07-01 ---- ------------------------------- User Jobs core-hours Status ------ ------ ------------ -------- xwang 253 8148.2638 - -- -- -- TOTAL 253 8148.2638
By default, the tool shows your default (first) project. You can use -P
to specify which charge code to report on.
$ OSCusage -P PZS0200 -H ---------------- ------------------------------------ Usage Statistics for project PZS0200 Time 2020-09-13 to 2020-09-14 PI David Hudak <dhudak@osc.edu> Remaining Budget 0 ---------------- ------------------------------------ User Jobs core-hours Status ---------- ------ ------------ ---------- adraghi 0 0.0 ARCHIVED airani 0 0.0 ARCHIVED alingg 0 0.0 ARCHIVED
You can show all of your charge codes/projects at once, by using -A
.
By default, all charges are shown in the output. However, you can filter to show a particular system with -s
.
$ OSCusage -s pitzer -H ---------------- ------------------------------------ Usage Statistics for project PZS0712 Time 2021-03-16 to 2021-03-17 PI guilfoos@osc.edu Remaining Budget -1.15 ---------------- ------------------------------------ User Jobs core-hours Status ------------ ------ ------------ -------- amarcum 0 0.0 ACTIVE amarcumtest 0 0.0 ACTIVE amarcumtest2 0 0.0 ACTIVE guilfoos 0 0.0 ACTIVE hhamblin 0 0.0 ACTIVE kcahill 0 0.0 ACTIVE wouma 0 0.0 ACTIVE xwang 0 0.0 ACTIVE -- -- -- TOTAL 0 0.0
The report can show usage dollars. You can elect to get usage in core-hours using -H
or raw seconds using -r
$ OSCusage 2020-01-01 2020-07-01 -r ---------------- ------------------------------------ Usage Statistics for project PZS0712 Time 2020-01-01 to 2020-07-01 PI Brian Guilfoos <guilfoos@osc.edu> Remaining Budget -1.15 ---------------- ------------------------------------ User Jobs raw_used Status ------------ ------ ---------- ---------- amarcum 86 937397.0 ACTIVE amarcumtest 0 0.0 ACTIVE amarcumtest2 0 0.0 RESTRICTED guilfoos 9 105073.0 ACTIVE hhamblin 1 3636.0 ACTIVE kcahill 7 146092.0 ACTIVE wouma 63 3028500.0 ACTIVE xwang 253 29333749.0 ACTIVE -- -- -- TOTAL 419 33554447.0 Detailed Charges Breakdown
Specify -v
to get detailed information jobs.
You can add the -n
option to the -v
option to add the job ID to the report output. OSCHelp will need the job ID to answer any questions about a particular job record.
Please contact OSC Help with questions.