Using pbs_stat
You use pbs_stat to status and filter PBS entities on given attributes.
Warning: All output of this unsupported tool is experimental. Do not rely on it remaining as it is across releases.
How to run pbs_stat
If you have installed PTL, this should be in your PATH. If it is not, cd to the installation directory's bin directory.
Syntax:
pbs_stat [<option(s)>]
Options to pbs_stat
-A <path to accounting log>
Path to accounting log. Can be relative or absolute. No default.
-a <filters>
Comma-separated list of attributes ### what do we do with them? include jobs that have them?
Filters are <key><OP><value> pairs where OP is one of <,<=,=,>=,>,~
-b
Show available resources (a.k.a backfill hole) ### stdout? ### what is a backfill hole, and how do we show it?
-c
Count number of matching items ### matching what? output of -a?
-C
Count grand total of given attribute values in complex ### matching, or ... what?
-d <path to output of pbs_diag>
path to diag directory ### default? abs/rel?
-j
Report job equivalence classes ### what about them? number of classes? Population of each class?
-n
Report node equivalence classes ### same as above
-r <resource name(s)>
Comma-separated list of resource names, e.g. ncpus, mem. ### what do we do with this list? specify resources for utilization? anything else? ### default is ncpus, mem, nodes?
-s
Show selected objects in qselect-like format ### which objects have we selected? output of -a?
-t <hostname>
Target hostname ### what do we do with this hostname?
-T
Report total resources available. Operates only on equivalence classes ### in complex? at queue?
-U
Show current utilization of the system
Use with -r option to specify resources. Defaults to ncpus, mem, nodes ### untangle from -r
--cli
Force stat to query PBS server over CLI
--db-access=<DB access credential>
File of credentials to access DB
--dedtime-file=<dedicated time file>
path to a dedicated time file ### default, abs/rel?
--eval-formula
Evaluate job priority ### of all jobs? of backfill_depth? At server? Queue?
--fairshare-info=<entity>
Display fairshare info of entity
--fairshare-tree
Display fairshare tree
--group=<groupname>
Group to query for limits or utilization ### same as above
--id=<object ID>
Object to query
--include-running-jobs
Include running jobs in formula evaluation
--jobs
Operate on jobs ### default, abs/rel?
--jobs-file=<output of qstat -f>
path to file with output of qstat -f ### default, abs/rel?
--json
Display object type information in JSON format
--key=<account record>
Accounting record key, one of Q or E ### what do we do with these records?
--limits-info
Show limit information per entity and object ### what's the difference between an entity and an object? MoM and comm are entity but not object?
--log-conf=<logging config file>
logging config file ### default, abs/rel?
--mode
Show operating mode of PTL; one of cli or api
--nodes
Operate on node ### does this mean, query node for jobs, resource usage, etc?
--nodes-file=<output of pbsnodes -av>
path to file with output of pbsnodes -av ### default, abs/rel?
--over-soft-limits
Show entities that are over their soft limits
--pports
Show number of privileged ports in use
--project=<project>
Project to query for limits ### default, abs/rel?
--queues
Operate on queues ### default, abs/rel?
--queues-file=<output of qstat -Qf>
path to file with output of qstat -Qf ### default, abs/rel?
--report
Produce a site report ### what is a site report?
--report-twiki
Produce report in Twiki format ### what format is this?
--resolve-indirectness
If set, dereference indirect resources ### what do we get without this option?
--resource=<resource name>
Name of resource to stat ### what does it mean to stat a resource? Are we getting resources_available.<resource name>?
--resources
Operate on resources ### what does this mean?
--resources-set
List resources set for a given object type ### argument? what's the format?
--resvs
Operate on reservations ### default, abs/rel?
--resvs-file=<output of pbs_rstat -f>
path to file with output of pbs_rstat -f ### default, abs/rel?
--scheduler
Operate on scheduler ### default, abs/rel?
--server
Operate on server ### default, abs/rel?
--server-file=<path to output of qstat -Bf>
Path to file with output of qstat -Bf ### default? abs/rel?
--sline
Show selected objects on a single line
Does not affect output of --json, -j, -s, or -n options
--user=<username>
Username to query for limits or utilization ### we're querying for usage by this user's jobs, right?
--version:
Print version number and exit