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
32 Display information for all users.
33 -M, --clusters=<string>
35 Clusters to issue commands to. Note that the SlurmDBD must be
36 up for this option to work properly.
37 -o, --format=<output_format>
39 Comma separated list of fields (use "--helpformat" for a list of
40 available fields).
41 --help Display a description of sshare options and commands.
43 -l, --long
45 Long listing - includes the normalized usage information.
46 -n, --noheader
48 No header will be added to the beginning of the output.
49 -p, --parsable
51 Output will be '|' delimited with a '|' at the end.
52 -P, --parsable2
54 Output will be '|' delimited without a '|' at the end.
55 -m, --partition
57 If there are association based partitions in the system print
58 their names.
59 --usage
61 Display a description of sshare options and commands.
62 -u, --users=<user_list>
64 Display information for specific users (comma separated list).
65 -U, --Users
67 If specified only the users information are printed, the parent
68 and ancestors are not displayed.
69 -v, --verbose
71 Display more information about the specified options.
72 -V, --version
74 Display the version number of sshare.
75
77 Account
78 The Account.
79 User The User.
81 Raw Shares
83 The raw shares assigned to the user or account.
84 Norm Shares
86 The shares assigned to the user or account normalized to the to‐
87 tal number of assigned shares.
88 Raw Usage
90 The number of tres-seconds (cpu-seconds if TRESBillingWeights is
91 not defined) of all the jobs charged to the account or user.
92 This number will decay over time when PriorityDecayHalfLife is
93 defined.
94 Norm Usage (only appears with sshare -l option)
96 The Raw Usage normalized to the total number of tres-seconds of
97 all jobs run on the cluster, subject to the PriorityDecay‐
98 HalfLife decay when defined.
99 Effectv Usage
101 The Effective Usage augments the normalized usage to account for
102 usage from sibling accounts.
103 FairShare
105 The Fair-Share factor, based on a user or account's assigned
106 shares and the effective usage charged to them or their ac‐
107 counts.
108 GrpTRESMins
110 The TRES-minutes limit set on the account. The total number of
111 cpu minutes that can possibly be used by past, present and fu‐
112 ture jobs running from this account and its children.
113 GrpTRESRaw
115 The raw TRES usage that has been used by jobs running from this
116 account and its children.
117 TRESRunMins
119 The number of TRES-minutes allocated by jobs currently running
120 against the account. Used to limit the combined total number of
121 TRES minutes used by all jobs running with this account and its
122 children. This takes into consideration time limit of running
123 jobs and consumes it, if the limit is reached no new jobs are
124 started until other jobs finish to allow time to free up.
125
127 When PriorityFlags=FAIR_TREE is set (the default, unless NO_FAIR_TREE
128 is set), calculations are done differently. As a result, the following
129 fields are added or modified:
130 Norm Shares
133 The shares assigned to the user or account normalized to the to‐
134 tal number of assigned shares within the level.
135 Effectv Usage
137 Effectv Usage is the association's usage normalized with its
138 parent.
139 Level FS (only appears with sshare -l option)
141 This is the association's fairshare value compared to its sib‐
142 lings, calculated as Norm Shares / Effectv Usage. If an associa‐
143 tion is over-served, the value is between 0 and 1. If an associ‐
144 ation is under-served, the value is greater than 1. Associa‐
145 tions with no usage receive the highest possible value, infin‐
146 ity.
147 More information about Fair Tree can be found in
149 doc/html/fair_tree.html or at https://slurm.schedmd.com/fair_tree.html
150
153 Executing sshare sends a remote procedure call to slurmctld. If enough
154 calls from sshare or other Slurm client commands that send remote pro‐
155 cedure calls to the slurmctld daemon come in at once, it can result in
156 a degradation of performance of the slurmctld daemon, possibly result‐
157 ing in a denial of service.
158 Do not run sshare or other Slurm client commands that send remote pro‐
160 cedure calls to slurmctld from loops in shell scripts or other pro‐
161 grams. Ensure that programs limit calls to sshare to the minimum neces‐
162 sary for the information you are trying to gather.
163
166 Some sshare options may be set via environment variables. These envi‐
167 ronment variables, along with their corresponding options, are listed
168 below. (Note: Command line options will always override these set‐
169 tings.)
170 SLURM_CONF The location of the Slurm configuration file.
173 SLURM_DEBUG_FLAGS Specify debug flags for sshare to use. See De‐
175 bugFlags in the slurm.conf(5) man page for a full
176 list of flags. The environment variable takes
177 precedence over the setting in the slurm.conf.
178
180 Display information about users in a particular account:
181 $ sshare -A <Account>
183 Display information about a specific user in a parsable format:
186 $ sshare --parsable --users=<User>
188
191 Copyright (C) 2008 Lawrence Livermore National Security. Produced at
192 Lawrence Livermore National Laboratory (cf, DISCLAIMER).
193 Copyright (C) 2010-2022 SchedMD LLC.
194 This file is part of Slurm, a resource management program. For de‐
196 tails, see <https://slurm.schedmd.com/>.
197 Slurm is free software; you can redistribute it and/or modify it under
199 the terms of the GNU General Public License as published by the Free
200 Software Foundation; either version 2 of the License, or (at your op‐
201 tion) any later version.
202 Slurm is distributed in the hope that it will be useful, but WITHOUT
204 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
205 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
206 for more details.
207
210 slurm.conf(5), slurmdbd(8)
211August 2022 Slurm Commands sshare(1)