github.com/iqoqo/nomad@v0.11.3-0.20200911112621-d7021c74d101/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-sessionnomad volume [-type csi] status
    53  ID            Name      Plugin ID  Schedulable  Access Mode
    54  ebs_prod_db1  database  ebs-prod   true         single-node-writer
    55  ```
    56  
    57  Short view of a specific volume:
    58  
    59  ```shell-sessionnomad volume status [-verbose] [-plugin=ebs-prod] ebs_prod_db1
    60  ID                   = ebs_prod_db1
    61  Name                 = database
    62  Type                 = csi
    63  External ID          = vol-23452345
    64  Plugin ID            = ebs-prod
    65  Provider             = aws.ebs
    66  Version              = 1.0.1
    67  Schedulable          = true
    68  Controllers Healthy  = 1
    69  Controllers Expected = 1
    70  Nodes Healthy        = 1
    71  Nodes Expected       = 1
    72  Access Mode          = single-node-writer
    73  Attachment Mode      = file-system
    74  Mount Options        = fs_type: ext4 flags: ro
    75  Namespace            = default
    76  ```
    77  
    78  Full status information of a volume:
    79  
    80  ```shell-sessionnomad volume status [-verbose] [-plugin=ebs-prod] ebs_prod_db1
    81  ID                   = ebs_prod_db1
    82  Name                 = database
    83  Type                 = csi
    84  External ID          = vol-23452345
    85  Plugin ID            = ebs-prod
    86  Provider             = aws.ebs
    87  Version              = 1.0.1
    88  Schedulable          = true
    89  Controllers Healthy  = 1
    90  Controllers Expected = 1
    91  Nodes Healthy        = 1
    92  Nodes Expected       = 1
    93  Access Mode          = single-node-writer
    94  Attachment Mode      = file-system
    95  Mount Options        = fs_type: ext4 flags: ro
    96  Namespace            = default
    97  
    98  Allocations
    99  ID        Node ID   Access Mode   Task Group  Version  Desired  [...]
   100  b00fa322  28be17d5  write         csi         0        run
   101  ```
   102  
   103  [csi]: https://github.com/container-storage-interface/spec
   104  [csi_plugin]: /docs/job-specification/csi_plugin