github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/plugin/status.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: plugin status'
     4  description: |
     5    Display information and status of plugins.
     6  ---
     7  
     8  # Command: plugin status
     9  
    10  The `plugin status` command displays status information for [Container
    11  Storage Interface (CSI)][csi] plugins.
    12  
    13  ## Usage
    14  
    15  ```plaintext
    16  nomad plugin status [options] [plugin]
    17  ```
    18  
    19  This command accepts an optional plugin ID or prefix as the sole argument. If there
    20  is an exact match based on the provided plugin ID or prefix, then information about
    21  the specific plugin is queried and displayed. Otherwise, a list of matching plugins
    22  and information will be displayed.
    23  
    24  If the ID is omitted, the command lists out all of the existing plugins and a few
    25  of the most useful status fields for each.
    26  
    27  If ACLs are enabled, this command requires a token with the `plugin:read`
    28  capability.
    29  
    30  ## General Options
    31  
    32  @include 'general_options_no_namespace.mdx'
    33  
    34  ## Status Options
    35  
    36  - `-type`: Display only plugins of a particular type. Currently only
    37    the `csi` type is supported, so this option can be omitted when
    38    querying the status of CSI plugins.
    39  
    40  - `-short`: Display short output. Used only when a single plugin is being queried.
    41    Drops verbose plugin allocation data from the output.
    42  
    43  - `-verbose`: Show full information. Allocation create and modify times are
    44    shown in `yyyy/mm/dd hh:mm:ss` format.
    45  
    46  ## Examples
    47  
    48  List of all plugins:
    49  
    50  ```shell-session
    51  $ nomad plugin [-type csi] status
    52  ID         Provider  Controllers Healthy / Expected  Nodes Healthy / Expected
    53  ebs-prod   aws.ebs   1 / 1                           1 / 1
    54  ```
    55  
    56  Short view of a specific plugin:
    57  
    58  ```shell-session
    59  $ nomad plugin [-type csi] status ebs-prod
    60  ID                   = ebs-prod
    61  Provider             = aws.ebs
    62  Version              = 1.0.1
    63  Controllers Healthy  = 1
    64  Controllers Expected = 1
    65  Nodes Healthy        = 1
    66  Nodes Expected       = 1
    67  ```
    68  
    69  Full status information of a plugin with `-verbose` flag. Note that this example
    70  shows a plugin that has all supported capabilities. Most plugins will support a
    71  subset of these capabilities. Topology fields are also controlled by the plugin.
    72  
    73  ```shell-session
    74  $ nomad plugin [-type csi] -verbose status ebs-prod
    75  ID                   = ebs-prod
    76  Provider             = aws.ebs
    77  Version              = 1.0.1
    78  Controllers Healthy  = 1
    79  Controllers Expected = 1
    80  Nodes Healthy        = 1
    81  Nodes Expected       = 1
    82  
    83  Controller Capabilities
    84    ATTACH_READONLY
    85    CLONE_VOLUME
    86    CONTROLLER_ATTACH_DETACH
    87    CREATE_DELETE_SNAPSHOT
    88    CREATE_DELETE_VOLUME
    89    EXPAND_VOLUME
    90    GET_CAPACITY
    91    GET_VOLUME
    92    LIST_SNAPSHOTS
    93    LIST_VOLUMES
    94    LIST_VOLUMES_PUBLISHED_NODES
    95    VOLUME_CONDITION
    96  
    97  Node Capabilities
    98    EXPAND_VOLUME
    99    GET_VOLUME_STATS
   100    STAGE_UNSTAGE_VOLUME
   101    VOLUME_ACCESSIBILITY_CONSTRAINTS
   102    VOLUME_CONDITION
   103  
   104  Accessible Topologies
   105  Node ID   Accessible Topology
   106  95303afc  topology.ebs.csi.aws.com/zone=us-east-1a
   107  8bf94335  topology.ebs.csi.aws.com/zone=us-east-1b
   108  
   109  Allocations
   110  ID        Node ID   Task Group  Version  Desired  Status    Created    Modified
   111  0de05689  95303afc  csi         0        run      running  1m57s ago  1m19s ago
   112  b206088c  8bf94335  csi         0        run      running  1m56s ago  1m19s ago
   113  ```
   114  
   115  [csi]: https://github.com/container-storage-interface/spec