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

     1  ---
     2  layout: docs
     3  page_title: 'Commands: volume status'
     4  sidebar_title: status
     5  description: |
     6    Display information and status of volumes.
     7  ---
     8  
     9  # Command: volume status
    10  
    11  The `volume status` command displays status information for [Container
    12  Storage Interface (CSI)][csi] volumes.
    13  
    14  ## Usage
    15  
    16  ```plaintext
    17  nomad volume status [options] [volume]
    18  ```
    19  
    20  This command accepts an optional volume ID or prefix as the sole argument. If there
    21  is an exact match based on the provided volume ID or prefix, then information about
    22  the specific volume is queried and displayed. Otherwise, a list of matching volumes
    23  and information will be displayed.
    24  
    25  If the ID is omitted, the command lists out all of the existing volumes 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 volumes 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 volumes.
    37  
    38  - `-plugin_id`: Display only volumes managed by a particular [CSI
    39    plugin][csi_plugin].
    40  
    41  - `-short`: Display short output. Used only when a single volume is
    42    being queried. Drops verbose volume allocation data from the
    43    output.
    44  
    45  - `-verbose`: Show full information. Allocation create and modify
    46    times are shown in `yyyy/mm/dd hh:mm:ss` format.
    47  
    48  ## Examples
    49  
    50  List of all volumes:
    51  
    52  ```shell-session
    53  $ nomad volume [-type csi] status
    54  ID            Name      Plugin ID  Schedulable  Access Mode
    55  ebs_prod_db1  database  ebs-prod   true         single-node-writer
    56  ```
    57  
    58  Short view of a specific volume:
    59  
    60  ```shell-session
    61  $ nomad volume status [-verbose] [-plugin=ebs-prod] ebs_prod_db1
    62  ID                   = ebs_prod_db1
    63  Name                 = database
    64  Type                 = csi
    65  External ID          = vol-23452345
    66  Plugin ID            = ebs-prod
    67  Provider             = aws.ebs
    68  Version              = 1.0.1
    69  Schedulable          = true
    70  Controllers Healthy  = 1
    71  Controllers Expected = 1
    72  Nodes Healthy        = 1
    73  Nodes Expected       = 1
    74  Access Mode          = single-node-writer
    75  Attachment Mode      = file-system
    76  Mount Options        = fs_type: ext4 flags: ro
    77  Namespace            = default
    78  ```
    79  
    80  Full status information of a volume:
    81  
    82  ```shell-session
    83  $ nomad volume status [-verbose] [-plugin=ebs-prod] ebs_prod_db1
    84  ID                   = ebs_prod_db1
    85  Name                 = database
    86  Type                 = csi
    87  External ID          = vol-23452345
    88  Plugin ID            = ebs-prod
    89  Provider             = aws.ebs
    90  Version              = 1.0.1
    91  Schedulable          = true
    92  Controllers Healthy  = 1
    93  Controllers Expected = 1
    94  Nodes Healthy        = 1
    95  Nodes Expected       = 1
    96  Access Mode          = single-node-writer
    97  Attachment Mode      = file-system
    98  Mount Options        = fs_type: ext4 flags: ro
    99  Namespace            = default
   100  
   101  Allocations
   102  ID        Node ID   Access Mode   Task Group  Version  Desired  [...]
   103  b00fa322  28be17d5  write         csi         0        run
   104  ```
   105  
   106  [csi]: https://github.com/container-storage-interface/spec
   107  [csi_plugin]: /docs/job-specification/csi_plugin