2015-07-12 04:04:52 +00:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
2015-07-16 17:02:26 +00:00
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< h2 > PLEASE NOTE: This document applies to the HEAD of the source tree< / h2 >
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
2015-12-14 18:37:38 +00:00
<!-- TAG RELEASE_LINK, added by the munger automatically -->
2015-07-16 17:02:26 +00:00
< strong >
2015-11-03 18:17:57 +00:00
The latest release of this document can be found
[here ](http://releases.k8s.io/release-1.1/docs/user-guide/kubectl/kubectl_get.md ).
2015-07-16 17:02:26 +00:00
Documentation for other releases can be found at
[releases.k8s.io ](http://releases.k8s.io ).
< / strong >
--
2015-07-13 22:15:35 +00:00
2015-07-12 04:04:52 +00:00
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
2015-07-17 22:35:41 +00:00
2015-01-31 19:08:59 +00:00
## kubectl get
Display one or many resources
### Synopsis
2015-03-11 17:22:08 +00:00
2015-01-31 19:08:59 +00:00
Display one or many resources.
2015-07-06 11:31:27 +00:00
Possible resource types include (case insensitive): pods (po), services (svc),
2015-07-06 11:36:06 +00:00
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
2015-11-19 14:16:26 +00:00
resourcequotas (quota), namespaces (ns), endpoints (ep),
horizontalpodautoscalers (hpa), serviceaccounts or secrets.
2015-01-31 19:08:59 +00:00
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).
2015-03-11 17:22:08 +00:00
```
2015-08-21 13:09:41 +00:00
kubectl get [(-o|--output=)json|yaml|wide|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags]
2015-03-11 17:22:08 +00:00
```
2015-01-31 19:08:59 +00:00
2015-02-20 21:29:23 +00:00
### Examples
2015-01-31 19:08:59 +00:00
2015-02-20 21:29:23 +00:00
```
2015-08-12 16:50:09 +00:00
# List all pods in ps output format.
2015-02-20 21:29:23 +00:00
$ kubectl get pods
2015-01-31 19:08:59 +00:00
2015-08-12 16:50:09 +00:00
# List all pods in ps output format with more information (such as node name).
2015-06-29 18:36:06 +00:00
$ kubectl get pods -o wide
2015-08-12 16:50:09 +00:00
# List a single replication controller with specified NAME in ps output format.
2015-05-21 00:17:01 +00:00
$ kubectl get replicationcontroller web
2015-01-31 19:08:59 +00:00
2015-08-12 16:50:09 +00:00
# List a single pod in JSON output format.
2015-03-25 05:01:07 +00:00
$ kubectl get -o json pod web-pod-13je7
2015-01-31 19:08:59 +00:00
2015-08-10 11:02:14 +00:00
# List a pod identified by type and name specified in "pod.yaml" in JSON output format.
$ kubectl get -f pod.yaml -o json
2015-08-12 16:50:09 +00:00
# Return only the phase value of the specified pod.
2015-08-17 18:53:43 +00:00
$ kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}} --api-version=v1
2015-01-31 19:08:59 +00:00
2015-08-12 16:50:09 +00:00
# List all replication controllers and services together in ps output format.
2015-02-20 21:29:23 +00:00
$ kubectl get rc,services
2015-03-25 05:01:07 +00:00
2015-08-12 16:50:09 +00:00
# List one or more resources by their type and names.
2015-03-25 05:01:07 +00:00
$ kubectl get rc/web service/frontend pods/web-pod-13je7
2015-02-20 21:29:23 +00:00
```
2015-01-31 19:08:59 +00:00
### Options
```
2015-08-05 14:23:28 +00:00
--all-namespaces[=false]: If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
2015-12-02 20:20:10 +00:00
--export[=false]: If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information.
2015-08-10 11:02:14 +00:00
-f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server.
2015-06-16 16:30:11 +00:00
-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...
2015-08-05 14:23:28 +00:00
--no-headers[=false]: When using the default output, don't print headers.
2015-08-21 13:09:41 +00:00
-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/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md].
2015-01-31 19:08:59 +00:00
--output-version="": Output the formatted object with the given version (default api-version).
-l, --selector="": Selector (label query) to filter on
2015-07-31 23:42:34 +00:00
-a, --show-all[=false]: When printing, show all resources (default hide terminated pods.)
2015-08-08 06:04:25 +00:00
--sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. 'ObjectMeta.Name'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
2015-08-21 13:09:41 +00:00
--template="": 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/#pkg-overview].
2015-08-05 14:23:28 +00:00
-w, --watch[=false]: After listing/getting the requested object, watch for changes.
--watch-only[=false]: Watch for changes to the requested object(s), without listing/getting first.
2015-01-31 19:08:59 +00:00
```
2015-04-29 15:26:55 +00:00
### Options inherited from parent commands
2015-01-31 19:08:59 +00:00
```
2015-08-17 18:06:16 +00:00
--alsologtostderr[=false]: log to standard error as well as files
2015-01-31 19:08:59 +00:00
--api-version="": The API version to use when talking to the server
--certificate-authority="": Path to a cert. file for the certificate authority.
2015-11-24 01:33:35 +00:00
--client-certificate="": Path to a client certificate file for TLS.
2015-01-31 19:08:59 +00:00
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
2015-08-05 14:23:28 +00:00
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
2015-01-31 19:08:59 +00:00
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
2015-05-16 16:44:42 +00:00
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
2015-08-17 18:06:16 +00:00
--log-dir="": If non-empty, write log files in this directory
2015-05-16 16:44:42 +00:00
--log-flush-frequency=5s: Maximum number of seconds between log flushes
2015-08-17 18:06:16 +00:00
--logtostderr[=true]: log to standard error instead of files
2015-08-05 14:23:28 +00:00
--match-server-version[=false]: Require server version to match client version
2015-01-31 19:08:59 +00:00
--namespace="": If present, the namespace scope for this CLI request.
2015-02-19 19:51:38 +00:00
--password="": Password for basic authentication to the API server.
2015-01-31 19:08:59 +00:00
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
2015-02-19 19:51:38 +00:00
--username="": Username for basic authentication to the API server.
2015-01-31 19:08:59 +00:00
--v=0: log level for V logs
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
2015-07-17 22:35:41 +00:00
2015-04-12 19:04:39 +00:00
* [kubectl ](kubectl.md ) - kubectl controls the Kubernetes cluster manager
2015-01-31 19:08:59 +00:00
2015-12-02 20:20:10 +00:00
###### Auto generated by spf13/cobra on 22-Dec-2015
2015-07-14 00:13:09 +00:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
2015-07-13 17:19:25 +00:00
[![Analytics ](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_get.md?pixel )]()
2015-07-14 00:13:09 +00:00
<!-- END MUNGE: GENERATED_ANALYTICS -->