»Command: node eligibility
node eligibility command is used to toggle scheduling eligibility for a
given node. By default nodes are eligible for scheduling meaning they can
receive placements and run new allocations. Nodes that have their scheduling
eligibility disabled are ineligible for new placements.
node drain command automatically disables eligibility. Disabling
a drain restore eligibility by default.
Disable scheduling eligibility is useful when draining a set of nodes: first disable eligibility on each node that will be drained. Then drain each node. If you just drain each node allocations may get rescheduled multiple times as they get placed on nodes about to be drained.
Disabling scheduling eligibility may also be useful when investigating poorly behaved nodes. It allows operators to investigate the current state of a node without the risk of additional work being assigned to it.
nomad node eligibility [options] <node>
-self flag can be used to toggle eligibility of the local node. If this is
not supplied, a node ID or prefix must be provided. If there is an exact match,
the eligibility will be adjusted for that node. Otherwise, a list of matching
nodes and information will be displayed.
It is also required to pass one of
-disable, depending on which
operation is desired.
If ACLs are enabled, this option requires a token with the 'node:write' capability.
-address=<addr>: The address of the Nomad server. Overrides the
NOMAD_ADDRenvironment variable if set. Defaults to
-region=<region>: The region of the Nomad server to forward commands to. Overrides the
NOMAD_REGIONenvironment variable if set. Defaults to the Agent's local region.
-no-color: Disables colored command output. Alternatively,
NOMAD_CLI_NO_COLORmay be set.
-ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides the
NOMAD_CACERTenvironment variable if set.
-ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both
-ca-certis used. Overrides the
NOMAD_CAPATHenvironment variable if set.
-client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify
-client-key. Overrides the
NOMAD_CLIENT_CERTenvironment variable if set.
-client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from
-client-cert. Overrides the
NOMAD_CLIENT_KEYenvironment variable if set.
-tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides the
NOMAD_TLS_SERVER_NAMEenvironment variable if set.
-tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if
-token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the
NOMAD_TOKENenvironment variable if set.
-enable: Enable scheduling eligibility.
-disable: Disable scheduling eligibility.
-self: Set eligibility for the local node.
-yes: Automatic yes to prompts.
Enable scheduling eligibility on node with ID prefix "574545c5":
$ nomad node eligibility -enable 574545c5Node "574545c5-c2d7-e352-d505-5e2cb9fe169f" scheduling eligibility set: eligible for scheduling
Disable scheduling eligibility on the local node:
$ nomad node eligibility -disable -selfNode "574545c5-c2d7-e352-d505-5e2cb9fe169f" scheduling eligibility set: ineligible for scheduling