1sshare(1) Slurm Commands sshare(1)
2
6 sshare - Tool for listing the shares of associations to a cluster.
7
10 sshare [OPTIONS...]
11
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 Us‐
21 age, the Fair-share factor, the GrpTRESMins limit, Partitions and accu‐
22 mulated currently running TRES-minutes for each association.
23
27 -A, --accounts=
28 Display information for specific accounts (comma separated
29 list).
30 -a, --all
33 Display information for all users.
34 -l, --long
37 Long listing - includes the normalized usage information.
38 -M, --clusters=<string>
41 Clusters to issue commands to. Note that the SlurmDBD must be
42 up for this option to work properly.
43 -m, --partition
46 If there are association based partitions in the system print
47 their names.
48 -n, --noheader
51 No header will be added to the beginning of the output.
52 -o, --format=
55 Comma separated list of fields (use "--helpformat" for a list of
56 available fields).
57 -p, --parsable
60 Output will be '|' delimited with a '|' at the end.
61 -P, --parsable2
64 Output will be '|' delimited without a '|' at the end.
65 -u, --users=
68 Display information for specific users (comma separated list).
69 -U, --Users
72 If specified only the users information are printed, the parent
73 and ancestors are not displayed.
74 -v, --verbose
77 Display more information about the specified options.
78 -V, --version
81 Display the version number of sshare.
82 --help --usage Display a description of sshare options and commands.
85
88 Account
89 The Account.
90 User The User.
93 Raw Shares
96 The raw shares assigned to the user or account.
97 Norm Shares
100 The shares assigned to the user or account normalized to the to‐
101 tal number of assigned shares.
102 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 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 Effectv Usage
118 The Effective Usage augments the normalized usage to account for
119 usage from sibling accounts.
120 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 ac‐
125 counts.
126 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 fu‐
131 ture jobs running from this account and its children.
132 GrpTRESRaw
135 The raw TRES usage that has been used by jobs running from this
136 account and its children.
137 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
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 Norm Shares
155 The shares assigned to the user or account normalized to the to‐
156 tal number of assigned shares within the level.
157 Effectv Usage
160 Effectv Usage is the association's usage normalized with its
161 parent.
162 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 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
179 Executing sshare sends a remote procedure call to slurmctld. If enough
180 calls from sshare or other Slurm client commands that send remote pro‐
181 cedure calls to the slurmctld daemon come in at once, it can result in
182 a degradation of performance of the slurmctld daemon, possibly result‐
183 ing in a denial of service.
184 Do not run sshare or other Slurm client commands that send remote pro‐
186 cedure calls to slurmctld from loops in shell scripts or other pro‐
187 grams. Ensure that programs limit calls to sshare to the minimum neces‐
188 sary for the information you are trying to gather.
189
192 Some sshare options may be set via environment variables. These envi‐
193 ronment variables, along with their corresponding options, are listed
194 below. (Note: commandline options will always override these settings)
195 SLURM_CONF The location of the Slurm configuration file.
197
200 Display information about users in a particular account:
201 $ sshare -A <Account>
203 Display information about a specific user in a parsable format:
206 $ sshare --parsable --users=<User>
208
211 Copyright (C) 2008 Lawrence Livermore National Security. Produced at
212 Lawrence Livermore National Laboratory (cf, DISCLAIMER).
213 Copyright (C) 2010-2013 SchedMD LLC.
214 This file is part of Slurm, a resource management program. For de‐
216 tails, see <https://slurm.schedmd.com/>.
217 Slurm is free software; you can redistribute it and/or modify it under
219 the terms of the GNU General Public License as published by the Free
220 Software Foundation; either version 2 of the License, or (at your op‐
221 tion) any later version.
222 Slurm is distributed in the hope that it will be useful, but WITHOUT
224 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
225 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
226 for more details.
227
230 slurm.conf(5), slurmdbd(8)
231February 2021 Slurm Commands sshare(1)