xenial (1) sshare.1.gz

NAME

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

SYNOPSIS

       sshare [OPTIONS...]

DESCRIPTION

       sshare  is  used  to  view  Slurm  share  information.  This command is only viable when running with the
       priority/multifactor plugin.  The sshare information is derived from a database with the interface  being
       provided  by slurmdbd (Slurm Database daemon) which is read in from the slurmctld and used to process the
       shares available to a given association.  sshare provides Slurm share information of Account,  User,  Raw
       Shares,  Normalized  Shares,  Raw  Usage,  Normalized  Usage, Effective Usage, the Fair-share factor, the
       GrpCPUMins limit, Partitions and accumulated currently running CPU-minutes for each association.

OPTIONS

       -A, --accounts=
              Display information for specific accounts (comma separated list).

       -a, --all
              Display information for all users.

       -h, --noheader
              No header will be added to the beginning of the output.

       -l, --long
              Long listing - includes the normalized usage information.

       -M, --clusters=<string>
              Clusters to issue commands to.

       -m, --partition
              Is there are association based partition in the system print their names.

       -p, --parsable
              Output will be '|' delimited with a '|' at the end.

       -P, --parsable2
              Output will be '|' delimited without a '|' at the end.

       -u, --users=
              Display information for specific users (comma separated list).

       -U, --Users
              If specified only the users information are printed, the parent and ancestors are not displayed.

       -v, --verbose
              Display more information about the specified options.

       -V, --version
              Display the version number of sshare.

       --help --usage Display a description of sshare options and commands.

SSHARE OUTPUT FIELDS

       Account
              The Account.

       User   The User.

       Raw Shares
              The raw shares assigned to the user or account.

       Norm Shares
              The shares assigned to the user or account normalized to the total number of assigned shares.

       Raw Usage
              The number of cpu-seconds of all the jobs that charged the account by the user.  This number  will
              decay over time when PriorityDecayHalfLife is defined.

       Norm Usage (only appears with sshare -l option)
              The  Raw  Usage  normalized  to  the  total  number of cpu-seconds of all jobs run on the cluster,
              subject to the PriorityDecayHalfLife decay when defined.

       Effectv Usage
              The Effective Usage augments the normalized usage to account for usage from sibling accounts.

       FairShare
              The Fair-Share factor, based on a user or  account's  assigned  shares  and  the  effective  usage
              charged to them or their accounts.

       GrpCPUMins
              The  CPU-minutes  limit  set  on the account. The total number of cpu minutes that can possibly be
              used by past, present and future jobs running from this account and its children.

       CPURunMins
              The number of CPU-minutes allocated by jobs currently running against the account. Used  to  limit
              the  combined  total  number  of  CPU  minutes  used by all jobs running with this account and its
              children.  This takes into consideration time limit of running jobs and consumes it, if the  limit
              is reached no new jobs are started until other jobs finish to allow time to free up.

FAIR_TREE MODIFICATIONS

       When  PriorityFlags=FAIR_TREE  is  set,  calculations  are  done differently.  As a result, the following
       fields are added or modified:

       Norm Shares
              The shares assigned to the user or account normalized to  the  total  number  of  assigned  shares
              within the level.

       Effectv Usage
              Effectv Usage is the association's usage normalized with its parent.

       Level FS (only appears with sshare -l option)
              This  is  the  association's fairshare value compared to its siblings, calculated as Norm Shares /
              Effectv Usage. If an association is over-served, the value is between 0 and 1. If  an  association
              is  under-served,  the  value  is  greater than 1.  Associations with no usage receive the highest
              possible value, infinity.

       More information about Fair Tree can be found in doc/html/fair_tree.html or
              at http://slurm.schedmd.com/fair_tree.html

ENVIRONMENT VARIABLES

       Some sshare options may be set via environment variables. These environment variables, along  with  their
       corresponding options, are listed below.  (Note: commandline options will always override these settings)

       SLURM_CONF          The location of the Slurm configuration file.

EXAMPLES

       > sshare -A <Account>
       > sshare --parsable --users=<User>

COPYING

       Copyright  (C)  2008  Lawrence  Livermore  National  Security.   Produced  at Lawrence Livermore National
       Laboratory (cf, DISCLAIMER).
       Copyright (C) 2010-2013 SchedMD LLC.

       This file is part of Slurm, a resource management program.  For details, see <http://slurm.schedmd.com/>.

       Slurm is free software; you can redistribute it and/or modify it under  the  terms  of  the  GNU  General
       Public License as published by the Free Software Foundation; either version 2 of the License, or (at your
       option) any later version.

       Slurm is distributed in the hope that it will be useful, but  WITHOUT  ANY  WARRANTY;  without  even  the
       implied  warranty  of  MERCHANTABILITY  or  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
       License for more details.

SEE ALSO

       slurm.conf(5), slurmdbd(8)