sshare (1)

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
SSHARE OUTPUT FIELDS
EXAMPLES
COPYING
SEE ALSO

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 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.
-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).
-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.
CPURunMins: The number of CPU-minutes accumulated by jobs currently running against the account.

EXAMPLES

> sshare -A <Account>

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

COPYING

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.