kubectl-get man page

kubectl get — Display one or many resources


kubectl get [Options]


Display one or many resources.

Possible resource types include (case insensitive): pods (po), services (svc), deployments, replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, componentstatuses (cs), endpoints (ep), and secrets.

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).


If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information.
-f, --filename=[]
Filename, directory, or URL to a file identifying the resource to get from a server.
If true, include definitions of new APIs via calls to the API server. [default true]
-L, --label-columns=[]
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 statements like -L label1 -L label2...
When using the default output, don't print headers.
-o, --output=""
Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [ ⟨http://golang.org/pkg/text/template/#pk…⟩] and jsonpath template [ ⟨http://releases.k8s.io/release-1.3/docs…⟩].
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
-R, --recursive=false
Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
-l, --selector=""
Selector (label query) to filter on
-a, --show-all=false
When printing, show all resources (default hide terminated pods.)
When printing, show all labels as the last column (default hide labels column)
If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [ ⟨http://golang.org/pkg/text/template/#pk…⟩].
-w, --watch=false
After listing/getting the requested object, watch for changes.
Watch for changes to the requested object(s), without listing/getting first.

Options Inherited from Parent Commands

log to standard error as well as files

DEPRECATED: The API version to use when talking to the server

Username to impersonate for the operation.

Path to a cert. file for the certificate authority.

Path to a client certificate file for TLS.

Path to a client key file for TLS.

The name of the kubeconfig cluster to use

The name of the kubeconfig context to use

If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.

Path to the kubeconfig file to use for CLI requests.

when logging hits line file:N, emit a stack trace

If non-empty, write log files in this directory

Maximum number of seconds between log flushes

log to standard error instead of files

Require server version to match client version

If present, the namespace scope for this CLI request.

Password for basic authentication to the API server.

-s, --server=""
The address and port of the Kubernetes API server

logs at or above this threshold go to stderr

Bearer token for authentication to the API server.

The name of the kubeconfig user to use

Username for basic authentication to the API server.

log level for V logs

comma-separated list of pattern=N settings for file-filtered logging


# 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={{.status.phase}}

# 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

See Also



January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

Referenced By


Explore man page connections for kubectl-get(1).