github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/website/content/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  When ACLs are enabled, this command requires a token with the
    29  `csi-read-volume` and `csi-list-volumes` capability for the volume's
    30  namespace.
    31  
    32  ## General Options
    33  
    34  @include 'general_options.mdx'
    35  
    36  ## Status Options
    37  
    38  - `-type`: Display only volumes of a particular type. Currently only
    39    the `csi` type is supported, so this option can be omitted when
    40    querying the status of CSI volumes.
    41  
    42  - `-plugin_id`: Display only volumes managed by a particular [CSI
    43    plugin][csi_plugin].
    44  
    45  - `-short`: Display short output. Used only when a single volume is
    46    being queried. Drops verbose volume allocation data from the
    47    output.
    48  
    49  - `-verbose`: Show full information. Allocation create and modify
    50    times are shown in `yyyy/mm/dd hh:mm:ss` format.
    51  
    52  ## Examples
    53  
    54  List of all volumes:
    55  
    56  ```shell-session
    57  $ nomad volume [-type csi] status
    58  ID            Name      Plugin ID  Schedulable  Access Mode
    59  ebs_prod_db1  database  ebs-prod   true         single-node-writer
    60  ```
    61  
    62  Short view of a specific volume:
    63  
    64  ```shell-session
    65  $ nomad volume status [-verbose] [-plugin=ebs-prod] ebs_prod_db1
    66  ID                   = ebs_prod_db1
    67  Name                 = database
    68  Type                 = csi
    69  External ID          = vol-23452345
    70  Plugin ID            = ebs-prod
    71  Provider             = aws.ebs
    72  Version              = 1.0.1
    73  Schedulable          = true
    74  Controllers Healthy  = 1
    75  Controllers Expected = 1
    76  Nodes Healthy        = 1
    77  Nodes Expected       = 1
    78  Access Mode          = single-node-writer
    79  Attachment Mode      = file-system
    80  Mount Options        = fs_type: ext4 flags: ro
    81  Namespace            = default
    82  ```
    83  
    84  Full status information of a volume:
    85  
    86  ```shell-session
    87  $ nomad volume status [-verbose] [-plugin=ebs-prod] ebs_prod_db1
    88  ID                   = ebs_prod_db1
    89  Name                 = database
    90  Type                 = csi
    91  External ID          = vol-23452345
    92  Plugin ID            = ebs-prod
    93  Provider             = aws.ebs
    94  Version              = 1.0.1
    95  Schedulable          = true
    96  Controllers Healthy  = 1
    97  Controllers Expected = 1
    98  Nodes Healthy        = 1
    99  Nodes Expected       = 1
   100  Access Mode          = single-node-writer
   101  Attachment Mode      = file-system
   102  Mount Options        = fs_type: ext4 flags: ro
   103  Namespace            = default
   104  
   105  Allocations
   106  ID        Node ID   Access Mode   Task Group  Version  Desired  [...]
   107  b00fa322  28be17d5  write         csi         0        run
   108  ```
   109  
   110  [csi]: https://github.com/container-storage-interface/spec
   111  [csi_plugin]: /docs/job-specification/csi_plugin