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=<account>
28 Display information for specific accounts (comma separated
29 list).
30 -a, --all
33 Display information for all users.
34 -M, --clusters=<string>
37 Clusters to issue commands to. Note that the SlurmDBD must be
38 up for this option to work properly.
39 -o, --format=<output_format>
42 Comma separated list of fields (use "--helpformat" for a list of
43 available fields).
44 --help Display a description of sshare options and commands.
47 -l, --long
50 Long listing - includes the normalized usage information.
51 -n, --noheader
54 No header will be added to the beginning of the output.
55 -p, --parsable
58 Output will be '|' delimited with a '|' at the end.
59 -P, --parsable2
62 Output will be '|' delimited without a '|' at the end.
63 -m, --partition
66 If there are association based partitions in the system print
67 their names.
68 --usage
71 Display a description of sshare options and commands.
72 -u, --users=<user_list>
75 Display information for specific users (comma separated list).
76 -U, --Users
79 If specified only the users information are printed, the parent
80 and ancestors are not displayed.
81 -v, --verbose
84 Display more information about the specified options.
85 -V, --version
88 Display the version number of sshare.
89
92 Account
93 The Account.
94 User The User.
97 Raw Shares
100 The raw shares assigned to the user or account.
101 Norm Shares
104 The shares assigned to the user or account normalized to the to‐
105 tal number of assigned shares.
106 Raw Usage
109 The number of tres-seconds (cpu-seconds if TRESBillingWeights is
110 not defined) of all the jobs charged to the account or user.
111 This number will decay over time when PriorityDecayHalfLife is
112 defined.
113 Norm Usage (only appears with sshare -l option)
116 The Raw Usage normalized to the total number of tres-seconds of
117 all jobs run on the cluster, subject to the PriorityDecay‐
118 HalfLife decay when defined.
119 Effectv Usage
122 The Effective Usage augments the normalized usage to account for
123 usage from sibling accounts.
124 FairShare
127 The Fair-Share factor, based on a user or account's assigned
128 shares and the effective usage charged to them or their ac‐
129 counts.
130 GrpTRESMins
133 The TRES-minutes limit set on the account. The total number of
134 cpu minutes that can possibly be used by past, present and fu‐
135 ture jobs running from this account and its children.
136 GrpTRESRaw
139 The raw TRES usage that has been used by jobs running from this
140 account and its children.
141 TRESRunMins
144 The number of TRES-minutes allocated by jobs currently running
145 against the account. Used to limit the combined total number of
146 TRES minutes used by all jobs running with this account and its
147 children. This takes into consideration time limit of running
148 jobs and consumes it, if the limit is reached no new jobs are
149 started until other jobs finish to allow time to free up.
150
153 When PriorityFlags=FAIR_TREE is set (the default, unless NO_FAIR_TREE
154 is set), calculations are done differently. As a result, the following
155 fields are added or modified:
156 Norm Shares
159 The shares assigned to the user or account normalized to the to‐
160 tal number of assigned shares within the level.
161 Effectv Usage
164 Effectv Usage is the association's usage normalized with its
165 parent.
166 Level FS (only appears with sshare -l option)
169 This is the association's fairshare value compared to its sib‐
170 lings, calculated as Norm Shares / Effectv Usage. If an associa‐
171 tion is over-served, the value is between 0 and 1. If an associ‐
172 ation is under-served, the value is greater than 1. Associa‐
173 tions with no usage receive the highest possible value, infin‐
174 ity.
175 More information about Fair Tree can be found in
178 doc/html/fair_tree.html or
179 at https://slurm.schedmd.com/fair_tree.html
180
183 Executing sshare sends a remote procedure call to slurmctld. If enough
184 calls from sshare or other Slurm client commands that send remote pro‐
185 cedure calls to the slurmctld daemon come in at once, it can result in
186 a degradation of performance of the slurmctld daemon, possibly result‐
187 ing in a denial of service.
188 Do not run sshare or other Slurm client commands that send remote pro‐
190 cedure calls to slurmctld from loops in shell scripts or other pro‐
191 grams. Ensure that programs limit calls to sshare to the minimum neces‐
192 sary for the information you are trying to gather.
193
196 Some sshare options may be set via environment variables. These envi‐
197 ronment variables, along with their corresponding options, are listed
198 below. (Note: Command line options will always override these set‐
199 tings.)
200 SLURM_CONF The location of the Slurm configuration file.
202
205 Display information about users in a particular account:
206 $ sshare -A <Account>
208 Display information about a specific user in a parsable format:
211 $ sshare --parsable --users=<User>
213
216 Copyright (C) 2008 Lawrence Livermore National Security. Produced at
217 Lawrence Livermore National Laboratory (cf, DISCLAIMER).
218 Copyright (C) 2010-2021 SchedMD LLC.
219 This file is part of Slurm, a resource management program. For de‐
221 tails, see <https://slurm.schedmd.com/>.
222 Slurm is free software; you can redistribute it and/or modify it under
224 the terms of the GNU General Public License as published by the Free
225 Software Foundation; either version 2 of the License, or (at your op‐
226 tion) any later version.
227 Slurm is distributed in the hope that it will be useful, but WITHOUT
229 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
230 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
231 for more details.
232
235 slurm.conf(5), slurmdbd(8)
236May 2021 Slurm Commands sshare(1)