diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5 index de37aa38ed8bccd003cfa7ace938d36891c79029..59b4bbcc07319193c91672c361f51ef0140eb1e6 100644 --- a/doc/man/man5/slurm.conf.5 +++ b/doc/man/man5/slurm.conf.5 @@ -2998,20 +2998,54 @@ The default value is 1. .TP \fBState\fR State of the node with respect to the initiation of user jobs. -Acceptable values are "DOWN", "DRAIN", "FAIL", "FAILING" and "UNKNOWN". -"DOWN" indicates the node failed and is unavailable to be allocated work. -"DRAIN" indicates the node is unavailable to be allocated work. -"FAIL" indicates the node is expected to fail soon, has +Acceptable values are "CLOUD", "DOWN", "DRAIN", "FAIL", "FAILING", "FUTURE" +and "UNKNOWN". +Node states of "BUSY" and "IDLE" should not be specified in the node +configuration, but set the node state to "UNKNOWN" instead. +Setting the node state to "UNKNOWN" will result in the node state being set to +"BUSY", "IDLE" or other appropriate state based upon recovered system state +information. +The default value is "UNKNOWN". +Also see the \fBDownNodes\fR parameter below. +.RS +.TP 10 +\fBCLOUD\fP +Indicates the node exists in the cloud. +It's initial state will be treated as powered down. +The node will be available for use after it's state is recovered from SLURM's +state save file or the slurmd daemon starts on the compute node. +.TP +\fBDOWN\fP +Indicates the node failed and is unavailable to be allocated work. +.TP +\fBDRAIN\fP +Indicates the node is unavailable to be allocated work.on. +.TP +\fBFAIL\fP +Indicates the node is expected to fail soon, has no jobs allocated to it, and will not be allocated to any new jobs. -"FAILING" indicates the node is expected to fail soon, has +.TP +\fBFAILING\fP +Indicates the node is expected to fail soon, has one or more jobs allocated to it, but will not be allocated to any new jobs. -"UNKNOWN" indicates the node's state is undefined (BUSY or IDLE), +.TP +\fBFUTURE\fP +Indicates the node is defined for future use and need not +exist when the SLURM daemons are started. These nodes can be made available +for use simply by updating the node state using the scontrol command rather +than restarting the slurmctld daemon. After these nodes are made available, +change their \fRState\fR in the slurm.conf file. Until these nodes are made +available, they will not be seen using any SLURM commands or nor will +any attempt be made to contact them. +.TP +\fBUNKNOWN\fP +Indicates the node's state is undefined (BUSY or IDLE), but will be established when the \fBslurmd\fR daemon on that node registers. The default value is "UNKNOWN". -Also see the \fBDownNodes\fR parameter below. +.RE .TP \fBThreadsPerCore\fR @@ -3085,16 +3119,15 @@ Identifies the reason for a node being in state "DOWN", "DRAIN", .TP \fBState\fR State of the node with respect to the initiation of user jobs. -Acceptable values are "BUSY", "DOWN", "DRAIN", "FAIL", -"FAILING, "IDLE", and "UNKNOWN". +Acceptable values are "DOWN", "DRAIN", "FAIL", "FAILING" and "UNKNOWN". +Node states of "BUSY" and "IDLE" should not be specified in the node +configuration, but set the node state to "UNKNOWN" instead. +Setting the node state to "UNKNOWN" will result in the node state being set to +"BUSY", "IDLE" or other appropriate state based upon recovered system state +information. +The default value is "UNKNOWN". .RS .TP 10 -\fBCLOUD\fP -Indicates the node exists in the cloud. -It's initial state will be treated as powered down. -The node will be available for use after it's state is recovered from SLURM's -state save file or the slurmd daemon starts on the compute node. -.TP \fBDOWN\fP Indicates the node failed and is unavailable to be allocated work. .TP @@ -3111,15 +3144,6 @@ Indicates the node is expected to fail soon, has one or more jobs allocated to it, but will not be allocated to any new jobs. .TP -\fBFUTURE\fP -Indicates the node is defined for future use and need not -exist when the SLURM daemons are started. These nodes can be made available -for use simply by updating the node state using the scontrol command rather -than restarting the slurmctld daemon. After these nodes are made available, -change their \fRState\fR in the slurm.conf file. Until these nodes are made -available, they will not be seen using any SLURM commands or nor will -any attempt be made to contact them. -.TP \fBUNKNOWN\fP Indicates the node's state is undefined (BUSY or IDLE), but will be established when the \fBslurmd\fR daemon on that node