Reference Documentation

Design docs, concept definitions, and references for APIs and CLIs.

Edit This Page

kubectl get

Display one or many resources


Display one or many resources.

Valid resource types include: * clusters (valid only for federation apiservers) * componentstatuses (aka ‘cs’) * configmaps (aka ‘cm’) * daemonsets (aka ‘ds’) * deployments (aka ‘deploy’) * events (aka ‘ev’) * endpoints (aka ‘ep’) * horizontalpodautoscalers (aka ‘hpa’) * ingress (aka ‘ing’) * jobs * limitranges (aka ‘limits’) * nodes (aka ‘no’) * namespaces (aka ‘ns’) * petsets (alpha feature, may be unstable) * pods (aka ‘po’) * persistentvolumes (aka ‘pv’) * persistentvolumeclaims (aka ‘pvc’) * quota * resourcequotas (aka ‘quota’) * replicasets (aka ‘rs’) * replicationcontrollers (aka ‘rc’) * secrets * serviceaccounts (aka ‘sa’) * services (aka ‘svc’)

This command will hide resources that have completed. For instance, pods that are in the Succeeded or Failed phases. You can see the full results for any resource by providing the ‘–show-all’ flag.

By specifying the output as ‘template’ and providing a Go template as the value of the –template flag, you can filter the attributes of the fetched resource(s).

kubectl get [(-o|--output=)json|yaml|wide|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags]


# List all pods in ps output format.
kubectl get pods

# List all pods in ps output format with more information (such as node name).
kubectl get pods -o wide

# List a single replication controller with specified NAME in ps output format.
kubectl get replicationcontroller web

# List a single pod in JSON output format.
kubectl get -o json pod web-pod-13je7

# List a pod identified by type and name specified in "pod.yaml" in JSON output format.
kubectl get -f pod.yaml -o json

# Return only the phase value of the specified pod.
kubectl get -o template pod/web-pod-13je7 --template=

# List all replication controllers and services together in ps output format.
kubectl get rc,services

# List one or more resources by their type and names.
kubectl get rc/web service/frontend pods/web-pod-13je7


      --all-namespaces          If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
      --export                  If true, use 'export' for the resources.  Exported resources are stripped of cluster-specific information.
  -f, --filename value          Filename, directory, or URL to a file identifying the resource to get from a server. (default [])
      --include-extended-apis   If true, include definitions of new APIs via calls to the API server. [default true] (default true)
  -L, --label-columns value     Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... (default [])
      --no-headers              When using the default or custom-column output format, don't print headers.
  -o, --output string           Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [], golang template [] and jsonpath template [].
      --output-version string   Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
      --raw string              Raw URI to request from the server.  Uses the transport specified by the kubeconfig file.
  -R, --recursive               Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
  -l, --selector string         Selector (label query) to filter on
  -a, --show-all                When printing, show all resources (default hide terminated pods.)
      --show-kind               If present, list the resource type for the requested object(s).
      --show-labels             When printing, show all labels as the last column (default hide labels column)
      --sort-by string          If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
      --template string         Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [].
  -w, --watch                   After listing/getting the requested object, watch for changes.
      --watch-only              Watch for changes to the requested object(s), without listing/getting first.

Options inherited from parent commands

      --alsologtostderr value          log to standard error as well as files
      --as string                      Username to impersonate for the operation
      --certificate-authority string   Path to a cert. file for the certificate authority
      --client-certificate string      Path to a client certificate file for TLS
      --client-key string              Path to a client key file for TLS
      --cluster string                 The name of the kubeconfig cluster to use
      --context string                 The name of the kubeconfig context to use
      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
      --log-backtrace-at value         when logging hits line file:N, emit a stack trace (default :0)
      --log-dir value                  If non-empty, write log files in this directory
      --logtostderr value              log to standard error instead of files
      --match-server-version           Require server version to match client version
  -n, --namespace string               If present, the namespace scope for this CLI request
      --password string                Password for basic authentication to the API server
  -s, --server string                  The address and port of the Kubernetes API server
      --stderrthreshold value          logs at or above this threshold go to stderr (default 2)
      --token string                   Bearer token for authentication to the API server
      --user string                    The name of the kubeconfig user to use
      --username string                Username for basic authentication to the API server
  -v, --v value                        log level for V logs
      --vmodule value                  comma-separated list of pattern=N settings for file-filtered logging
Auto generated by spf13/cobra on 24-Oct-2016


Analytics Create an Issue Edit this Page