github.com/outbrain/consul@v1.4.5/website/source/docs/commands/snapshot/inspect.html.markdown.erb (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Commands: Snapshot Inspect"
     4  sidebar_current: "docs-commands-snapshot-inspect"
     5  ---
     6  
     7  # Consul Snapshot Inspect
     8  
     9  Command: `consul snapshot inspect`
    10  
    11  The `snapshot inspect` command is used to inspect an atomic, point-in-time
    12  snapshot of the state of the Consul servers which includes key/value entries,
    13  service catalog, prepared queries, sessions, and ACLs. The snapshot is read
    14  from the given file.
    15  
    16  The following fields are displayed when inspecting a snapshot:
    17  
    18  * `ID` - A unique ID for the snapshot, only used for differentiation purposes.
    19  
    20  * `Size` - The size of the snapshot, in bytes.
    21  
    22  * `Index` - The Raft index of the latest log entry in the snapshot.
    23  
    24  * `Term` - The Raft term of the latest log entry in the snapshot.
    25  
    26  * `Version` - The snapshot format version. This only refers to the structure of
    27   the snapshot, not the data contained within.
    28  
    29  ## Usage
    30  
    31  Usage: `consul snapshot inspect [options] FILE`
    32  
    33  ## Examples
    34  
    35  To inspect a snapshot from the file "backup.snap":
    36  
    37  ```text
    38  $ consul snapshot inspect backup.snap
    39  ID           2-5-1477944140022
    40  Size         667
    41  Index        5
    42  Term         2
    43  Version      1
    44  ```
    45  
    46  Please see the [HTTP API](/api/snapshot.html) documentation for
    47  more details about snapshot internals.