github.com/smintz/nomad@v0.8.3/website/source/docs/commands/node/eligibility.html.md.erb (about) 1 --- 2 layout: "docs" 3 page_title: "Commands: node eligibility" 4 sidebar_current: "docs-commands-node-eligibility" 5 description: > 6 The node eligibility command is used to configure a node's scheduling 7 eligibility. 8 --- 9 10 # Command: node eligibility 11 12 The `node eligibility` command is used to toggle scheduling eligibility for a 13 given node. By default node's are eligible for scheduling meaning they can 14 receive placements and run new allocations. Node's that have their scheduling 15 elegibility disabled are ineligibile for new placements. 16 17 The [`node drain`][drain] command automatically disables eligibility. Disabling 18 a drain restore eligibility by default. 19 20 Disable scheduling eligibility is useful when draining a set of nodes: first 21 disable eligibility on each node that will be drained. Then drain each node. 22 If you just drain each node allocations may get rescheduled multiple times as 23 they get placed on node's about to be drained! 24 25 Disabling scheduling eligibility may also be useful when investigating poorly 26 behaved nodes. It allows operators to investigate the current state of a node 27 without the risk of additional work being assigned to it. 28 29 ## Usage 30 31 ``` 32 nomad node eligibility [options] <node> 33 ``` 34 35 A `-self` flag can be used to toggle eligibility of the local node. If this is 36 not supplied, a node ID or prefix must be provided. If there is an exact match, 37 the eligibility will be adjusted for that node. Otherwise, a list of matching 38 nodes and information will be displayed. 39 40 It is also required to pass one of `-enable` or `-disable`, depending on which 41 operation is desired. 42 43 ## General Options 44 45 <%= partial "docs/commands/_general_options" %> 46 47 ## Drain Options 48 49 * `-enable`: Enable scheduling eligbility. 50 * `-disable`: Disable scheduling eligibility. 51 * `-self`: Set eligibility for the local node. 52 * `-yes`: Automatic yes to prompts. 53 54 ## Examples 55 56 Enable scheduling eligibility on node with ID prefix "574545c5": 57 58 ``` 59 $ nomad node eligibility -enable 574545c5 60 Node "574545c5-c2d7-e352-d505-5e2cb9fe169f" scheduling eligibility set: eligible for scheduling 61 ``` 62 63 Disable scheduling eligibility on the local node: 64 65 ``` 66 $ nomad node eligibility -disable -self 67 Node "574545c5-c2d7-e352-d505-5e2cb9fe169f" scheduling eligibility set: ineligible for scheduling 68 ``` 69 70 71 [drain]: /docs/commands/node/drain.html