github.com/adityamillind98/nomad@v0.11.8/website/pages/docs/commands/plugin/status.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: plugin status'
     4  sidebar_title: status
     5  description: |
     6    Display information and status of plugins.
     7  ---
     8  
     9  # Command: plugin status
    10  
    11  The `plugin status` command displays status information for [Container
    12  Storage Interface (CSI)][csi] plugins.
    13  
    14  ## Usage
    15  
    16  ```plaintext
    17  nomad plugin status [options] [plugin]
    18  ```
    19  
    20  This command accepts an optional plugin ID or prefix as the sole argument. If there
    21  is an exact match based on the provided plugin ID or prefix, then information about
    22  the specific plugin is queried and displayed. Otherwise, a list of matching plugins
    23  and information will be displayed.
    24  
    25  If the ID is omitted, the command lists out all of the existing plugins and a few
    26  of the most useful status fields for each.
    27  
    28  ## General Options
    29  
    30  @include 'general_options.mdx'
    31  
    32  ## Status Options
    33  
    34  - `-type`: Display only plugins of a particular type. Currently only
    35    the `csi` type is supported, so this option can be omitted when
    36    querying the status of CSI plugins.
    37  
    38  - `-short`: Display short output. Used only when a single plugin is being queried.
    39    Drops verbose plugin allocation data from the output.
    40  
    41  - `-verbose`: Show full information. Allocation create and modify times are
    42    shown in `yyyy/mm/dd hh:mm:ss` format.
    43  
    44  ## Examples
    45  
    46  List of all plugins:
    47  
    48  ```shell-session
    49  $ nomad plugin [-type csi] status
    50  ID         Provider  Controllers Healthy / Expected  Nodes Healthy / Expected
    51  ebs-prod   aws.ebs   1 / 1                           1 / 1
    52  ```
    53  
    54  Short view of a specific plugin:
    55  
    56  ```shell-session
    57  $ nomad plugin [-type csi] status ebs-prod
    58  ID                   = ebs-prod
    59  Provider             = aws.ebs
    60  Version              = 1.0.1
    61  Controllers Healthy  = 1
    62  Controllers Expected = 1
    63  Nodes Healthy        = 1
    64  Nodes Expected       = 1
    65  ```
    66  
    67  Full status information of a plugin:
    68  
    69  ```shell-session
    70  $ nomad plugin [-type csi] status ebs-prod
    71  ID                   = ebs-prod
    72  Provider             = aws.ebs
    73  Version              = 1.0.1
    74  Controllers Healthy  = 1
    75  Controllers Expected = 1
    76  Nodes Healthy        = 1
    77  Nodes Expected       = 1
    78  
    79  Allocations
    80  ID        Node ID   Task Group  Version  Desired  Status    Created    Modified
    81  0de05689  95303afc  csi         0        run      running  1m57s ago  1m19s ago
    82  b206088c  8bf94335  csi         0        run      running  1m56s ago  1m19s ago
    83  ```
    84  
    85  [csi]: https://github.com/container-storage-interface/spec