github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/user_docs/cli/kbcli_cluster_list.md (about)

     1  ---
     2  title: kbcli cluster list
     3  ---
     4  
     5  List clusters.
     6  
     7  ```
     8  kbcli cluster list [NAME] [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # list all clusters
    15    kbcli cluster list
    16    
    17    # list a single cluster with specified name
    18    kbcli cluster list mycluster
    19    
    20    # list a single cluster in YAML output format
    21    kbcli cluster list mycluster -o yaml
    22    
    23    # list a single cluster in JSON output format
    24    kbcli cluster list mycluster -o json
    25    
    26    # list a single cluster in wide output format
    27    kbcli cluster list mycluster -o wide
    28  ```
    29  
    30  ### Options
    31  
    32  ```
    33    -A, --all-namespaces    If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
    34    -h, --help              help for list
    35    -o, --output format     prints the output in the specified format. Allowed values: table, json, yaml, wide (default table)
    36    -l, --selector string   Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.
    37        --show-labels       When printing, show all labels as the last column (default hide labels column)
    38  ```
    39  
    40  ### Options inherited from parent commands
    41  
    42  ```
    43        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    44        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    45        --as-uid string                  UID to impersonate for the operation.
    46        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    47        --certificate-authority string   Path to a cert file for the certificate authority
    48        --client-certificate string      Path to a client certificate file for TLS
    49        --client-key string              Path to a client key file for TLS
    50        --cluster string                 The name of the kubeconfig cluster to use
    51        --context string                 The name of the kubeconfig context to use
    52        --disable-compression            If true, opt-out of response compression for all requests to the server
    53        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    54        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    55        --match-server-version           Require server version to match client version
    56    -n, --namespace string               If present, the namespace scope for this CLI request
    57        --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
    58    -s, --server string                  The address and port of the Kubernetes API server
    59        --tls-server-name string         Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
    60        --token string                   Bearer token for authentication to the API server
    61        --user string                    The name of the kubeconfig user to use
    62  ```
    63  
    64  ### SEE ALSO
    65  
    66  * [kbcli cluster](kbcli_cluster.md)	 - Cluster command.
    67  
    68  #### Go Back to [CLI Overview](cli.md) Homepage.
    69