Synopsis
Display one or many resources. Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the —selector flag. If the desired resource type is namespaced you will only see results in the current namespace if you don’t specify any namespace. 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 resources. Use “datumctl api-resources” for a complete list of supported resources.Examples
Options
| Flag | Type | Description |
|---|---|---|
-A, --all-namespaces | — | If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. |
--allow-missing-template-keys | — | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true) |
--chunk-size | int | Return large lists in chunks rather than all at once. Pass 0 to disable. (default 500) |
--field-selector | string | Selector (field query) to filter on, supports =, ==, and !=. |
-f, --filename | strings | Filename, directory, or URL to files identifying the resource to get from a server. |
-h, --help | — | Help for get. |
--ignore-not-found | — | If set to true, suppresses NotFound error for specific objects that do not exist. |
-k, --kustomize | string | Process the kustomization directory. This flag can’t be used together with -f or -R. |
-L, --label-columns | strings | 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. |
--no-headers | — | When using the default or custom-column output format, don’t print headers (default print headers). |
-o, --output | string | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide). |
--output-watch-events | — | Output watch event objects when --watch or --watch-only is used. Existing objects are output as initial ADDED events. |
--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. |
-l, --selector | string | Selector (label query) to filter on, supports =, ==, !=, in, notin. |
--server-print | — | If true, have the server return the appropriate table output. Supports extension APIs and CRDs. (default true) |
--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). |
--show-managed-fields | — | If true, keep the managedFields when printing objects in JSON or YAML format. |
--sort-by | string | If non-empty, sort list types using this field specification expressed as a JSONPath expression (e.g. '{.metadata.name}'). |
--subresource | string | If specified, gets the subresource of the requested object. |
--template | string | Template string or path to template file to use when -o=go-template or -o=go-template-file. |
-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
| Flag | Type | Description |
|---|---|---|
--as | string | Username to impersonate for the operation. User could be a regular user or a service account in a namespace. |
--as-group | stringArray | Group to impersonate for the operation. Can be repeated to specify multiple groups. |
--as-uid | string | UID to impersonate for the operation. |
--as-user-extra | stringArray | User extras to impersonate for the operation. Can be repeated to specify multiple values for the same key. |
--certificate-authority | string | Path to a cert file for the certificate authority. |
--disable-compression | — | If true, opt-out of response compression for all requests to the server. |
--insecure-skip-tls-verify | — | If true, the server’s certificate will not be checked for validity. This will make your HTTPS connections insecure. |
--log-flush-frequency | duration | Maximum number of seconds between log flushes. (default 5s) |
-n, --namespace | string | If present, the namespace scope for this CLI request. |
--organization | string | Organization name. |
--platform-wide | — | Access the platform root instead of a project or organization control plane. |
--project | string | Project name. |
--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") |
-s, --server | string | The address and port of the Kubernetes API server. |
--tls-server-name | string | Server name to use for server certificate validation. If not provided, the hostname used to contact the server is used. |
--token | string | Bearer token for authentication to the API server. |
--user | string | The name of the kubeconfig user to use. |
-v, --v | Level | Number for the log level verbosity. |
--vmodule | moduleSpec | Comma-separated list of pattern=N settings for file-filtered logging (only works for the default text log format). |
See also
- datumctl - A CLI for interacting with the Datum platform