github.com/dkerwin/nomad@v0.3.3-0.20160525181927-74554135514b/website/source/docs/commands/node-status.html.md.erb (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Commands: node-status"
     4  sidebar_current: "docs-commands-node-status"
     5  description: >
     6    Display information about nodes.
     7  ---
     8  
     9  # Command: node-status
    10  
    11  The `node-status` command is used to display information about client nodes. A
    12  node must first be registered with the servers before it will be visible in this
    13  output.
    14  
    15  ## Usage
    16  
    17  ```
    18  nomad node-status [options] [node]
    19  ```
    20  
    21  If no node ID is passed, then the command will enter "list mode" and dump a
    22  high-level list of all known nodes. This list output contains less information
    23  but is a good way to get a bird's-eye view of things.
    24  
    25  If there is an exact match based on the provided node ID or prefix, then that
    26  particular node will be queried, and detailed information will be displayed.
    27  Otherwise, a list of matching nodes and information will be displayed. If
    28  running the command on a Nomad Client, the -self flag is useful to quickly
    29  access the status of the local node.
    30  
    31  ## General Options
    32  
    33  <%= general_options_usage %>
    34  
    35  ## Node Status Options
    36  
    37  * `-short`: Display short output. Used only when querying a single node.
    38  * `-verbose`: Show full information.
    39  * `-allocs`: Show running allocations per node.
    40  * `-self`: Query the status of the local node.
    41  
    42  ## Examples
    43  
    44  List view:
    45  
    46  ```
    47  $ nomad node-status
    48  ID        DC   Name   Drain  Status
    49  a72dfba2  dc1  node1  false  ready
    50  1f3f03ea  dc1  node2  false  ready
    51  ```
    52  
    53  List view, with running allocations:
    54  
    55  ```
    56  $ nomad node-status -allocs
    57  ID        DC   Name   Class   Drain  Status  Running Allocs
    58  4d2ba53b  dc1  node1  <none>  false  ready   1
    59  34dfba32  dc1  node2  <none>  false  ready   3
    60  ```
    61  
    62  Single-node view in short mode:
    63  
    64  ```
    65  $ nomad node-status -short 1f3f03ea
    66  ID     = c754da1f
    67  Name   = nomad
    68  Class  = <none>
    69  DC     = dc1
    70  Drain  = false
    71  Status = ready
    72  ```
    73  
    74  Full output for a single node:
    75  
    76  ```
    77  $ nomad node-status 1f3f03ea
    78  ID     = c754da1f
    79  Name   = nomad
    80  Class  = <none>
    81  DC     = dc1
    82  Drain  = false
    83  Status = ready
    84  
    85  ==> Resource Utilization
    86  CPU     Memory MB  Disk MB  IOPS
    87  0/2600  0/1997     0/34374  0/0
    88  
    89  ==> Allocations
    90  ID        Eval ID   Job ID   Task Group  Desired Status  Client Status
    91  3d743cff  2fb686da  example  cache       run             complete
    92  ```
    93  
    94  Using `-self` when on a Nomad Client:
    95  
    96  ```
    97  $ nomad node-status -self
    98  ID     = c754da1f
    99  Name   = nomad
   100  Class  = <none>
   101  DC     = dc1
   102  Drain  = false
   103  Status = ready
   104  
   105  ==> Resource Utilization
   106  CPU     Memory MB  Disk MB  IOPS
   107  0/2600  0/1997     0/34374  0/0
   108  
   109  ==> Allocations
   110  ID        Eval ID   Job ID   Task Group  Desired Status  Client Status
   111  3d743cff  2fb686da  example  cache       run             complete
   112  ```
   113  
   114  To view verbose information about the node:
   115  
   116  ```
   117  $ nomad node-status -verbose c754da1f
   118  ID     = c754da1f-6337-b86d-47dc-2ef4c71aca14
   119  Name   = nomad
   120  Class  = <none>
   121  DC     = dc1
   122  Drain  = false
   123  Status = ready
   124  
   125  ==> Resource Utilization
   126  CPU     Memory MB  Disk MB  IOPS
   127  0/2600  0/1997     0/34374  0/0
   128  
   129  ==> Allocations
   130  ID                                    Eval ID                               Job ID   Task Group  Desired Status  Client Status
   131  3d743cff-8d57-18c3-2260-a41d3f6c5204  2fb686da-b2b0-f8c2-5d57-2be5600435bd  example  cache       run             complete
   132  
   133  ==> Attributes
   134  arch                      = amd64
   135  cpu.frequency             = 1300.000000
   136  cpu.modelname             = Intel(R) Core(TM) M-5Y71 CPU @ 1.20GHz
   137  cpu.numcores              = 2
   138  cpu.totalcompute          = 2600.000000
   139  driver.docker             = 1
   140  driver.docker.version     = 1.10.3
   141  driver.exec               = 1
   142  driver.java               = 1
   143  driver.java.runtime       = OpenJDK Runtime Environment (IcedTea 2.6.4) (7u95-2.6.4-0ubuntu0.14.04.2)
   144  driver.java.version       = 1.7.0_95
   145  driver.java.vm            = OpenJDK 64-Bit Server VM (build 24.95-b01, mixed mode)
   146  driver.qemu               = 1
   147  driver.qemu.version       = 2.0.0
   148  driver.raw_exec           = 1
   149  driver.rkt                = 1
   150  driver.rkt.appc.version   = 0.7.4
   151  driver.rkt.version        = 1.2.0
   152  hostname                  = nomad
   153  kernel.name               = linux
   154  kernel.version            = 3.19.0-25-generic
   155  memory.totalbytes         = 2094473216
   156  nomad.revision            = '270da7a60ccbf39eeeadc4064a59ca06bf9ac6fc+CHANGES'
   157  nomad.version             = 0.3.2dev
   158  os.name                   = ubuntu
   159  os.version                = 14.04
   160  unique.cgroup.mountpoint  = /sys/fs/cgroup
   161  unique.network.ip-address = 127.0.0.1
   162  unique.storage.bytesfree  = 36044333056
   163  unique.storage.bytestotal = 41092214784
   164  unique.storage.volume     = /dev/mapper/ubuntu--14--vg-root
   165  ```