github.com/mattyr/nomad@v0.3.3-0.20160919021406-3485a065154a/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  including resource usage statistics. Otherwise, a list of matching nodes and
    28  information will be displayed. If running the command on a Nomad Client, the
    29  -self flag is useful to quickly access the status of the local node.
    30  
    31  ## General Options
    32  
    33  <%= general_options_usage %>
    34  
    35  ## Node Status Options
    36  
    37  * `-self`: Query the status of the local node.
    38  
    39  * `-stats`: Display detailed resource usage statistics.
    40  
    41  * `-allocs`: When a specific node is not being queried, shows the number of
    42    running allocations per node.
    43  
    44  * `-short`: Display short output. Used only when querying a single node.
    45  
    46  * `-verbose`: Show full information.
    47  
    48  * `-json` : Output the node in its JSON format.
    49  
    50  * `-t` : Format and display node using a Go template.
    51  
    52  
    53  ## Examples
    54  
    55  List view:
    56  
    57  ```
    58  $ nomad node-status
    59  ID        DC   Name   Drain  Status
    60  a72dfba2  dc1  node1  false  ready
    61  1f3f03ea  dc1  node2  false  ready
    62  ```
    63  
    64  List view, with running allocations:
    65  
    66  ```
    67  $ nomad node-status -allocs
    68  ID        DC   Name   Class   Drain  Status  Running Allocs
    69  4d2ba53b  dc1  node1  <none>  false  ready   1
    70  34dfba32  dc1  node2  <none>  false  ready   3
    71  ```
    72  
    73  Single-node view in short mode:
    74  
    75  ```
    76  $ nomad node-status -short 1f3f03ea
    77  ID     = c754da1f
    78  Name   = nomad
    79  Class  = <none>
    80  DC     = dc1
    81  Drain  = false
    82  Status = ready
    83  Uptime = 17h2m25s
    84  
    85  Allocations
    86  ID        Eval ID   Job ID   Task Group  Desired Status  Client Status
    87  0b8b9e37  8bf94335  example  cache       run             running
    88  ```
    89  
    90  Full output for a single node:
    91  
    92  ```
    93  $ nomad node-status 1f3f03ea
    94  ID     = c754da1f
    95  Name    = nomad-server01
    96  Class   = <none>
    97  DC      = dc1
    98  Drain   = false
    99  Status  = ready
   100  Uptime  = 17h42m50s
   101  
   102  Allocated Resources
   103  CPU           Memory           Disk            IOPS
   104  500/2600 MHz  256 MiB/2.0 GiB  300 MiB/32 GiB  0/0
   105  
   106  Allocation Resource Utilization
   107  CPU           Memory
   108  430/2600 MHz  199 MiB/2.0 GiB
   109  
   110  Host Resource Utilization
   111  CPU           Memory           Disk
   112  513/3000 MHz  551 MiB/2.4 GiB  4.2 GiB/52 GiB
   113  
   114  Allocations
   115  ID        Eval ID   Job ID   Task Group  Desired Status  Client Status
   116  7bff7214  b3a6b9d2  example  cache       run             running
   117  ```
   118  
   119  Using `-self` when on a Nomad Client:
   120  
   121  ```
   122  $ nomad node-status -self
   123  ID     = c754da1f
   124  Name   = nomad-client01
   125  Class  = <none>
   126  DC     = dc1
   127  Drain  = false
   128  Status = ready
   129  Uptime = 17h7m41s
   130  
   131  Allocated Resources
   132  CPU            Memory           Disk            IOPS
   133  2500/2600 MHz  1.3 GiB/2.0 GiB  1.5 GiB/32 GiB  0/0
   134  
   135  Allocation Resource Utilization
   136  CPU            Memory
   137  2200/2600 MHz  1.7 GiB/2.0 GiB
   138  
   139  Host Resource Utilization
   140  CPU            Memory           Disk
   141  2430/3000 MHz  1.8 GiB/2.4 GiB  6.5 GiB/40 GiB
   142  
   143  Allocations
   144  ID        Eval ID   Job ID   Task Group  Desired Status  Client Status
   145  0b8b9e37  8bf94335  example  cache       run             running
   146  b206088c  8bf94335  example  cache       run             running
   147  b82f58b6  8bf94335  example  cache       run             running
   148  ed3665f5  8bf94335  example  cache       run             running
   149  24cfd201  8bf94335  example  cache       run             running
   150  ```
   151  
   152  Using `-stats` to see detailed to resource usage information on the node:
   153  
   154  ```
   155  $ nomad node-status -stats c754da1f
   156  ID     = c754da1f
   157  Name   = nomad-client01
   158  Class  = <none>
   159  DC     = dc1
   160  Drain  = false
   161  Status = ready
   162  Uptime = 17h7m41s
   163  
   164  Allocated Resources
   165  CPU            Memory           Disk            IOPS
   166  2500/2600 MHz  1.3 GiB/2.0 GiB  1.5 GiB/32 GiB  0/0
   167  
   168  Allocation Resource Utilization
   169  CPU            Memory
   170  2200/2600 MHz  1.7 GiB/2.0 GiB
   171  
   172  Host Resource Utilization
   173  CPU            Memory           Disk
   174  2430/3000 MHz  1.8 GiB/2.4 GiB  3.9 GiB/40 GiB
   175  
   176  CPU Stats
   177  CPU    = cpu0
   178  User   = 96.94%
   179  System = 1.02%
   180  Idle   = 2.04%
   181  
   182  CPU    = cpu1
   183  User   = 97.92%
   184  System = 2.08%
   185  Idle   = 0.00%
   186  
   187  Memory Stats
   188  Total     = 2.4 GiB
   189  Available = 612 MiB
   190  Used      = 1.8 GiB
   191  Free      = 312 MiB
   192  
   193  Disk Stats
   194  Device         = /dev/mapper/ubuntu--14--vg-root
   195  MountPoint     = /
   196  Size           = 38 GiB
   197  Used           = 3.9 GiB
   198  Available      = 32 GiB
   199  Used Percent   = 10.31%
   200  Inodes Percent = 3.85%
   201  
   202  Device         = /dev/sda1
   203  MountPoint     = /boot
   204  Size           = 235 MiB
   205  Used           = 45 MiB
   206  Available      = 178 MiB
   207  Used Percent   = 19.17%
   208  Inodes Percent = 0.48%
   209  
   210  Allocations
   211  ID        Eval ID   Job ID   Task Group  Desired Status  Client Status
   212  0b8b9e37  8bf94335  example  cache       run             running
   213  b206088c  8bf94335  example  cache       run             running
   214  b82f58b6  8bf94335  example  cache       run             running
   215  ed3665f5  8bf94335  example  cache       run             running
   216  24cfd201  8bf94335  example  cache       run             running
   217  ```
   218  
   219  To view verbose information about the node:
   220  
   221  ```
   222  $ nomad node-status -verbose c754da1f
   223  ID     = c754da1f-6337-b86d-47dc-2ef4c71aca14
   224  Name   = nomad
   225  Class  = <none>
   226  DC     = dc1
   227  Drain  = false
   228  Status = ready
   229  Uptime = 17h7m41s
   230  
   231  Allocated Resources
   232  CPU            Memory           Disk            IOPS
   233  2500/2600 MHz  1.3 GiB/2.0 GiB  1.5 GiB/32 GiB  0/0
   234  
   235  Allocation Resource Utilization
   236  CPU            Memory
   237  2200/2600 MHz  1.7 GiB/2.0 GiB
   238  
   239  Host Resource Utilization
   240  CPU           Memory           Disk
   241  230/3000 MHz  121 MiB/2.4 GiB  6.5 GiB/40 GiB
   242  
   243  Allocations
   244  ID                                    Eval ID                               Job ID   Task Group  Desired Status  Client Status
   245  3d743cff-8d57-18c3-2260-a41d3f6c5204  2fb686da-b2b0-f8c2-5d57-2be5600435bd  example  cache       run             complete
   246  
   247  Attributes
   248  arch                      = amd64
   249  cpu.frequency             = 1300.000000
   250  cpu.modelname             = Intel(R) Core(TM) M-5Y71 CPU @ 1.20GHz
   251  cpu.numcores              = 2
   252  cpu.totalcompute          = 2600.000000
   253  driver.docker             = 1
   254  driver.docker.version     = 1.10.3
   255  driver.exec               = 1
   256  driver.java               = 1
   257  driver.java.runtime       = OpenJDK Runtime Environment (IcedTea 2.6.4) (7u95-2.6.4-0ubuntu0.14.04.2)
   258  driver.java.version       = 1.7.0_95
   259  driver.java.vm            = OpenJDK 64-Bit Server VM (build 24.95-b01, mixed mode)
   260  driver.qemu               = 1
   261  driver.qemu.version       = 2.0.0
   262  driver.raw_exec           = 1
   263  driver.rkt                = 1
   264  driver.rkt.appc.version   = 0.7.4
   265  driver.rkt.version        = 1.2.0
   266  hostname                  = nomad
   267  kernel.name               = linux
   268  kernel.version            = 3.19.0-25-generic
   269  memory.totalbytes         = 2094473216
   270  nomad.revision            = '270da7a60ccbf39eeeadc4064a59ca06bf9ac6fc+CHANGES'
   271  nomad.version             = 0.3.2dev
   272  os.name                   = ubuntu
   273  os.version                = 14.04
   274  unique.cgroup.mountpoint  = /sys/fs/cgroup
   275  unique.network.ip-address = 127.0.0.1
   276  unique.storage.bytesfree  = 36044333056
   277  unique.storage.bytestotal = 41092214784
   278  unique.storage.volume     = /dev/mapper/ubuntu--14--vg-root
   279  ```