1sshare(1)                       Slurm Commands                       sshare(1)
2
3
4

NAME

6       sshare - Tool for listing the shares of associations to a cluster.
7
8

SYNOPSIS

10       sshare [OPTIONS...]
11
12

DESCRIPTION

14       sshare  is  used to view Slurm share information.  This command is only
15       viable when running with the priority/multifactor plugin.   The  sshare
16       information  is  derived  from a database with the interface being pro‐
17       vided by slurmdbd (Slurm Database daemon) which is  read  in  from  the
18       slurmctld  and used to process the shares available to a given associa‐
19       tion.  sshare provides Slurm share information of  Account,  User,  Raw
20       Shares,  Normalized  Shares,  Raw  Usage,  Normalized  Usage, Effective
21       Usage, the Fair-share factor, the  GrpTRESMins  limit,  Partitions  and
22       accumulated currently running TRES-minutes for each association.
23
24
25

OPTIONS

27       -A, --accounts=
28              Display  information  for  specific  accounts  (comma  separated
29              list).
30
31
32       -a, --all
33              Display information for all users.
34
35
36       -l, --long
37              Long listing - includes the normalized usage information.
38
39
40       -M, --clusters=<string>
41              Clusters to issue commands to.  Note that the SlurmDBD  must  be
42              up for this option to work properly.
43
44
45       -m, --partition
46              If  there  are  association based partitions in the system print
47              their names.
48
49
50       -n, --noheader
51              No header will be added to the beginning of the output.
52
53
54       -o, --format=
55              Comma separated list of fields (use "--helpformat" for a list of
56              available fields).
57
58
59       -p, --parsable
60              Output will be '|' delimited with a '|' at the end.
61
62
63       -P, --parsable2
64              Output will be '|' delimited without a '|' at the end.
65
66
67       -u, --users=
68              Display information for specific users (comma separated list).
69
70
71       -U, --Users
72              If  specified only the users information are printed, the parent
73              and ancestors are not displayed.
74
75
76       -v, --verbose
77              Display more information about the specified options.
78
79
80       -V, --version
81              Display the version number of sshare.
82
83
84       --help --usage Display a description of sshare options and commands.
85
86

SSHARE OUTPUT FIELDS

88       Account
89              The Account.
90
91
92       User   The User.
93
94
95       Raw Shares
96              The raw shares assigned to the user or account.
97
98
99       Norm Shares
100              The shares assigned to the user or  account  normalized  to  the
101              total number of assigned shares.
102
103
104       Raw Usage
105              The number of tres-seconds (cpu-seconds if TRESBillingWeights is
106              not defined) of all the jobs charged to  the  account  or  user.
107              This  number  will decay over time when PriorityDecayHalfLife is
108              defined.
109
110
111       Norm Usage (only appears with sshare -l option)
112              The Raw Usage normalized to the total number of tres-seconds  of
113              all  jobs  run  on  the  cluster,  subject to the PriorityDecay‐
114              HalfLife decay when defined.
115
116
117       Effectv Usage
118              The Effective Usage augments the normalized usage to account for
119              usage from sibling accounts.
120
121
122       FairShare
123              The  Fair-Share  factor,  based  on a user or account's assigned
124              shares  and  the  effective  usage  charged  to  them  or  their
125              accounts.
126
127
128       GrpTRESMins
129              The  TRES-minutes  limit set on the account. The total number of
130              cpu minutes that can possibly  be  used  by  past,  present  and
131              future jobs running from this account and its children.
132
133
134       GrpTRESRaw
135              The  raw TRES usage that has been used by jobs running from this
136              account and its children.
137
138
139       TRESRunMins
140              The number of TRES-minutes allocated by jobs  currently  running
141              against  the account. Used to limit the combined total number of
142              TRES minutes used by all jobs running with this account and  its
143              children.   This  takes into consideration time limit of running
144              jobs and consumes it, if the limit is reached no  new  jobs  are
145              started until other jobs finish to allow time to free up.
146
147

FAIR_TREE MODIFICATIONS

149       When  PriorityFlags=FAIR_TREE  is set (the default, unless NO_FAIR_TREE
150       is set), calculations are done differently.  As a result, the following
151       fields are added or modified:
152
153
154       Norm Shares
155              The  shares  assigned  to  the user or account normalized to the
156              total number of assigned shares within the level.
157
158
159       Effectv Usage
160              Effectv Usage is the association's  usage  normalized  with  its
161              parent.
162
163
164       Level FS (only appears with sshare -l option)
165              This  is  the association's fairshare value compared to its sib‐
166              lings, calculated as Norm Shares / Effectv Usage. If an associa‐
167              tion is over-served, the value is between 0 and 1. If an associ‐
168              ation is under-served, the value is greater  than  1.   Associa‐
169              tions  with  no usage receive the highest possible value, infin‐
170              ity.
171
172
173       More   information    about    Fair    Tree    can    be    found    in
174       doc/html/fair_tree.html or
175              at https://slurm.schedmd.com/fair_tree.html
176
177

ENVIRONMENT VARIABLES

179       Some  sshare  options may be set via environment variables. These envi‐
180       ronment variables, along with their corresponding options,  are  listed
181       below.  (Note: commandline options will always override these settings)
182
183       SLURM_CONF          The location of the Slurm configuration file.
184
185

EXAMPLES

187       > sshare -A <Account>
188       > sshare --parsable --users=<User>
189
190
191

COPYING

193       Copyright  (C)  2008 Lawrence Livermore National Security.  Produced at
194       Lawrence Livermore National Laboratory (cf, DISCLAIMER).
195       Copyright (C) 2010-2013 SchedMD LLC.
196
197       This file is  part  of  Slurm,  a  resource  management  program.   For
198       details, see <https://slurm.schedmd.com/>.
199
200       Slurm  is free software; you can redistribute it and/or modify it under
201       the terms of the GNU General Public License as published  by  the  Free
202       Software  Foundation;  either  version  2  of  the License, or (at your
203       option) any later version.
204
205       Slurm is distributed in the hope that it will be  useful,  but  WITHOUT
206       ANY  WARRANTY;  without even the implied warranty of MERCHANTABILITY or
207       FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General  Public  License
208       for more details.
209
210

SEE ALSO

212       slurm.conf(5), slurmdbd(8)
213
214
215
216April 2015                      Slurm Commands                       sshare(1)
Impressum