Slurm Workload Manager -

    .SH "DESCRIPTION"
    \fBsreport\fR is used to generate reports of job usage and cluster
    utilization for Slurm jobs saved to the Slurm Database,
    \fBslurmdbd\fR.

    .SH "OPTIONS"

    .TP
    \fB\-a\fR, \fB\-\-all_clusters\fR
    Use all clusters instead of only the cluster from which the command was
    executed.
    .TP
    \fB\-\-federation\fR
    Generate a report for the federation if a member of one.
    .TP
    \fB\-h\fR, \fB\-\-help\fR
    Print a help message describing the usage of \fBsreport\fR.
    .TP
    \fB\-\-local\fR
    Generate a report for the local cluster, even if part of a federation.
    Overrides \-\-federation
    .TP
    \fB\-M\fR, \fB\-\-cluster\fR
    The cluster(s) to generate reports for. Default is local cluster, unless the
    local cluster is currently part of a federation and in that case generate a
    report for all clusters in the current federation. If the clusters included
    in a federation vary through time, use this option to identify the clusters
    to be included in report. Implies --local.
    .TP
    \fB\-n\fR, \fB\-\-noheader\fR
    Don't display header when listing results.
    .TP
    \fB\-p\fR, \fB\-\-parsable\fR
    Output will be '|' delimited with a '|' at the end.
    .TP
    \fB\-P\fR, \fB\-\-parsable2\fR
    Output will be '|' delimited without a '|' at the end.
    .TP
    \fB\-Q\fR, \fB\-\-quiet\fR
    Print no warning or informational messages, only error messages.
    .TP
    \fB\-t <format>\fR
    Specify the output time format. Time format options are case
    insensitive and may be abbreviated. The default format is Minutes.
    Supported time format options are listed in the \fBtime\fP command
    section below.
    .TP
    \fB\-T,  \-\-tres <tres_names>\fR
    Trackable resource (TRES) to report values for.
    By default CPU resource use is reported (except for reservation reports. All
    TRES types reserved by a reservation will be shown by default unless overridden
    The main issue with using node is in most configurations multiple jobs are able
    to run on the same node.  This makes TRES node accounting count the same node
    multiple times in the same period.  In exclusive node configurations, CPU
    accounting returns the same usage node accounting would.

    .TP
    \fB\-v\fR, \fB\-\-verbose\fR
    Print detailed event logging.
    .TP
    \fB\-V\fR , \fB\-\-version\fR
    Print version information and exit.

    .SH "COMMANDS"

    .TP
    \<keyword\> may be omitted from the execute line and sreport will
    execute in interactive mode. sreport will process commands as entered until
    explicitly terminated.

    .TP
    \fBexit\fP
    Terminate the execution of sreport.
    Identical to the \fBquit\fR command.

    .TP
    \fBhelp\fP
    Display a description of sreport options and commands.

    .TP
    \fBnonparsable\fP
    Return output to normal after parsable or parsable2 has been set.

    .TP
    \fBparsable\fP
    Output will be | delimited with an ending '|'.

    .TP
    \fBparsable2\fP
    Output will be | delimited without an ending '|'.

    .TP
    \fBquiet\fP
    Print no warning or informational messages, only fatal error messages.

    .TP
    \fBquit\fP
    Terminate the execution of sreport.
    Identical to the \fBexit\fR command.

    .TP
    \fBtime <time_format>\fP
    Specify the output time format. Time format options are case
    \fBSeconds\fR
    Seconds
    .TP
    \fBMinutes\fR
    Minutes
    .TP
    \fBHours\fR
    Hours
    .TP
    \fBPercent\fR
    Percentage of Total
    .RE

    .TP
    \fBverbose\fP
    Enable detailed event logging.

    .TP
    \fBversion\fP
    Display the sreport version number.

    .TP
    \fB!!\fP
    Repeat the last command executed.

    .SH "REPORT TYPES"
    .TP
    Valid report types are:
    \fBcluster\fP \<REPORT\> \<OPTIONS\>

    \fBjob\fP \<REPORT\> \<OPTIONS\>

    \fBreservation\fP \<REPORT\> \<OPTIONS\>

    \fBuser\fP \<REPORT\> \<OPTIONS\>

    .TP
    \<REPORT\> options for each type include:

    .B cluster
    \- AccountUtilizationByUser, UserUtilizationByAccount,
    UserUtilizationByWckey, Utilization, WCKeyUtilizationByUser

    .B job
    \- SizesByAccount, SizesByAccountAndWcKey, SizesByWckey

    .B reservation
    \- Utilization

    .B user
    \- TopUsage

    usage with a sum on each level.  Use the 'tree' option to span
    the tree for better visibility.

    \fBNOTE\fR: Idle reservation time will be split evenly among accounts/users
    given access to it. When a reservation is assigned to whole accounts, the
    time will be counted in the association for the accounts, not the user
    associations in the accounts. In this case, the usage of a parent account can
    be larger than the sum of its children.
    .TP
    .B cluster UserUtilizationByAccount
    This report will display users by account in order of utilization without
    grouping multiple accounts by user into one, but displaying them
    on separate lines.
    .TP
    .B cluster UserUtilizationByWCKey
    This report will display users by wckey in order of utilization without
    grouping multiple wckey by user into one, but displaying them
    on separate lines.
    .TP
    .B cluster Utilization
    This report will display total usage divided amongst Allocated, Down,
    Planned Down, Idle, and Reserved time for selected clusters.
    .RS
    .IP Allocated 13
    Time that nodes were in use with active jobs or an active reservation.
    This does not include reservations created with the MAINT or IGNORE_JOBS
    flags.
    .IP Down
    Time that nodes were marked as Down or time that slurmctld was not
    responding (assuming TrackSlurmctldDown is set in slurmdbd.conf).
    .IP Idle
    Time where nodes had no active jobs or reservations.
    .IP Overcommited
    Time of eligible jobs waiting in the queue over the Reserved time. Unlike
    Reserved, this has no limit. It is typically useful to determine whether your
    system is overloaded and by how much.
    .IP PlannedDown
    Time that nodes were in use by a reservation created with the MAINT flag
    but not the IGNORE_JOBS flag.
    .IP Reserved
    Time that a node spent idle with eligible jobs in the queue that were
    unable to start due to time or size constraints. The maximum time is limited
    to the amount of time possible on the system. If this value is
    not of importance for you then the number can be grouped with idle time.
    .IP TresCount
    Configured number of TRES' on the reported nodes. See also the
    \fBTresName\fP field.
    .RE
    .RS 7

    Note: Reservations created with the IGNORE_JOBS flag are not tracked
    in the Cluster Utilization report due to the fact that allowing any
    each user on each cluster.

    .TP
    .B job SizesByAccount
    This report will display the amount of time used for job ranges
    specified by the 'grouping=' option.  Only a single level in the tree
    is displayed defaulting to the root dir.  If you specify other
    accounts with the 'account=' option sreport will use those accounts as
    the root account and you will receive the aggregated totals of each listed
    account plus their sub accounts.
    .TP
    .B job SizesByAccountAndWckey
    This report is very similar to SizesByAccount with the difference being
    each account is pair with wckeys so the identifier is account:wckey
    instead of just account so there will most likely be multiple accounts
    listed depending on the number of wckeys used.
    .TP
    .B job SizesByWckey
    This report will display the amount of time for each wckey for job ranges
    specified by the 'grouping=' option.

    .TP
    .B reservation Utilization
    This report will display total usage for reservations on the systems.

    .TP
    .B user TopUsage
    Displays the top users on a cluster.  Use the group option to group
    accounts together.  The default is to have a different line for each
    user account combination.

    .TP
    Each report type has various options...

    .TP
    .B OPTIONS FOR ALL REPORT TYPES

    .TP
    .B All_Clusters
    Use all monitored clusters. Default is local cluster.
    .TP
    .B Clusters=<OPT>
    List of clusters to include in report.  Default is local cluster.

    .TP
    .B End=<OPT>
    Period ending for report. Default is 23:59:59 of previous day.
    Valid time formats are...
    .sp
    HH:MM[:SS] [AM|PM]
    .br
    MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]

    .TP
    .B Start=<OPT>
    Period start for report.  Default is 00:00:00 of previous day.
    Valid time formats are...
    .sp
    HH:MM[:SS] [AM|PM]
    .br
    MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
    .br
    MM/DD[/YY]\-HH:MM[:SS]
    .br
    YYYY\-MM\-DD[THH:MM[:SS]]
    .ad
    .TP
    .B OPTIONS SPECIFICALLY FOR CLUSTER REPORTS

    .TP
    .B Accounts=<OPT>
    When used with the UserUtilizationByAccount, or
    AccountUtilizationByUser, List of accounts to include in report.
    Default is all.
    .TP
    .B Tree
    When used with the AccountUtilizationByUser report will span the
    accounts as they are in the hierarchy.
    .TP
    .B Users=<OPT>
    When used with any report other than Utilization, List of users to
    include in report.  Default is all.
    .TP
    .B Wckeys=<OPT>
    When used with the UserUtilizationByWckey or WCKeyUtilizationByUser,
    List of wckeys to include in report. Default is all.

    .TP
    .B OPTIONS SPECIFICALLY FOR JOB REPORTS

    .TP
    .B Accounts=<OPT>
    List of accounts to use for the report. Default is all which will show only
    one line corresponding to the totals of all accounts in the hierarchy.
    This explanation does not apply when ran with the FlatView or AcctAsParent
    options.
    .TP
    .B AcctAsParent
    When used with the SizesbyAccount(*) will take specified accounts
    as parents and the next layer of accounts under those specified
    will be displayed. Default is root if no specific Accounts are requested.
    When FlatView is used, this option is ignored.
    .TP
    .B FlatView
    .TP
    .B Nodes=<OPT>
    Only show jobs that ran on these nodes. Default is all.
    .TP
    .B Partitions=<OPT>
    List of partitions jobs ran on to include in report.  Default is all.
    .TP
    .B PrintJobCount
    When used with the Sizes report will print number of jobs ran instead
    of time used.
    .TP
    .B Users=<OPT>
    List of users jobs to include in report.  Default is all.
    .TP
    .B Wckeys=<OPT>
    List of wckeys to use for the report.  Default is all.  The
    SizesbyWckey report all users summed together.  If you want only
    certain users specify them with the Users= option.

    .TP
    .B OPTIONS SPECIFICALLY FOR RESERVATION REPORTS
    .TP
    .B Names=<OPT>
    List of reservations to use for the report. Default is all.
    .TP
    .B Nodes=<OPT>
    Only show reservations that used these nodes. Default is all.

    .TP
    .B OPTIONS SPECIFICALLY FOR USER REPORTS

    .TP
    .B Accounts=<OPT>
    List of accounts to use for the report. Default is all.
    .TP
    .B Group
    Group all accounts together for each user.  Default is a separate
    entry for each user and account reference.
    .TP
    .B TopCount=<OPT>
    Used in the TopUsage report.  Change the number of users displayed.
    Default is 10.
    .TP
    .B Users=<OPT>
    List of users jobs to include in report.  Default is all.

    .SH "FORMAT OPTIONS FOR EACH REPORT"

    \fBFORMAT OPTIONS FOR CLUSTER REPORTS\fP
    .in 10
    AccountUtilizationByUser:
    .in 14
    Allocated, Cluster, Down, Idle, Overcommited, PlannedDown, Reported, Reserved,
    TresCount, TresName

    .TP
    \fBFORMAT OPTIONS FOR JOB REPORTS\fP
    .in 10
    SizesByAccount, SizesByAccountAndWckey:
    .in 14
    Account, Cluster

    .in 10
    SizesByWckey:
    .in 14
    Wckey, Cluster

    .TP
    \fBFORMAT OPTIONS FOR RESERVATION REPORTS\fP
    .in 10
    Utilization:
    .in 14
    Allocated, Associations, Cluster, End, Flags, Idle, Name, Nodes, ReservationId, Start, TotalTime, TresCount, TresName, TresTime

    .TP
    \fBFORMAT OPTIONS FOR USER REPORTS\fP
    .in 10
    TopUsage:
    .in 14
    Account, Cluster, Login, Proper, Used

    .TP
    All commands and options are case-insensitive.

    .SH "PERFORMANCE"
    .PP
    Executing \fBsreport\fR sends a remote procedure call to \fBslurmdbd\fR. If
    enough calls from \fBsreport\fR or other Slurm client commands that send remote
    procedure calls to the \fBslurmdbd\fR daemon come in at once, it can result in a
    degradation of performance of the \fBslurmdbd\fR daemon, possibly resulting in a
    denial of service.
    .PP
    Do not run \fBsreport\fR or other Slurm client commands that send remote
    procedure calls to \fBslurmdbd\fR from loops in shell scripts or other programs.
    Ensure that programs limit calls to \fBsreport\fR to the minimum necessary for
    the information you are trying to gather.

    .SH "ENVIRONMENT VARIABLES"
    .PP
    Some \fBsreport\fR 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)
    .TP 20

    .in 0
    .SH "EXAMPLES"
    .TP
    \fBsreport job sizesbyaccount\fP
    .TP
    \fBsreport cluster utilization\fP
    .TP
    \fBsreport user top\fP
    .TP
    \fBsreport job sizesbyaccount All_Clusters users=gore1 account=environ PrintJobCount\fP
    Report number of jobs by user gore1 within the environ account
    .TP
    \fBsreport cluster AccountUtilizationByUser cluster=zeus user=gore1 start=2/23/08 end=2/24/09 format=Accounts,Cluster,TresCount,Login,Proper,Used\fP
    Report cluster account utilization with the specified fields during
    the specified 24 hour day of February 23, 2009, by user gore1
    .TP
    \fBsreport cluster AccountUtilizationByUser cluster=zeus accounts=lc start=2/23/08 end=2/24/09\fP
    Report cluster account utilization by user in the LC account on
    cluster zeus
    .TP
    \fBsreport user topusage start=2/16/09 end=2/23/09 \-t percent account=lc\fP
    Report top usage in percent of the lc account during the specified week

    .SH "COPYING"
    Copyright (C) 2009\-2010 Lawrence Livermore National Security.
    Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
    .br
    Copyright (C) 2010\-2015 SchedMD LLC.
    .LP
    This file is part of Slurm, a resource management program.
    For details, see <https://slurm.schedmd.com/>.
    .LP
    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.
    .LP
    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.

    .SH "SEE ALSO"
    \fBsacct\fR(1), \fBslurmdbd\fR(8)