github.com/containers/podman/v5@v5.1.0-rc1/docs/source/markdown/podman-secret-ls.1.md.in (about)

     1  % podman-secret-ls 1
     2  
     3  ## NAME
     4  podman\-secret\-ls - List all available secrets
     5  
     6  ## SYNOPSIS
     7  **podman secret ls** [*options*]
     8  
     9  ## DESCRIPTION
    10  
    11  Lists all the secrets that exist. The output can be formatted to a Go template using the **--format** option.
    12  
    13  ## OPTIONS
    14  
    15  #### **--filter**, **-f**=*filter=value*
    16  
    17  Filter output based on conditions given.
    18  Multiple filters can be given with multiple uses of the --filter option.
    19  
    20  Valid filters are listed below:
    21  
    22  | **Filter** | **Description**                                                   |
    23  | ---------- | ----------------------------------------------------------------- |
    24  | name       | [Name] Secret name (accepts regex)                                |
    25  | id         | [ID] Full or partial secret ID                                    |
    26  
    27  #### **--format**=*format*
    28  
    29  Format secret output using Go template.
    30  
    31  Valid placeholders for the Go template are listed below:
    32  
    33  | **Placeholder**          | **Description**                                                   |
    34  | ------------------------ | ----------------------------------------------------------------- |
    35  | .CreatedAt ...           | When secret was created (relative timestamp, human-readable)      |
    36  | .ID                      | ID of secret                                                      |
    37  | .SecretData              | Secret Data (Displayed only with --showsecret option)		       |
    38  | .Spec ...                | Details of secret                                                 |
    39  | .Spec.Driver ...         | Driver info                                                       |
    40  | .Spec.Driver.Name        | Driver name (string)                                              |
    41  | .Spec.Driver.Options ... | Driver options (map of driver-specific options)                   |
    42  | .Spec.Labels ...         | Labels for this secret                                            |
    43  | .Spec.Name               | Name of secret                                                    |
    44  | .UpdatedAt ...           | When secret was last updated (relative timestamp, human-readable) |
    45  
    46  @@option noheading
    47  
    48  #### **--quiet**, **-q**
    49  
    50  Print secret IDs only.
    51  
    52  ## EXAMPLES
    53  
    54  List all secrets.
    55  ```
    56  $ podman secret ls
    57  ```
    58  
    59  List the name field of all secrets.
    60  ```
    61  $ podman secret ls --format "{{.Name}}"
    62  ```
    63  
    64  List all secrets whose name includes the specified string.
    65  ```
    66  $ podman secret ls --filter name=confidential
    67  ```
    68  
    69  ## SEE ALSO
    70  **[podman(1)](podman.1.md)**, **[podman-secret(1)](podman-secret.1.md)**
    71  
    72  ## HISTORY
    73  January 2021, Originally compiled by Ashley Cui <acui@redhat.com>