    .SH "DESCRIPTION"
    \fBscontrol\fR is used to view or modify Slurm configuration including: job,
    job step, node, partition, reservation, and overall system configuration. Most
    of the commands can only be executed by user root or an Administrator. If an
    attempt to view or modify configuration information is made by an unauthorized
    user, an error message will be printed and the requested action will not occur.
    If no command is entered on the execute line, \fBscontrol\fR will operate in an
    interactive mode and prompt for input. It will continue prompting for input and
    executing commands until explicitly terminated. If a command is entered on the
    execute line, \fBscontrol\fR will execute that command and terminate. All
    commands and options are case\-insensitive, although node names, partition
    names, and reservation names are case\-sensitive (node names "LX" and "lx" are
    distinct). All commands and options can be abbreviated to the extent that the
    specification is unique. A modified Slurm configuration can be written to
    a file using the \fIscontrol write config\fR command. The resulting file
    will be named using the convention "slurm.conf.<datetime>" and located in the
    same directory as the original "slurm.conf" file. The directory containing
    the original slurm.conf must be writable for this to occur.

    .SH "OPTIONS"
    .TP
    \fB\-a\fR, \fB\-\-all\fR
    When the \fIshow\fR command is used, then display all partitions, their jobs
    and jobs steps. This causes information to be displayed about partitions
    that are configured as hidden and partitions that are unavailable to user's
    group.
    .TP
    \fB\-d\fR, \fB\-\-details\fR
    Causes the \fIshow\fR command to provide additional details where available.
    .TP
    \fB\-\-federation\fR
    Report jobs from federation if a member of one.
    .TP
    \fB\-F\fR, \fB\-\-future\fR
    Report nodes in FUTURE state.
    .TP
    \fB\-h\fR, \fB\-\-help\fR
    Print a help message describing the usage of scontrol.
    .TP
    \fB\-\-hide\fR
    Do not display information about hidden partitions, their jobs and job steps.
    By default, neither partitions that are configured as hidden nor those partitions
    unavailable to user's group will be displayed (i.e. this is the default behavior).
    .TP
    \fB\-\-local\fR
    Show only information local to this cluster. Ignore other clusters in the
    federated if a member of one. Overrides \-\-federation.
    .TP
    \fB\-M\fR, \fB\-\-clusters\fR=<\fIstring\fR>
    The cluster to issue commands to. Only one cluster name may be specified.
    Note that the SlurmDBD must be up for this option to work properly.
    .TP
    \fB\-v\fR, \fB\-\-verbose\fR
    Print detailed event logging. Multiple \fB\-v\fR's will further increase
    the verbosity of logging. By default only errors will be displayed.

    .TP
    \fB\-V\fR , \fB\-\-version\fR
    Print version information and exit.

    .SS COMMANDS

    .TP
    \fBabort\fP
    Instruct the Slurm controller to terminate immediately and generate a core file.
    See "man slurmctld" for information about where the core file will be
    written.

    .TP
    \fBcancel_reboot \fI<NodeList>\fP
    Cancel pending reboots on nodes. The node will be undrain'ed and the reason
    cleared if the node was drained by an ASAP reboot.

    .TP
    \fBcluster\fR \fICLUSTER_NAME\fP
    The cluster to issue commands to. Only one cluster name may be specified.

    .TP
    \fBcreate\fP \fISPECIFICATION\fP
    Create a new partition or reservation.  See the full list of parameters
    below.  Include the tag "res" to create a reservation without specifying
    a reservation name.

    .TP
    \fBcompleting\fP
    Display all jobs in a COMPLETING state along with associated nodes in either a
    COMPLETING or DOWN state.

    .TP
    \fBdelete\fP \fISPECIFICATION\fP
    Delete the entry with the specified \fISPECIFICATION\fP.
    The two \fISPECIFICATION\fP choices are \fIPartitionName=<name>\fP and
    \fIReservation=<name>\fP. Reservations and partitions should have
    no associated jobs at the time of their deletion (modify the jobs first).
    If the specified partition is in use, the request is denied.

    .TP
    \fBerrnumstr\fP \fIERRNO\fP
    Given a Slurm error number, return a descriptive string.

    .TP
    \fBfsdampeningfactor\fP \fIFACTOR\fP
    Set the FairShareDampeningFactor in slurmctld.
    see the \fBuhold\fP command). When the job is held by its owner, it may also
    be released by the job's owner.
    Additionally, attempting to hold a running job will have not suspend or cancel
    it. But, it will set the job priority to 0 and update the job reason field,
    which would hold the job if it was requeued at a later time.

    .TP
    \fBnotify\fP \fIjob_id\fP \fImessage\fP
    Send a message to standard error of the salloc or srun command or batch job
    associated with the specified \fIjob_id\fP.

    .TP
    \fBpidinfo\fP \fIproc_id\fP
    Print the Slurm job id and scheduled termination time corresponding to the
    supplied process id, \fIproc_id\fP, on the current node.  This will work only
    with processes on node on which scontrol is run, and only for those processes
    spawned by Slurm and their descendants.

    .TP
    \fBlistpids\fP [\fIjob_id\fP[.\fIstep_id\fP]] [\fINodeName\fP]
    Print a listing of the process IDs in a job step (if JOBID.STEPID is provided),
    or all of the job steps in a job (if \fIjob_id\fP is provided), or all of the job
    steps in all of the jobs on the local node (if \fIjob_id\fP is not provided
    or \fIjob_id\fP is "*").  This will work only with processes on the node on
    which scontrol is run, and only for those processes spawned by Slurm and
    their descendants. Note that some Slurm configurations
    (\fIProctrackType\fP value of \fIpgid\fP)
    are unable to identify all processes associated with a job or job step.

    Note that the NodeName option is only really useful when you have multiple
    slurmd daemons running on the same host machine.  Multiple slurmd daemons on
    one host are, in general, only used by Slurm developers.

    .TP
    \fBping\fP
    Ping the primary and secondary slurmctld daemon and report if
    they are responding.

    .TP
    \fBreboot\fP [ASAP] [nextstate=<RESUME|DOWN>] [reason=<reason>] <\fIALL|\
    NodeList\fP>
    Reboot the nodes in the system when they become idle using the
    \fBRebootProgram\fP as configured in Slurm's slurm.conf file.
    Each node will have the "REBOOT" flag added to its node state.
    After a node reboots and the slurmd daemon starts up again, the
    HealthCheckProgram will run once. Then, the slurmd daemon will register
    itself with the slurmctld daemon and the "REBOOT" flag will be cleared.
    The node's "DRAIN" state flag will be cleared if the reboot was "ASAP",
    nextstate=resume or down.
    The "ASAP" option adds the "DRAIN" flag to each node's state, preventing
    additional jobs from running on the node so it can be
    rebooted and returned to service "As Soon As Possible" (i.e. ASAP).
    NOTE: By default, this command does not prevent additional jobs from being
    scheduled on any nodes before reboot.
    To do this, you can either use the "ASAP" option or explicitly drain the nodes
    beforehand.
    You can alternately create an advanced reservation to
    prevent additional jobs from being initiated on nodes to be rebooted.
    Pending reboots can be cancelled by using "scontrol cancel_reboot <node>" or
    setting the node state to "CANCEL_REBOOT".
    A node will be marked "DOWN" if it doesn't reboot within \fBResumeTimeout\fR.

    .TP
    \fBreconfigure\fP
    Instruct all Slurm daemons to re\-read the configuration file.
    This command does not restart the daemons.
    This mechanism would be used to modify configuration parameters (Epilog,
    Prolog, SlurmctldLogFile, SlurmdLogFile, etc.).
    The Slurm controller (slurmctld) forwards the request to all other daemons
    (slurmd daemon on each compute node). Running jobs continue execution.
    Most configuration parameters can be changed by just running this command,
    however, Slurm daemons should be shutdown and restarted if any of these
    parameters are to be changed: AuthType, ControlMach, PluginDir,
    StateSaveLocation, SlurmctldHost, SlurmctldPort,
    or SlurmdPort. The slurmctld daemon and all slurmd daemons must be
    restarted if nodes are added to or removed from the cluster.

    .TP
    \fBrelease\fP \fIjob_list\fP
    Release a previously held job to begin execution.
    The job_list argument is a comma separated list of job IDs OR
    "jobname=" with the job's name, which will attempt to hold all jobs having
    that name.
    Also see \fBhold\fR.

    .TP
    \fBrequeue\f  [option] \fIjob_list\fP
    Requeue a running, suspended or finished Slurm batch job into pending state.
    The job_list argument is a comma separated list of job IDs.
    The command accepts the following option:
    .RS
    .TP
    \fIIncomplete\fP
    Operate only on jobs (or tasks of a job array) which have not completed.
    Specifically only jobs in the following states will be requeued:
    CONFIGURING, RUNNING, STOPPED or SUSPENDED.
    .RE

    .TP
    \fBrequeuehold\fP [option] \fIjob_list\fP
    Requeue a running, suspended or finished Slurm batch job into pending state,
    moreover the job is put in held state (priority zero).
    The job_list argument is a comma separated list of job IDs.
    A held job can be released using scontrol to reset its priority (e.g.

    .TP
    \fBresume\fP \fIjob_list\fP
    Resume a previously suspended job.
    The job_list argument is a comma separated list of job IDs.
    Also see \fBsuspend\fR.

    \fBNOTE:\fR A suspended job releases its CPUs for allocation to other jobs.
    Resuming a previously suspended job may result in multiple jobs being
    allocated the same CPUs, which could trigger gang scheduling with some
    configurations or severe degradation in performance with other configurations.
    Use of the scancel command to send SIGSTOP and SIGCONT signals would stop a
    job without releasing its CPUs for allocation to other jobs and would be a
    preferable mechanism in many cases.
    If performing system maintenance you may want to use suspend/resume in the
    following way. Before suspending set all nodes to draining or set all
    partitions to down so that no new jobs can be scheduled. Then suspend
    jobs. Once maintenance is done resume jobs then resume nodes and/or set all
    partitions back to up.
    Use with caution.

    .TP
    \fBschedloglevel\fP \fILEVEL\fP
    Enable or disable scheduler logging.
    \fILEVEL\fP may be "0", "1", "disable" or "enable". "0" has the same
    effect as "disable". "1" has the same effect as "enable".
    This value is temporary and will be overwritten when the slurmctld
    daemon reads the slurm.conf configuration file (e.g. when the daemon
    is restarted or \fBscontrol reconfigure\fR is executed) if the
    SlurmSchedLogLevel parameter is present.

    .TP
    \fBsetdebug\fP \fILEVEL\fP
    Change the debug level of the slurmctld daemon.
    \fILEVEL\fP may be an integer value between zero and nine (using the
    same values as \fISlurmctldDebug\fP in the \fIslurm.conf\fP file) or
    the name of the most detailed message type to be printed:
    "quiet", "fatal", "error", "info", "verbose", "debug", "debug2", "debug3",
    "debug4", or "debug5".
    This value is temporary and will be overwritten whenever the slurmctld
    daemon reads the slurm.conf configuration file (e.g. when the daemon
    is restarted or \fBscontrol reconfigure\fR is executed).

    .TP
    \fBsetdebugflags\fP [+|\-]\fIFLAG\fP
    Add or remove DebugFlags of the slurmctld daemon.
    See "man slurm.conf" for a list of supported DebugFlags.
    NOTE: Changing the value of some DebugFlags will have no effect without
    restarting the slurmctld daemon, which would set DebugFlags based upon the
    contents of the slurm.conf configuration file.

    .TP
    .RS
    .TP
    \fBusers\fR=<\fIuser1\fR>[...,<\fIuserN\fR>]
    Limit the User Records displayed to those with the specified user name(s).
    .TP
    \fBaccounts\fR=<\fIacct1\fR>[...,<\fIacctN\fR>]
    Limit the Association Records displayed to those with the specified account
    name(s).
    .TP
    \fBqos\fR=<\fIqos1\fR>[...,<\fIqosN\fR>]
    Limit the QOS Records displayed to those with the specified QOS name(s).
    .TP
    \fBflags\fR=users|assoc|qos
    Specify the desired record type to be displayed. If no flags are specified,
    all record types are displayed.
    .RE
    .TP
    \fBbbstat\fR
    Displays output from Cray's burst buffer status tool. Options following
    \fBbbstat\fR are passed directly to the dwstat command by the slurmctld daemon
    and the response returned to the user. Equivalent to \fBdwstat\fR.
    .TP
    \fBburstbuffer\fR
    Displays the current status of the BurstBuffer plugin.
    .TP
    \fBconfig\fR
    Displays parameter names from the configuration files in mixed
    case (e.g. SlurmdPort=7003) while derived parameters names are in upper case
    only (e.g. SLURM_VERSION).
    .TP
    \fBdaemons\fR
    Reports which daemons should be running on this node.
    .TP
    \fBdwstat\fR
    Displays output from Cray's burst buffer status tool. Options following
    \fBdwstat\fR are passed directly to the dwstat command by the slurmctld daemon
    and the response returned to the user. Equivalent to \fBbbstat\fR.
    .TP
    \fBfederation\fR
    The federation name that the controller is part of and the
    sibling clusters part of the federation will be listed.
    .TP
    \fBfrontend\fR
    Shows configured frontend nodes.
    .TP
    \fBhostlist\fR
    Takes a list of host names and prints the hostlist
    expression for them (the inverse of \fBhostnames\fR).
    \fBhostlist\fR can also take the absolute pathname of a file
    (beginning with the character '/') containing a list of hostnames.
    Multiple node names may be specified using simple node range expressions
    (e.g. "lx[10\-20]"). All other \fIID\fP values must identify a single
    Takes an optional hostlist expression as input and
    writes a list of individual host names to standard output (one per
    line). If no hostlist expression is supplied, the contents of the
    SLURM_JOB_NODELIST environment variable is used. For example "tux[1\-3]"
    is mapped to "tux1","tux2" and "tux3" (one hostname per line).
    .TP
    \fBjob\fR
    Displays statistics about all jobs by default. If an optional jobid is
    specified, details for just that job will be displayed.
    If the job does not specify socket-per-node, cores-per-socket or
    threads-per-core then it will display '*' in the ReqS:C:T=*:*:* field.
    .TP
    \fBnode\fR
    Displays statistics about all nodes by default. If an optional nodename is
    specified, details for just that node will be displayed.
    .TP
    \fBpartition\fR
    Displays statistics about all partitions by default. If an optional partition
    name is specified, details for just that partition will be displayed.
    .TP
    \fBreservation\fR
    Displays statistics about all reservations by default. If an optional
    reservation name is specified, details for just that reservation will be
    displayed.
    .TP
    \fBslurmd\fR
    Displays statistics for the slurmd running on the current node.
    .TP
    \fBstep\fR
    Displays statistics about all job steps by default. If an optional jobid
    is specified, details about steps for just that job will be displayed.
    If a jobid.stepid is specified, details for just that step will be displayed.
    .TP
    \fBtopology\fR
    Displays information about the defined topology layout. If a switch is
    specified, information about that switch will be shown.
    If one node name is specified, all switches connected to that node (and
    their parent switches) will be shown.
    If more than one node name is specified, only switches that connect to all
    named nodes will be shown.
    .RE

    .TP
    \fBshutdown\fP \fIOPTION\fP
    Instruct Slurm daemons to save current state and terminate.
    By default, the Slurm controller (slurmctld) forwards the request all
    other daemons (slurmd daemon on each compute node).
    An \fIOPTION\fP of \fIslurmctld\fP or \fIcontroller\fP results in
    only the slurmctld daemon being shutdown and the slurmd daemons
    remaining active.

    .TP
    control. By default the first backup controller (INDEX=1) requests control
    from the primary and waits for its termination. After that, it switches from
    backup mode to controller mode. If primary controller can not be contacted, it
    directly switches to controller mode. This can be used to speed up the Slurm
    controller fail\-over mechanism when the primary node is down.
    This can be used to minimize disruption if the computer executing the
    primary Slurm controller is scheduled down.
    (Note: Slurm's primary controller will take the control back at startup.)

    .TP
    \fBtop\fP \fIjob_list\fP
    Move the specified job IDs to the top of the queue of jobs belonging to the
    identical user ID, partition name, account, and QOS.
    The job_list argument is a comma separated ordered list of job IDs.
    Any job not matching \fBall\fP of those fields will not be effected.
    Only jobs submitted to a single partition will be effected.
    This operation changes the order of jobs by adjusting job nice values.
    The net effect on that user's throughput will be negligible to slightly negative.
    This operation is disabled by default for non-privileged (non-operator, admin,
    SlurmUser, or root) users. This operation may be enabled for non-privileged
    users by the system administrator by including the option "enable_user_top" in
    the SchedulerParameters configuration parameter.

    .TP
    \fBtoken\fP [lifespan=<lifespan>] [username=<username>]
    Return an auth token which can be used to support JWT authentication if
    \fIAuthAltTypes=auth/jwt\fP has been enabled on the system.
    Supports two optional arguments. \fBlifespan=\fP may be used to specify the
    token's lifespan in seconds. \fBusername\fP (only available to SlurmUser/root)
    may be used to request a token for a different username.

    .TP
    \fBuhold\fP \fIjob_list\fP
    Prevent a pending job from being started (sets its priority to 0).
    The job_list argument is a space separated list of job IDs or job names.
    Use the \fIrelease\fP command to permit the job to be scheduled.
    This command is designed for a system administrator to hold a job so that
    the job owner may release it rather than requiring the intervention of a
    system administrator (also see the \fBhold\fP command).

    .TP
    \fBupdate\fP \fISPECIFICATION\fP
    Update job, step, node, partition, or reservation configuration per
    the supplied specification. \fISPECIFICATION\fP is in the same format as the
    Slurm configuration file and the output of the \fIshow\fP command described
    above. It may be desirable to execute the \fIshow\fP command (described above)
    on the specific entity you want to update, then use cut\-and\-paste tools to
    enter updated configuration values to the \fIupdate\fP. Note that while most
    configuration values can be changed using this command, not all can be changed
    using this mechanism. In particular, the hardware configuration of a node or
    the physical addition or removal of nodes from the cluster may only be
    accomplished through editing the Slurm configuration file and executing
    PrologFlags=Alloc as this will result in a deadlock.

    .TP
    \fBwrite batch_script\fP \fIjob_id optional_filename\fP
    Write the batch script for a given job_id to a file or to stdout. The file will
    default to \fIslurm-\<job_id\>.sh\fP if the optional filename argument is not
    given. The script will be written to stdout if - is given instead of a filename.
    The batch script can only be retrieved by an admin or operator, or by the
    owner of the job.

    .TP
    \fBwrite config\fP \fIoptional_filename\fP
    Write the current configuration to a file with the naming convention of
    "slurm.conf.<datetime>" in the same directory as the original slurm.conf
    file.  If a filename is given that file location with a .<datetime> suffix is
    created.

    .SS INTERACTIVE COMMANDS
    \fBNOTE:\fP
    All commands listed below can be used in the interactive mode, but \fINOT\fP
    on the initial command line.

    .TP
    \fBall\fP
    Show all partitions, their jobs and jobs steps. This causes information to be
    displayed about partitions that are configured as hidden and partitions that
    are unavailable to user's group.

    .TP
    \fBdetails\fP
    Causes the \fIshow\fP command to provide additional details where available.
    Job information will include CPUs and NUMA memory allocated on each node.
    Note that on computers with hyperthreading enabled and Slurm configured to
    allocate cores, each listed CPU represents one physical core.
    Each hyperthread on that core can be allocated a separate task, so a job's
    CPU count and task count may differ.
    See the \fB\-\-cpu\-bind\fR and \fB\-\-mem\-bind\fR option descriptions in
    srun man pages for more information.
    The \fBdetails\fP option is currently only supported for the \fIshow job\fP
    command.

    .TP
    \fBexit\fP
    Terminate scontrol interactive session.

    .TP
    \fBhide\fP
    Do not display partition, job or jobs step information for partitions that are
    configured as hidden or partitions that are unavailable to the user's group.
    This is the default behavior.

    .TP
    This includes time\-stamps on data structures, record counts, etc.

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

    .SS JOBS \- SPECIFICATIONS FOR UPDATE COMMAND
    Note that update requests done by either root, SlurmUser or Administrators are
    not subject to certain restrictions. For instance, if an Administrator changes
    the QOS on a pending job, certain limits such as the TimeLimit will not be
    changed automatically as changes made by the Administrators are allowed to
    violate these restrictions.

    .TP
    \fIAccount\fP=<account>
    Account name to be changed for this job's resource use.
    Value may be cleared with blank data value, "Account=".
    .TP
    \fIAdminComment\fP=<spec>
    Arbitrary descriptive string. Can only be set by a Slurm administrator.
    .TP
    \fIArrayTaskThrottle\fP=<count>
    Specify the maximum number of tasks in a job array that can execute at
    the same time.
    Set the count to zero in order to eliminate any limit.
    The task throttle count for a job array is reported as part of its ArrayTaskId
    field, preceded with a percent sign.
    For example "ArrayTaskId=1\-10%2" indicates the maximum number of running tasks
    is limited to 2.
    .TP
    \fIBurstBuffer\fP=<spec>
    Burst buffer specification to be changed for this job's resource use.
    Value may be cleared with blank data value, "BurstBuffer=".
    Format is burst buffer plugin specific.
    .TP
    \fIClusters\fP=<spec>
    Specifies the clusters that the federated job can run on.
    .TP
    \fIClusterFeatures\fP=<spec>
    Specifies features that a federated cluster must have to have a sibling job
    submitted to it. Slurm will attempt to submit a sibling job to a cluster if it
    has at least one of the specified features.
    .TP
    \fIComment\fP=<spec>
    Arbitrary descriptive string.
    .TP
    \fIContiguous\fP=<yes|no>
    Set the job's requirement for contiguous (consecutive) nodes to be allocated.
    Possible values are "YES" and "NO".
    Only the Slurm administrator or root can change this parameter.
    .TP
    \fICoreSpec\fP=<count>
    a date of the form \fIMMDDYY\fR or \fIMM/DD/YY\fR or \fIMM.DD.YY\fR,
    or a date and time as \fIYYYY\-MM\-DD[THH:MM[:SS]]\fR.  You can also
    give times like \fInow + count time\-units\fR, where the time\-units
    can be \fIseconds\fR (default), \fIminutes\fR, \fIhours\fR, \fIdays\fR,
    or \fIweeks\fR and you can tell Slurm to put a deadline for tomorrow with
    the keyword \fItomorrow\fR.
    The specified deadline must be later than the current time.
    Only pending jobs can have the deadline updated.
    Only the Slurm administrator or root can change this parameter.
    .TP
    \fIDelayBoot\fP=<time_spec>
    Change the time to decide whether to reboot nodes in order to satisfy job's
    feature specification if the job has been eligible to run for less than this
    time period. See salloc/sbatch man pages option \-\-delay\-boot.
    .TP
    \fIDependency\fP=<dependency_list>
    Defer job's initiation until specified job dependency specification
    is satisfied.
    Cancel dependency with an empty dependency_list (e.g. "Dependency=").
    <\fIdependency_list\fR> is of the form
    <\fItype:job_id[:job_id][,type:job_id[:job_id]]\fR>.
    Many jobs can share the same dependency and these jobs may even belong to
    different  users.
    .PD
    .RS
    .TP
    \fBafter:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have begun
    execution or been canceled.
    .TP
    \fBafterany:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have terminated.
    .TP
    \fBafternotok:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have terminated
    in some failed state (non-zero exit code, node failure, timed out, etc).
    .TP
    \fBafterok:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have successfully
    executed (ran to completion with an exit code of zero).
    .TP
    \fBsingleton\fR
    This job can begin execution after any previously launched jobs
    sharing the same job name and user have terminated.
    In other words, only one job by that name and owned by that user can be running
    or suspended at any point in time.
    .RE
    .TP
    \fIEligibleTime\fP=<time_spec>
    See \fIStartTime\fP.
    .TP
    \fIEndTime\fP
    In the first example, only nodes having both the feature "opteron" AND
    the feature "video" will be used.
    There is no mechanism to specify that you want one node with feature
    "opteron" and another node with feature "video" in case no
    node has both features.
    If only one of a set of possible options should be used for all allocated
    nodes, then use the OR operator and enclose the options within square brackets.
    For example: "\fBFeatures=[rack1|rack2|rack3|rack4]"\fR might
    be used to specify that all nodes must be allocated on a single rack of
    the cluster, but any of those four racks can be used.
    A request can also specify the number of nodes needed with some feature
    by appending an asterisk and count after the feature name.
    For example "\fBFeatures=graphics*4"\fR
    indicates that at least four allocated nodes must have the feature "graphics."
    Parenthesis are also supported for features to be ANDed together.
    For example "\fBFeatures=[(knl&a2a&flat)*4&haswell*2]"\fR indicates the
    resource allocation should include 4 nodes with ALL of the features "knl",
    "a2a", and "flat" plus 2 nodes with the feature "haswell".
    Constraints with node counts may only be combined with AND operators.
    Value may be cleared with blank data value, for example "Features=".

    .TP
    \fIGres\fP=<list>
    Specifies a comma delimited list of generic consumable resources.
    The format of each entry on the list is "name[:count[*cpu]]".
    The name is that of the consumable resource.
    The count is the number of those resources with a default value of 1.
    The specified resources will be allocated to the job on each node
    allocated unless "*cpu" is appended, in which case the resources
    will be allocated on a per cpu basis.
    The available generic consumable resources is configurable by the system
    administrator.
    A list of available generic consumable resources will be printed and the
    command will exit if the option argument is "help".
    Examples of use include "Gres=gpus:2*cpu,disk=40G" and "Gres=help".

    .TP
    \fIJobId\fP=<job_list>
    Identify the job(s) to be updated.
    The job_list may be a comma separated list of job IDs.
    Either \fIJobId\fP or \fIJobName\fP is required.
    .TP
    \fILicenses\fP=<name>
    Specification of licenses (or other resources available on all nodes
    of the cluster) as described in salloc/sbatch/srun man pages.
    .TP
    \fIMailType\fP=<types>
    Set the mail event types. Valid type values are NONE, BEGIN, END, FAIL,
    REQUEUE, ALL (equivalent to BEGIN, END, FAIL, REQUEUE, and STAGE_OUT),
    STAGE_OUT (burst buffer stage out and teardown completed), TIME_LIMIT,
    TIME_LIMIT_90 (reached 90 percent of time limit), TIME_LIMIT_80 (reached 80
    percent of time limit), TIME_LIMIT_50 (reached 50 percent of time limit) and
    Set the job's minimum real memory required per allocated CPU to the specified
    value. Either \fIMinMemoryCPU\fP or \fIMinMemoryNode\fP may be set, but not both.
    .TP
    \fIMinMemoryNode\fP=<megabytes>
    Set the job's minimum real memory required per node to the specified value.
    Either \fIMinMemoryCPU\fP or \fIMinMemoryNode\fP may be set, but not both.
    .TP
    \fIMinTmpDiskNode\fP=<megabytes>
    Set the job's minimum temporary disk space required per node to the specified value.
    Only the Slurm administrator or root can change this parameter.
    .TP
    \fITimeMin\fP=<timespec>
    Change TimeMin value which specifies the minimum time limit minutes of the job.
    .TP
    \fIJobName\fP=<name>
    Identify the name of jobs to be modified or set the job's name to the
    specified value.
    When used to identify jobs to be modified, all jobs belonging to all users
    are modified unless the \fIUserID\fP option is used to identify a specific user.
    Either \fIJobId\fP or \fIJobName\fP is required.
    .TP
    \fIName\fP[=<name>]
    See JobName.
    .TP
    \fINice\fP[=<adjustment>]
    Update the job with an adjusted scheduling priority within Slurm. With no
    adjustment value the scheduling priority is decreased by 100. A negative nice
    value increases the priority, otherwise decreases it. The adjustment range is
    +/\- 2147483645. Only privileged users can specify a negative adjustment.
    .TP
    \fINodeList\fP=<nodes>
    Change the nodes allocated to a running job to shrink its size.
    The specified list of nodes must be a subset of the nodes currently
    allocated to the job. Multiple node names may be specified using
    simple node range expressions (e.g. "lx[10\-20]"). After a job's allocation
    is reduced, subsequent \fBsrun\fR commands must explicitly specify node and
    task counts which are valid for the new allocation.
    .TP
    \fINumCPUs\fP=<min_count>[\-<max_count>]
    Set the job's minimum and optionally maximum count of CPUs to be allocated.
    .TP
    \fINumNodes\fP=<min_count>[\-<max_count>]
    Set the job's minimum and optionally maximum count of nodes to be allocated.
    If the job is already running, use this to specify a node count less than
    currently allocated and resources previously allocated to the job will be
    relinquished. After a job's allocation is reduced, subsequent \fBsrun\fR
    commands must explicitly specify node and task counts which are valid for the
    new allocation. Also see the \fINodeList\fP parameter above. This is the same
    as ReqNodes.
    .TP
    \fINumTasks\fP=<count>
    Set the job's count of required tasks to the specified value. This is the same
    Set the priority to a non\-zero value to permit it to run.
    Explicitly setting a job's priority clears any previously set nice value and
    removes the priority/multifactor plugin's ability to manage a job's priority.
    In order to restore the priority/multifactor plugin's ability to manage a
    job's priority, hold and then release the job.
    Only the Slurm administrator or root can increase job's priority.
    .TP
    \fIQOS\fP=<name>
    Set the job's QOS (Quality Of Service) to the specified value.
    Value may be cleared with blank data value, "QOS=".
    .TP
    \fIReboot\fP=<yes|no>
    Set the job's flag that specifies whether to force the allocated nodes to reboot
    before starting the job. This is only supported with some system configurations
    and therefore it could be silently ignored.
    .TP
    \fIReqCores\fP=<count>
    Change the job's requested Cores count.
    .TP
    \fIReqNodeList\fP=<nodes>
    Set the job's list of required node. Multiple node names may be specified using
    simple node range expressions (e.g. "lx[10\-20]").
    Value may be cleared with blank data value, "ReqNodeList=".
    .TP
    \fIReqNodes\fP=<min_count>[\-<max_count>]
    See NumNodes.
    .TP
    \fIReqProcs\fP=<count>
    See NumTasks.
    .TP
    \fIReqSockets\fP=<count>
    Change the job's requested socket count.
    .TP
    \fIReqThreads\fP=<count>
    Change the job's requested threads count.
    .TP
    \fIRequeue\fP=<0|1>
    Stipulates whether a job should be requeued after a node failure: 0
    for no, 1 for yes.
    .TP
    \fIReservationName\fP=<name>
    Set the job's reservation to the specified value.
    Value may be cleared with blank data value, "ReservationName=".
    .TP
    \fIResetAccrueTime\fP
    Reset the job's accrue time value to 0 meaning it will lose any time
    previously accrued for priority.  Helpful if you have a large queue of jobs
    already in the queue and want to start limiting how many jobs can accrue time
    without waiting for the queue to flush out.
    .TP
    \fISiteFactor\fP=<account>
    Specify the job's admin priority factor in the range of +/\-2147483645.
    \fIteatime\fR (4 PM) and you can have a time\-of\-day suffixed
    with \fIAM\fR or \fIPM\fR for running in the morning or the evening.
    You can also say what day the job will be run, by specifying
    a date of the form \fIMMDDYY\fR or \fIMM/DD/YY\fR or \fIMM.DD.YY\fR,
    or a date and time as \fIYYYY\-MM\-DD[THH:MM[:SS]]\fR.  You can also
    give times like \fInow + count time\-units\fR, where the time\-units
    can be \fIseconds\fR (default), \fIminutes\fR, \fIhours\fR, \fIdays\fR,
    or \fIweeks\fR and you can tell Slurm to run the job today with the keyword
    \fItoday\fR and to run the job tomorrow with the keyword
    \fItomorrow\fR.
    .RS
    .PP
    Notes on date/time specifications:
     \- although the 'seconds' field of the HH:MM:SS time specification is
    allowed by the code, note that the poll time of the Slurm scheduler
    is not precise enough to guarantee dispatch of the job on the exact
    second.  The job will be eligible to start on the next poll
    following the specified time. The exact poll interval depends on the
    Slurm scheduler (e.g., 60 seconds with the default sched/builtin).
     \- if no time (HH:MM:SS) is specified, the default is (00:00:00).
     \- if a date is specified without a year (e.g., MM/DD) then the current
    year is assumed, unless the combination of MM/DD and HH:MM:SS has
    already passed for that year, in which case the next year is used.
    .RE
    .TP
    \fISwitches\fP=<count>[@<max\-time\-to\-wait>]
    When a tree topology is used, this defines the maximum count of switches
    desired for the job allocation. If Slurm finds an allocation containing more
    switches than the count specified, the job remain pending until it either finds
    an allocation with desired switch count or the time limit expires. By default
    there is no switch count limit and no time limit delay. Set the count
    to zero in order to clean any previously set count (disabling the limit).
    The job's maximum time delay may be limited by the system administrator using
    the \fBSchedulerParameters\fR configuration parameter with the
    \fBmax_switch_wait\fR parameter option.
    Also see \fIwait\-for\-switch\fP.

    .TP
    \fIwait\-for\-switch\fP=<seconds>
    Change max time to wait for a switch <seconds> secs.

    .TP
    \fITasksPerNode\fP=<count>
    Change the job's requested TasksPerNode.

    .TP
    \fIThreadSpec\fP=<count>
    Number of threads to reserve per node for system use.
    The job will be charged for these threads, but be unable to use them.
    Will be reported as "*" if not constrained.

    .TP
    allowed before the job array has been split into more than one job record.
    Only the Slurm administrator or root can increase job's TimeLimit.

    .TP
    \fIUserID\fP=<UID or name>
    Used with the \fIJobName\fP option to identify jobs to be modified.
    Either a user name or numeric ID (UID), may be specified.

    .TP
    \fIWCKey\fP=<key>
    Set the job's workload characterization key to the specified value.

    .TP
    \fIWorkDir\fP=<directory_name>
    Set the job's working directory to the specified value. Note that this may
    only be set for jobs in the PENDING state, and that jobs may fail to launch
    if they rely on relative paths to the originally submitted WorkDir.

    .SS JOBS \- SPECIFICATIONS FOR SHOW COMMAND
    The "show" command, when used with the "job" or "job <jobid>"
    entity displays detailed information about a job or jobs.  Much of
    this information may be modified using the "update job" command as
    described above.  However, the following fields displayed by the show
    job command are read\-only and cannot be modified:

    .TP
    \fIAllocNode:Sid\fP
    Local node and system id making the resource allocation.
    .TP
    \fIBatchFlag\fP
    Jobs submitted using the sbatch command have BatchFlag set to 1.
    Jobs submitted using other commands have BatchFlag set to 0.
    .TP
    \fIExitCode\fP=<exit>:<sig>
    Exit status reported for the job by the wait() function.
    The first number is the exit code, typically as set by the exit() function.
    The second number of the signal that caused the process to terminate if
    it was terminated by a signal.
    .TP
    \fIGroupId\fP
    The group under which the job was submitted.
    .TP
    \fIJobState\fP
    The current state of the job.
    .TP
    \fINodeListIndices\fP
    The NodeIndices expose the internal indices into the node table
    associated with the node(s) allocated to the job.
    .TP
    .na
    \fINtasksPerN:B:S:C\fP=
    <tasks_per_node>:<tasks_per_baseboard>:<tasks_per_socket>:<tasks_per_core>
    hidden if the job has not started or if PreemptMode=OFF.
    .TP
    \fIPreSusTime\fP
    Time the job ran prior to last suspend.
    .TP
    \fIReason\fP
    The reason job is not running: e.g., waiting "Resources".
    .TP
    .na
    \fIReqB:S:C:T\fP=
    <baseboard_count>:<socket_per_baseboard_count>:<core_per_socket_count>:<thread_per_core_count>
    Specifies the count of various hardware components requested by the job.
    Unconstrained values may be shown as "0" or "*".
    .ad
    .TP
    \fISecsPreSuspend\fP=<seconds>
    If the job is suspended, this is the run time accumulated by the job
    (in seconds) prior to being suspended.
    .TP
    \fISocks/Node\fP=<count>
    Count of desired sockets per node
    .TP
    \fISubmitTime\fP
    The time  and  date stamp (in localtime) the job was submitted.
    The format of the output is identical to that of the EndTime field.

    NOTE: If a job is requeued, the submit time is reset.
    To obtain the original submit time it is necessary
    to use the "sacct \-j <job_id[.<step_id>]" command also
    designating the \-D or \-\-duplicate option to display all
    duplicate entries for a job.
    .TP
    \fISuspendTime\fP
    Time the job was last suspended or resumed.

    NOTE on information displayed for various job states:
    When you submit a request for the "show job" function the scontrol
    process makes an RPC request call to slurmctld with a REQUEST_JOB_INFO
    message type.  If the state of the job is PENDING, then it returns
    some detail information such as: min_nodes, min_procs, cpus_per_task,
    etc. If the state is other than PENDING the code assumes that it is in
    a further state such as RUNNING, COMPLETE, etc. In these cases the
    code explicitly returns zero for these values. These values are
    meaningless once the job resources have been allocated and the job has
    started.

    .SS STEPS \- SPECIFICATIONS FOR UPDATE COMMAND
    .TP
    \fIStepId\fP=<job_id>[.<step_id>]
    Identify the step to be updated.
    If the job_id is given, but no step_id is specified then all steps of
    the identified job will be modified.
    Field Descriptions:
    .br
    .sp
    A file version
    .br
    B ALPS apid
    .br
    C inblocks
    .br
    D outblocks
    .br
    E exit status
    .br
    F number of allocated CPUs
    .br
    G start time
    .br
    H end time
    .br
    I utime
    .br
    J stime
    .br
    K maxrss
    .br
    L uid
    .br
    M command name
    .TP
    \fITimeLimit\fP=<time>
    The job's time limit.
    Output format is [days\-]hours:minutes:seconds or "UNLIMITED".
    Input format (for \fBupdate\fR command) set is minutes, minutes:seconds,
    hours:minutes:seconds, days\-hours, days\-hours:minutes or
    days\-hours:minutes:seconds.
    Time resolution is one minute and second values are rounded up to
    the next minute.
    If changing the time limit of a step, either specify a new time limit value or
    precede the time with a "+" or "\-" to increment or decrement the current
    time limit (e.g. "TimeLimit=+30"). In order to increment or decrement the
    current time limit, the \fIStepId\fP specification must precede the
    \fITimeLimit\fP specification.

    .SS NODES \- SPECIFICATIONS FOR UPDATE COMMAND
    .TP
    \fINodeName\fP=<name>
    Identify the node(s) to be updated. Multiple node names may be specified using
    simple node range expressions (e.g. "lx[10\-20]"). This specification is required.

    .TP
    \fIActiveFeatures\fP=<features>
    Identify the feature(s) currently active on the specified node.
    the new value.
    AvailableFeatures assigned via \fBscontrol\fR will only persist across the
    restart of the slurmctld daemon with the \fI\-R\fR option and state files
    preserved or slurmctld's receipt of a SIGHUP.
    Update slurm.conf with any changes meant to be persistent across normal
    restarts of slurmctld or the execution of \fBscontrol reconfig\fR.

    \fBNote\fR: Available features being removed via \fBscontrol\fR must not be
    active (i.e. remove them from \fIActiveFeatures\fP first).

    .TP
    \fIComment\fP=<comment>
    Arbitrary descriptive string.
    Use quotes to enclose a comment having more than one word

    .TP
    \fICpuBind\fP=<node>
    Specify the task binding mode to be used by default for this node.
    Supported options include: "none", "board", "socket", "ldom" (NUMA), "core",
    "thread" and "off" (remove previous binding mode).

    .TP
    \fIGres\fP=<gres>
    Identify generic resources to be associated with the specified node.  Any
    previously defined generic resources will be overwritten with the new value.
    Specifications for multiple generic resources should be comma separated.
    Each resource specification consists of a name followed by an optional
    colon with a numeric value (default value is one) (e.g. "Gres=bandwidth:10000").
    Modification of GRES count associated with specific files (e.g. GPUs) is not
    allowed other than to set their count on a node to zero.
    In order to change the GRES count to another value, modify your slurm.conf and
    gres.conf files and restart daemons.
    If GRES as associated with specific sockets, that information will be reported
    For example if all 4 GPUs on a node are all associated with socket zero, then
    "Gres=gpu:4(S:0)". If associated with sockets 0 and 1 then "Gres=gpu:4(S:0-1)".
    The information of which specific GPUs are associated with specific GPUs is not
    reported, but only available by parsing the gres.conf file.
    Generic resources assigned via \fBscontrol\fR will only persist across the
    restart of the slurmctld daemon with the \fI\-R\fR option and state files
    preserved or slurmctld's receipt of a SIGHUP.
    Update slurm.conf with any changes meant to be persistent across normal
    restarts of slurmctld or the execution of \fBscontrol reconfig\fR.

    .TP
    \fINodeAddr\fP=<node address>
    Name that a node should be referred to in establishing a communications path.
    This name will be used as an argument to the getaddrinfo() function for
    identification. If a node range expression is used to designate multiple nodes,
    they must exactly match the entries in the \fINodeName\fP
    (e.g. "NodeName=lx[0\-7] NodeAddr=elx[0\-7]"). \fINodeAddr\fP may also contain
    IP addresses.

    \fIReason\fP=<reason>
    Identify the reason the node is in a "DOWN", "DRAINED", "DRAINING",
    "FAILING" or "FAIL" state.
    Use quotes to enclose a reason having more than one word.

    .TP
    \fIState\fP=<state>
    Identify the state to be assigned to the node. Possible node states are "NoResp",
    "ALLOC", "ALLOCATED", "COMPLETING", "DOWN", "DRAIN", "FAIL", "FAILING",
    "FUTURE" "IDLE", "MAINT", "MIXED", "PERFCTRS/NPC", "RESERVED", "POWER_DOWN",
    "POWER_UP", "RESUME" or "UNDRAIN". Not all of those states can be set using
    the scontrol command only the following can: "CANCEL_REBOOT", "DOWN", "DRAIN",
    "FAIL", "FUTURE", "RESUME", "NoResp", "POWER_DOWN", "POWER_UP" and "UNDRAIN".
    If a node is in a "MIXED" state it usually means the node is in
    multiple states.  For instance if only part of the node is "ALLOCATED"
    and the rest of the node is "IDLE" the state will be "MIXED".
    If you want to remove a node from service, you typically want to set
    its state to "DRAIN".
    "CANCEL_REBOOT" cancels a pending reboot on the node (same as "scontrol
    cancel_reboot <node>").
    "FAILING" is similar to "DRAIN" except that some applications will
    seek to relinquish those nodes before the job completes.
    "PERFCTRS/NPC" indicates that Network Performance Counters associated with this
    node are in use, rendering this node as not usable for any other jobs.
    "RESERVED" indicates the node is in an advanced reservation and not generally
    available.
    "RESUME" is not an actual node state, but will change a node state from
    "DRAINED", "DRAINING", "DOWN" or "REBOOT" to either
    "IDLE" or "ALLOCATED" state as appropriate.
    "RESUME" will also clear the "POWERING_DOWN" state of a node and make it
    eligible to be allocted.
    "UNDRAIN" clears the node from being drained (like "RESUME"), but will
    not change the node's base state (e.g. "DOWN").
    Setting a node "DOWN" will cause all running and suspended jobs on that
    node to be terminated.
    "POWER_DOWN" and "POWER_UP" will use the configured \fISuspendProg\fR and
    \fIResumeProg\fR programs to explicitly place a node in or out of a power
    saving mode. If a node is already in the process of being powered up or down,
    the command will only change the state of the node but won't have any
    effect until the configured ResumeTimeout or SuspendTimeout is reached.
    Use of this command can be useful in situations
    where a \fIResumeProg\fR like \fIcapmc\fR in Cray machines is stalled and one
    wants to restore the node to "IDLE" manually, in this case rebooting the node
    and setting the state to "POWER_DOWN" will cancel the previous "POWER_UP"
    state and the node will become "IDLE".
    The "NoResp" state will only set the "NoResp" flag for a node without
    changing its underlying state.
    While all of the above states are valid, some of them are not valid new
    node states given their prior state.
    If the node state code printed is followed by "~", this indicates
    the node is presently in a power saving mode (typically
    running at reduced frequency).
    for the subsequent node allocation decisions.
    Weight assigned via \fBscontrol\fR will only persist across the restart
    of the slurmctld daemon with the \fI\-R\fR option and state files
    preserved or slurmctld's receipt of a SIGHUP.
    Update slurm.conf with any changes meant to be persistent across normal
    restarts of slurmctld or the execution of \fBscontrol reconfig\fR.

    .SS NODES \- SPECIFICATIONS FOR SHOW COMMAND
    .TP
    The meaning of the energy information is as follows:

    .TP
    \fICurrentWatts\fP
    The instantaneous power consumption of the node at the time of the last node
    energy accounting sample, in watts.

    .TP
    \fILowestJoules\fP
    The energy consumed by the node between the last time it was powered on and
    the last time it was registered by slurmd, in joules.

    .TP
    \fIConsumedJoules\fP
    The energy consumed by the node between the last time it was registered by
    the slurmd daemon and the last node energy accounting sample, in joules.

    .PP
    If the reported value is "n/s" (not supported), the node does not support the
    configured \fBAcctGatherEnergyType\fR plugin. If the reported value is zero, energy
    accounting for nodes is disabled.

    .TP
    The meaning of the external sensors information is as follows:

    .TP
    \fIExtSensorsJoules\fP
    The energy consumed by the node between the last time it was powered on
    and the last external sensors plugin node sample, in joules.

    .TP
    \fIExtSensorsWatts\fP
    The instantaneous power consumption of the node at the time of the last
    external sensors plugin node sample, in watts.

    .TP
    \fIExtSensorsTemp\fP
    The temperature of the node at the time of the last external sensors plugin
    node sample, in celsius.

    .PP
    If the reported value is "n/s" (not supported), the node does not support the

    .TP
    The meaning of the memory information is as follows:

    .TP
    \fIRealMemory\fP
    The total memory, in MB, on the node.

    .TP
    \fIAllocMem\fP
    The total memory, in MB, currently allocated by jobs on the node.

    .TP
    \fIFreeMem\fP
    The total memory, in MB, currently free on the node as reported by the OS.

    .SS FRONTEND \- SPECIFICATIONS FOR UPDATE COMMAND
    .TP
    \fIFrontendName\fP=<name>
    Identify the front end node to be updated. This specification is required.

    .TP
    \fIReason\fP=<reason>
    Identify the reason the node is in a "DOWN" or "DRAIN" state.
    Use quotes to enclose a reason having more than one word.

    .TP
    \fIState\fP=<state>
    Identify the state to be assigned to the front end node. Possible values are
    "DOWN", "DRAIN" or "RESUME".
    If you want to remove a front end node from service, you typically want to set
    its state to "DRAIN".
    "RESUME" is not an actual node state, but will return a "DRAINED", "DRAINING",
    or "DOWN" front end node to service, either "IDLE" or "ALLOCATED" state as
    appropriate.
    Setting a front end node "DOWN" will cause all running and suspended jobs on
    that node to be terminated.

    .SS PARTITIONS \- SPECIFICATIONS FOR CREATE, UPDATE, AND DELETE COMMANDS
    .TP
    \fIAllowGroups\fP=<name>
    Identify the user groups which may use this partition.
    Multiple groups may be specified in a comma separated list.
    To permit all groups to use the partition specify "AllowGroups=ALL".

    .TP
    \fIAllocNodes\fP=<name>
    Comma separated list of nodes from which users can execute jobs in the
    partition.
    Node names may be specified using the node range expression syntax
    described above.
    The default value is "ALL".
    Specify if this partition is to be used by jobs which do not explicitly
    identify a partition to use.
    Possible output values are "YES" and "NO".
    In order to change the default partition of a running system,
    use the scontrol update command and set Default=yes for the partition
    that you want to become the new default.

    .TP
    \fIDefaultTime\fP=<time>
    Run time limit used for jobs that don't specify a value. If not set
    then MaxTime will be used.
    Format is the same as for MaxTime.

    .TP
    \fIDefMemPerCPU\fP=<MB>
    Set the default memory to be allocated per CPU for jobs in this partition.
    The memory size is specified in megabytes.
    .TP
    \fIDefMemPerNode\fP=<MB>
    Set the default memory to be allocated per node for jobs in this partition.
    The memory size is specified in megabytes.

    .TP
    \fIDisableRootJobs\fP=<yes|no>
    Specify if jobs can be executed as user root.
    Possible values are "YES" and "NO".

    .TP
    \fIGraceTime\fP=<seconds>
    Specifies, in units of seconds, the preemption grace time
    to be extended to a job which has been selected for preemption.
    The default value is zero, no preemption grace time is allowed on
    this partition or qos.
    (Meaningful only for PreemptMode=CANCEL)

    .TP
    \fIHidden\fP=<yes|no>
    Specify if the partition and its jobs should be hidden from view.
    Hidden partitions will by default not be reported by Slurm APIs
    or commands.
    Possible values are "YES" and "NO".

    .TP
    \fIJobDefaults\fP=<specs>
    Specify job default values using a comma delimited list of "key=value" pairs.
    Supported keys include
    .RS
    .TP 14
    \fIDefCpuPerGPU\fP
    Default number of CPUs per allocated GPU.
    .TP
    \fIDefMemPerGPU\fP
    Set the maximum number of nodes which will be allocated to any single job
    in the partition. Specify a number, "INFINITE" or "UNLIMITED".
    Changing the \fIMaxNodes\fP of a partition has no effect upon jobs that
    have already begun execution.

    .TP
    \fIMaxTime\fP=<time>
    The maximum run time for jobs.
    Output format is [days\-]hours:minutes:seconds or "UNLIMITED".
    Input format (for \fBupdate\fR command) is minutes, minutes:seconds,
    hours:minutes:seconds, days\-hours, days\-hours:minutes or
    days\-hours:minutes:seconds.
    Time resolution is one minute and second values are rounded up to
    the next minute.
    Changing the \fIMaxTime\fP of a partition has no effect upon jobs that
    have already begun execution.

    .TP
    \fIMinNodes\fP=<count>
    Set the minimum number of nodes which will be allocated to any single job
    in the partition.
    Changing the \fIMinNodes\fP of a partition has no effect upon jobs that
    have already begun execution. Increasing this value may prevent pending jobs
    from starting, even if they were submitted without -N/--nodes specification.
    If you do get in that situation, updating the \fIMinNodes\fP value of a
    pending job using the scontrol command will allow that job to be scheduled.

    .TP
    \fINodes\fP=<name>
    Identify the node(s) to be associated with this partition. Multiple node names
    may be specified using simple node range expressions (e.g. "lx[10\-20]").
    Note that jobs may only be associated with one partition at any time.
    Specify a blank data value to remove all nodes from a partition: "Nodes=".
    Changing the \fINodes\fP in a partition has no effect upon jobs that
    have already begun execution.

    .TP
    \fIOverTimeLimit\fP=<count>
    Number of minutes by which a job can exceed its time limit before
    being canceled.
    The configured job time limit is treated as a \fIsoft\fR limit.
    Adding \fBOverTimeLimit\fR to the \fIsoft\fR limit provides a \fIhard\fR
    limit, at which point the job is canceled.
    This is particularly useful for backfill scheduling, which bases upon
    each job's soft time limit.
    A partition\-specific \fIOverTimeLimit\fP will override any global
    \fIOverTimeLimit\fP value.
    If not specified, the global \fIOverTimeLimit\fP value will take precedence.
    May not exceed 65533 minutes.
    An input value of "UNLIMITED" will clear any previously configured
    partition\-specific \fIOverTimeLimit\fP value.

    Reset the mechanism used to preempt jobs in this partition if \fIPreemptType\fP
    is configured to \fIpreempt/partition_prio\fP. The default preemption mechanism
    is specified by the cluster\-wide \fIPreemptMode\fP configuration parameter.
    Possible values are "OFF", "CANCEL", "REQUEUE" and "SUSPEND".

    .TP
    \fIPriority\fP=<count>
    Jobs submitted to a higher priority partition will be dispatched
    before pending jobs in lower priority partitions and if possible
    they will preempt running jobs from lower priority partitions.
    Note that a partition's priority takes precedence over a job's
    priority.
    The value may not exceed 65533.

    .TP
    \fIPriorityJobFactor\fP=<count>
    Partition factor used by priority/multifactor plugin in calculating
    job priority.  The value may not exceed 65533.  Also see PriorityTier.

    .TP
    \fIPriorityTier\fP=<count>
    Jobs submitted to a partition with a higher priority tier value will
    be dispatched before pending jobs in partition with lower priority tier
    value and,  if  possible,  they  will  preempt  running jobs from
    partitions with lower priority tier values.  Note that a partition's
    priority tier takes precedence over a job's priority.  The value may
    not exceed 65533.  Also see PriorityJobFactor.

    .TP
    \fIQOS\fP=<QOSname|blank to remove>
    Set the partition QOS with a QOS name or to remove the Partition QOS
    leave the option blank.

    .TP
    \fIRootOnly\fP=<yes|no>
    Specify if only allocation requests initiated by user root will be satisfied.
    This can be used to restrict control of the partition to some meta\-scheduler.
    Possible values are "YES" and "NO".

    .TP
    \fIReqResv\fP=<yes|no>
    Specify if only allocation requests designating a reservation will be
    satisfied.  This is used to restrict partition usage to be allowed only
    within a reservation.
    Possible values are "YES" and "NO".

    .TP
    \fIShared\fP=<yes|no|exclusive|force>[:<job_count>]
    Renamed to \fIOverSubscribe\fP, see option descriptions above.

    .TP
    \fIState\fP=<up|down|drain|inactive>
    \fIDRAIN\fP
    Designates that no new jobs may be queued on the partition (job
    submission requests will be denied with an error message), but jobs
    already queued on the partition may be allocated nodes and run.
    See also the "Alternate" partition specification.
    .TP
    \fIINACTIVE\fP
    Designates that no new jobs may be queued on the partition,
    and jobs already queued may not be allocated nodes and run.
    See also the "Alternate" partition specification.
    .RE

    .TP
    \fITRESBillingWeights\fP=<TRES Billing Weights>
    TRESBillingWeights is used to define the billing weights of each TRES type that
    will be used in calculating the usage of a job. The calculated usage is used
    when calculating fairshare and when enforcing the TRES billing limit on jobs.
    Updates affect new jobs and not existing jobs.
    See the slurm.conf man page for more information.

    .SS RESERVATIONS \- SPECIFICATIONS FOR CREATE, UPDATE, AND DELETE COMMANDS
    .TP

    .TP
    \fIReservation\fP=<name>
    Identify the name of the reservation to be created, updated, or deleted.
    This parameter is required for update and is the only parameter for delete.
    For create, if you do not want to give a reservation name, use
    "scontrol create res ..." and a name will be created automatically.

    .TP
    \fIAccounts\fP=<account list>
    List of accounts permitted to use the reserved nodes, for example
    "Accounts=physcode1,physcode2".
    A user in any of the accounts may use the reserved nodes.
    A new reservation must specify Users or Groups and/or Accounts.
    If both Users/Groups and Accounts are specified, a job must match both in order
    to use the reservation.
    Accounts can also be denied access to reservations by preceding all of the
    account names with '\-'. Alternately precede the equal sign with '\-'.
    For example, "Accounts=-physcode1,-physcode2" or "Accounts-=physcode1,physcode2"
    will permit any account except physcode1 and physcode2 to use the reservation.
    You can add or remove individual accounts from an existing reservation by
    using the update command and adding a '+' or '\-' sign before the '=' sign.
    If accounts are denied access to a reservation (account name preceded by a '\-'),
    then all other accounts are implicitly allowed to use the reservation and it is
    not possible to also explicitly specify allowed accounts.

    .TP
    \fIBurstBuffer\fP=<buffer_spec>[,<buffer_spec>,...]
    Specification of burst buffer resources which are to be reserved.
    "buffer_spec" consists of four elements:
    Jobs using this reservation are not restricted to these burst buffer resources,
    but may use these reserved resources plus any which are generally available.
    NOTE: Usually Slurm interprets KB, MB, GB, TB, PB, TB units as powers of 1024,
    but for Burst Buffers size specifications Slurm supports both IEC/SI formats.
    This is because the CRAY API for managing DataWarps supports both formats.

    .TP
    \fICoreCnt\fP=<num>
    This option is only supported when \fISelectType=select/cons_res\fP or
    \fIselect/cons_tres\fP. Identify number of cores to be reserved.
    If NodeCnt is used without the FIRST_CORES flag, this
    is the total number of cores to reserve where cores per node is CoreCnt/NodeCnt.
    If a nodelist is used, or if NodeCnt is used with the FIRST_CORES flag, this
    should be an array of core numbers by node: Nodes=node[1\-5] CoreCnt=2,2,3,3,4
    or flags=FIRST_CORES NodeCnt=5 CoreCnt=1,2,1,3,2.

    .TP
    \fILicenses\fP=<license>
    Specification of licenses (or other resources available on all
    nodes of the cluster) which are to be reserved.
    License names can be followed by a colon and count
    (the default count is one).
    Multiple license names should be comma separated (e.g. "Licenses=foo:4,bar").
    A new reservation must specify one or more resource to be included: NodeCnt,
    Nodes and/or Licenses.
    If a reservation includes Licenses, but no NodeCnt or Nodes, then the option
    \fIFlags=LICENSE_ONLY\fP must also be specified.
    Jobs using this reservation are not restricted to these licenses, but may
    use these reserved licenses plus any which are generally available.

    .TP
    \fIMaxStartDelay\fP[=<timespec>]
    Change MaxStartDelay value which specifies the maximum time an eligible job not
    requesting this reservation can delay a job requesting it. Default is none.
    Valid formats are minutes, minutes:seconds,
    hours:minutes:seconds, days\-hours, days\-hours:minutes,
    days\-hours:minutes:seconds.  Time resolution is one minute and
    second values are rounded up to the next minute. Output format is always
    [days\-]hours:minutes:seconds.

    .TP
    \fINodeCnt\fP=<num>[,num,...]
    Identify number of nodes to be reserved. The number can include a suffix of
    "k" or "K", in which case the number specified is multiplied by 1024.
    A new reservation must specify one or more resource to be included: NodeCnt,
    Nodes and/or Licenses.

    .TP
    \fINodes\fP=<name>
    Identify the node(s) to be reserved. Multiple node names
    may be specified using simple node range expressions (e.g. "Nodes=lx[10\-20]").
    Specify a blank data value to remove all nodes from a reservation: "Nodes=".
    with \fIAM\fR or \fIPM\fR for running in the morning or the evening.
    You can also say what day the job will be run, by specifying
    a date of the form \fIMMDDYY\fR or \fIMM/DD/YY\fR or \fIMM.DD.YY\fR,
    or a date and time as \fIYYYY\-MM\-DD[THH:MM[:SS]]\fR.  You can also
    give times like \fInow + count time\-units\fR, where the time\-units
    can be \fIseconds\fR (default), \fIminutes\fR, \fIhours\fR, \fIdays\fR,
    or \fIweeks\fR and you can tell Slurm to run the job today with the keyword
    \fItoday\fR and to run the job tomorrow with the keyword
    \fItomorrow\fR. You cannot update the \fIStartTime\fP of a reservation
    in \fIACTIVE\fP state.

    .TP
    \fIEndTime\fP=<time_spec>
    The end time for the reservation.  A new reservation must specify an end
    time or a duration.  Valid formats are the same as for StartTime.

    .TP
    \fIDuration\fP=<time>
    The length of a reservation.  A new reservation must specify an end
    time or a duration.  Valid formats are minutes, minutes:seconds,
    hours:minutes:seconds, days\-hours, days\-hours:minutes,
    days\-hours:minutes:seconds, or UNLIMITED.  Time resolution is one minute and
    second values are rounded up to the next minute. Output format is always
    [days\-]hours:minutes:seconds.

    .TP
    \fIPartitionName\fP=<name>
    Partition used to reserve nodes from. This will attempt to allocate all
    nodes in the specified partition unless you request fewer resources than
    are available with \fICoreCnt\fR, \fINodeCnt\fR or \fITRES\fR. Jobs will be
    allowed to use this reservation even if running in a different partition. There
    only needs to be overlapping nodes from that different partition and the nodes
    used in the reservation.

    .TP
    \fIFlags\fP=<flags>
    Flags associated with the reservation.
    You can add or remove individual flags from an existing reservation by
    adding a '+' or '\-' sign before the '=' sign.  For example:
    Flags\-=DAILY (NOTE: this shortcut is not supported for all flags).
    Currently supported flags include:
    .RS
    .TP 14
    \fIANY_NODES\fR
    This is a reservation for burst buffers and/or licenses only and not compute
    nodes.
    If this flag is set, a job using this reservation may use the associated
    burst buffers and/or licenses plus any compute nodes.
    If this flag is not set, a job using this reservation may use only the nodes
    and licenses associated with the reservation.
    .TP
    \fIDAILY\fR
    Use the lowest numbered cores on a node only. Flag removal with '-=' is not
    supported.
    .TP
    \fIIGNORE_JOBS\fR
    Ignore currently running jobs when creating the reservation.
    This can be especially useful when reserving all nodes in the system
    for maintenance.
    .TP
    \fILICENSE_ONLY\fR
    See \fIANY_NODES\fR.
    .TP
    \fIMAINT\fR
    Maintenance mode, receives special accounting treatment.
    This reservation is permitted to use resources that are already in another
    reservation.
    .TP
    \fIMAGNETIC\fR
    This flag allows jobs to be considered for this reservation even if they didn't
    request it.
    .TP
    \fINO_HOLD_JOBS_AFTER\fR
    By default, when a reservation ends the reservation request will be removed from
    any pending jobs submitted to the reservation and will be put into a held state.
    Use this flag to let jobs run outside of the reservation after the reservation
    is gone. Flag removal with '-=' is not supported.
    .TP
    \fIOVERLAP\fR
    This reservation can be allocated resources that are already in another
    reservation. Flag removal with '-=' is not supported.
    .TP
    \fIPART_NODES\fR
    This flag can be used to reserve all nodes within the specified
    partition.  PartitionName and Nodes=ALL must be specified with this flag.
    .TP
    \fIPURGE_COMP\fR[=<timespec>]
    Purge the reservation if it is ever idle for timespec (no jobs associated with
    it).  If timespec isn't given then 5 minutes is the default.
    Valid timespec formats are minutes, minutes:seconds,
    hours:minutes:seconds, days\-hours, days\-hours:minutes,
    days\-hours:minutes:seconds.  Time resolution is one minute and
    second values are rounded up to the next minute. Output format is always
    [days\-]hours:minutes:seconds.
    .TP
    \fIREPLACE\fR
    Nodes which are DOWN, DRAINED, or allocated to jobs are automatically
    replenished using idle resources.
    This option can be used to maintain a constant number of idle resources
    available for pending jobs (subject to availability of idle resources).
    This should be used with the \fINodeCnt\fP reservation option; do not identify
    specific nodes to be included in the reservation. Flag removal with '-=' is
    not supported.

    \fISPEC_NODES\fR
    Reservation is for specific nodes (output only).
    .TP
    \fISTATIC_ALLOC\fR
    Make it so after the nodes are selected for a reservation they don't
    change.  Without this option when nodes are selected for a reservation
    and one goes down the reservation will select a new node to fill the spot.
    .TP
    \fITIME_FLOAT\fR
    The reservation start time is relative to the current time and moves forward
    through time (e.g. a StartTime=now+10minutes will always be 10 minutes in the
    future). Repeating (e.g. DAILY) floating reservations are not supported. Flag
    cannot be added to or removed from an existing reservation.
    .TP
    \fIWEEKDAY\fR
    Repeat the reservation at the same time on every weekday (Monday, Tuesday,
    Wednesday, Thursday and Friday).
    .TP
    \fIWEEKEND\fR
    Repeat the reservation at the same time on every weekend day (Saturday and
    Sunday).
    .TP
    \fIWEEKLY\fR
    Repeat the reservation at the same time every week.
    .RE

    .TP
    \fIFeatures\fP=<features>
    Set the reservation's required node features. Multiple values
    may be "&" separated if all features are required (AND operation) or
    separated by "|" if any of the specified features are required (OR operation).
    Parenthesis are also supported for features to be ANDed together with counts
    of nodes having the specified features.
    For example "\fBFeatures=[(knl&a2a&flat)*4&haswell*2]"\fR indicates the
    advanced reservation should include 4 nodes with ALL of the features "knl",
    "a2a", and "flat" plus 2 nodes with the feature "haswell".

    Value may be cleared with blank data value, "Features=".

    .TP
    \fIGroups\fP=<group list>
    List of groups permitted to use the reserved nodes, for example
    "Group=bio,chem".
    A new reservation must specify Users or Groups and/or Accounts.
    If both Users/Groups and Accounts are specified, a job must match both in order
    to use the reservation.
    Unlike users groups do not allow denied access to reservations.
    You can add or remove individual groups from an existing reservation by
    using the update command and adding a '+' or '\-' sign before the '=' sign.
    NOTE: Groups and Users are mutually exclusive in reservations, if you want to
    switch between the 2 you must update the reservation with a group='' or user=''
    and fill in the opposite with the appropriate setting.
    user names with '\-'. Alternately precede the equal sign with '\-'.
    For example, "User=-jones1,-smith2" or "User-=jones1,smith2"
    will permit any user except jones1 and smith2 to use the reservation.
    You can add or remove individual users from an existing reservation by
    using the update command and adding a '+' or '\-' sign before the '=' sign.
    If users are denied access to a reservation (user name preceded by a '\-'),
    then all other users are implicitly allowed to use the reservation and it is
    not possible to also explicitly specify allowed users.
    NOTE: Groups and Users are mutually exclusive in reservations, if you want to
    switch between the 2 you must update the reservation with a group='' or user=''
    and fill in the opposite with the appropriate setting.

    .TP
    \fITRES\fP=<tres_spec>
    Comma\-separated list of TRES required for the reservation. Current supported
    TRES types with reservations are: CPU, Node, License and BB. CPU and Node
    follow the same format as CoreCnt and NodeCnt parameters respectively.
    License names can be followed by an equal '=' and a count:

    License/<name1>=<count1>[,License/<name2>=<count2>,...]

    BurstBuffer can be specified in a similar way as BurstBuffer parameter. The
    only difference is that colon symbol ':' should be replaced by an equal '='
    in order to follow the TRES format.

    Some examples of TRES valid specifications:

    TRES=cpu=5,bb/cray=4,license/iop1=1,license/iop2=3

    TRES=node=5k,license/iop1=2

    As specified in CoreCnt, if a nodelist is specified, cpu can be an array
    of core numbers by node:
    nodes=compute[1\-3] TRES=cpu=2,2,1,bb/cray=4,license/iop1=2

    Please note that CPU, Node, License and BB can override CoreCnt, NodeCnt,
    Licenses and BurstBuffer parameters respectively.  Also CPU represents
    CoreCnt, in a reservation and will be adjusted if you have threads per
    core on your nodes.

    Note that a reservation that contains nodes or cores is associated with
    one partition, and can't span resources over multiple partitions.
    The only exception from this is when
    the reservation is created with explicitly requested nodes.

    .SH "PERFORMANCE"
    .PP
    Executing \fBscontrol\fR sends a remote procedure call to \fBslurmctld\fR. If
    enough calls from \fBscontrol\fR or other Slurm client commands that send remote
    procedure calls to the \fBslurmctld\fR daemon come in at once, it can result in
    a degradation of performance of the \fBslurmctld\fR daemon, possibly resulting
    in a denial of service.
    \fB\-a, \-\-all\fR
    .TP
    \fBSCONTROL_FEDERATION\fR
    \fB\-\-federation\fR
    .TP
    \fBSCONTROL_FUTURE\fR
    \fB\-F, \-\-future\fR
    .TP
    \fBSCONTROL_LOCAL\fR
    \fB\-\-local\fR
    .TP
    \fBSCONTROL_SIBLING\fR
    \fB\-\-sibling\fR
    .TP
    \fBSLURM_BITSTR_LEN\fR
    Specifies the string length to be used for holding a job array's task ID
    expression.
    The default value is 64 bytes.
    A value of 0 will print the full expression with any length required.
    Larger values may adversely impact the application performance.
    .TP
    \fBSLURM_CLUSTERS\fR
    Same as \fB\-\-clusters\fR
    .TP
    \fBSLURM_CONF\fR
    The location of the Slurm configuration file.
    .TP
    \fBSLURM_CONF_OUT\fR
    When running 'write config', the location of the Slurm configuration file to be
    written.
    .TP
    \fBSLURM_TIME_FORMAT\fR
    Specify the format used to report time stamps. A value of \fIstandard\fR, the
    default value, generates output in the form "year\-month\-dateThour:minute:second".
    A value of \fIrelative\fR returns only "hour:minute:second" if the current day.
    For other dates in the current year it prints the "hour:minute" preceded by
    "Tomorr" (tomorrow), "Ystday" (yesterday), the name of the day for the coming
    week (e.g. "Mon", "Tue", etc.), otherwise the date (e.g. "25 Apr").
    For other years it returns a date month and year without a time (e.g.
    "6 Jun 2012"). All of the time stamps use a 24 hour format.

    A valid strftime() format can also be specified. For example, a value of
    "%a %T" will report the day of the week and a time stamp (e.g. "Mon 12:34:56").

    .TP
    \fBSLURM_TOPO_LEN\fR
    Specify the maximum size of the line when printing Topology. If not set, the
    default value is unlimited.

    .SH "AUTHORIZATION"

    When using SlurmDBD, users who have an AdminLevel defined (Operator
    \fBscontrol update step:       \fR Admin, Operator, Coordinator
    .br
    .sp
    \fBscontrol show node:         \fR Admin, Operator
    .br
    \fBscontrol update node:       \fR Admin
    .br
    .sp
    \fBscontrol create partition:  \fR Admin
    .br
    \fBscontrol show partition:    \fR Admin, Operator
    .br
    \fBscontrol update partition:  \fR Admin
    .br
    \fBscontrol delete partition:  \fR Admin
    .br
    .sp
    \fBscontrol create reservation:\fR Admin, Operator
    .br
    \fBscontrol show reservation:  \fR Admin, Operator
    .br
    \fBscontrol update reservation:\fR Admin, Operator
    .br
    \fBscontrol delete reservation:\fR Admin, Operator
    .br
    .sp
    \fBscontrol reconfig:          \fR Admin
    .br
    \fBscontrol shutdown:          \fR Admin
    .br
    \fBscontrol takeover:          \fR Admin
    .br

    .SH "EXAMPLES"
    .nf
    $ scontrol
    scontrol: show part debug
    PartitionName=debug
       AllocNodes=ALL AllowGroups=ALL Default=YES
       DefaultTime=NONE DisableRootJobs=NO Hidden=NO
       MaxNodes=UNLIMITED MaxTime=UNLIMITED MinNodes=1
       Nodes=snowflake[0-48]
       Priority=1 RootOnly=NO OverSubscribe=YES:4
       State=UP TotalCPUs=694 TotalNodes=49
    scontrol: update PartitionName=debug MaxTime=60:00 MaxNodes=4
    scontrol: show job 71701
    JobId=71701 Name=hostname
       UserId=<B>da(1000) GroupId=da(1000)
       Priority=66264 Account=none QOS=normal WCKey=*123
       JobState=COMPLETED Reason=None Dependency=(null)
       TimeLimit=UNLIMITED Requeue=1 Restarts=0 BatchFlag=0 ExitCode=0:0
       SubmitTime=2010-01-05T10:58:40 EligibleTime=2010-01-05T10:58:40

    scontrol: create res StartTime=2009-04-01T08:00:00 Duration=5:00:00 Users=dbremer NodeCnt=10
    Reservation created: dbremer_1
    scontrol: update Reservation=dbremer_1 Flags=Maint NodeCnt=20
    scontrol: delete Reservation=dbremer_1
    scontrol: quit
    .fi

    .SH "COPYING"
    Copyright (C) 2002\-2007 The Regents of the University of California.
    Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
    .br
    Copyright (C) 2008\-2010 Lawrence Livermore National Security.
    .br
    Copyright (C) 2010-2018 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 "FILES"
    .LP
    /etc/slurm.conf
    .SH "SEE ALSO"
    \fBscancel\fR(1), \fBsinfo\fR(1), \fBsqueue\fR(1),
    \fBslurm_create_partition\fR (3),
    \fBslurm_delete_partition\fR (3),
    \fBslurm_load_ctl_conf\fR (3),
    \fBslurm_load_jobs\fR (3), \fBslurm_load_node\fR (3),
    \fBslurm_load_partitions\fR (3),
    \fBslurm_reconfigure\fR (3),  \fBslurm_requeue\fR (3),
    \fBslurm_resume\fR (3),
    \fBslurm_shutdown\fR (3), \fBslurm_suspend\fR (3),
    \fBslurm_takeover\fR (3),
    \fBslurm_update_job\fR (3), \fBslurm_update_node\fR (3),
    \fBslurm_update_partition\fR (3),
    \fBslurm.conf\fR(5), \fBslurmctld\fR(8)