Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
sshare(1)			Slurm Commands			     sshare(1)

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 pro-
       vided by	slurmdbd (Slurm	Database daemon) which is  read	 in  from  the
       slurmctld  and used to process the shares available to a	given associa-
       tion.  sshare provides Slurm share information of  Account,  User,  Raw
       Shares,	Normalized  Shares, Raw	Usage, Normalized Usage, Effective Us-
       age, the	Fair-share factor, the GrpTRESMins limit, Partitions and accu-
       mulated currently running TRES-minutes for each association.

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

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

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

       -M, --clusters=<string>
	      Clusters to issue	commands to.  Note that	the SlurmDBD  must  be
	      up for this option to work properly.

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

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

       -o, --format=
	      Comma separated list of fields (use "--helpformat" for a list of
	      available	fields).

       -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 to-
	      tal number of assigned shares.

       Raw Usage
	      The number of tres-seconds (cpu-seconds if TRESBillingWeights is
	      not defined) of all the jobs charged to  the  account  or	 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 tres-seconds  of
	      all  jobs	 run  on  the  cluster,	 subject to the	PriorityDecay-
	      HalfLife 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  ac-
	      counts.

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

       GrpTRESRaw
	      The  raw TRES usage that has been	used by	jobs running from this
	      account and its children.

       TRESRunMins
	      The number of TRES-minutes allocated by jobs  currently  running
	      against  the account. Used to limit the combined total number of
	      TRES 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 (the default, unless NO_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 to-
	      tal 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 sib-
	      lings, calculated	as Norm	Shares / Effectv Usage.	If an associa-
	      tion is over-served, the value is	between	0 and 1. If an associ-
	      ation is under-served, the value is greater  than	 1.   Associa-
	      tions  with  no usage receive the	highest	possible value,	infin-
	      ity.

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

PERFORMANCE
       Executing  sshare sends a remote	procedure call to slurmctld. If	enough
       calls from sshare or other Slurm	client commands	that send remote  pro-
       cedure  calls to	the slurmctld daemon come in at	once, it can result in
       a degradation of	performance of the slurmctld daemon, possibly  result-
       ing in a	denial of service.

       Do  not run sshare or other Slurm client	commands that send remote pro-
       cedure calls to slurmctld from loops in shell  scripts  or  other  pro-
       grams. Ensure that programs limit calls to sshare to the	minimum	neces-
       sary for	the information	you are	trying to gather.

ENVIRONMENT VARIABLES
       Some sshare options may be set via environment variables.  These	 envi-
       ronment	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 de-
       tails, see <https://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  op-
       tion) 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)

April 2015			Slurm Commands			     sshare(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | SSHARE OUTPUT FIELDS | FAIR_TREE MODIFICATIONS | PERFORMANCE | ENVIRONMENT VARIABLES | EXAMPLES | COPYING | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=sshare&sektion=1&manpath=FreeBSD+13.1-RELEASE+and+Ports>

home | help