calicoctl get

This sections describes the calicoctl get command.

Read the calicoctl command line interface user reference for a full list of calicoctl commands.

calicoctl get - 图1note

The available actions for a specific resource type may be limited based on the datastore used for Calico (etcdv3 / Kubernetes API). Please refer to the Resources section for details about each resource type.

Displaying the help text for ‘calicoctl get’ command

Run calicoctl get --help to display the following help menu for the command.

  1. Usage:
  2.   calicoctl get ( (<KIND> [<NAME...>]) |
  3.                 --filename=<FILENAME>) [--recursive] [--skip-empty]
  4.                 [--output=<OUTPUT>] [--config=<CONFIG>] [--namespace=<NS>] [--all-namespaces]
  6. Examples:
  7.   # List all policy in default output format.
  8.   calicoctl get policy
  10.   # List specific policies in YAML format
  11.   calicoctl get -o yaml policy my-policy-1 my-policy-2
  13. Options:
  14.   -h --help                    Show this screen.
  15.   -f --filename=<FILENAME>     Filename to use to get the resource.  If set to
  16.                                "-" loads from stdin. If filename is a directory, this command is
  17.                                invoked for each .json .yaml and .yml file within that directory,
  18.                                terminating after the first failure.
  19.   -R --recursive               Process the filename specified in -f or --filename recursively.
  20.      --skip-empty              Do not error if any files or directory specified using -f or --filename contain no
  21.                                data.
  22.   -o --output=<OUTPUT FORMAT>  Output format.  One of: yaml, json, ps, wide,
  23.                                custom-columns=..., go-template=...,
  24.                                go-template-file=...   [Default: ps]
  25.   -c --config=<CONFIG>         Path to the file containing connection
  26.                                configuration in YAML or JSON format.
  27.                                [default: /etc/calico/calicoctl.cfg]
  28.   -n --namespace=<NS>          Namespace of the resource.
  29.                                Only applicable to NetworkPolicy and WorkloadEndpoint.
  30.                                Uses the default namespace if not specified.
  31.   -A --all-namespaces          If present, list the requested object(s) across
  32.                                all namespaces.
  33.   --export                     If present, returns the requested object(s) stripped of
  34.                                cluster-specific information. This flag will be ignored
  35.                                if <NAME> is not specified.
  36.   --context=<context>          The name of the kubeconfig context to use.
  38. Description:
  39.   The get command is used to display a set of resources by filename or stdin,
  40.   or by type and identifiers.  JSON and YAML formats are accepted for file and
  41.   stdin format.
  43.   Valid resource types are:
  45.     * bgpConfiguration
  46.     * bgpPeer
  47.     * felixConfiguration
  48.     * globalNetworkPolicy
  49.     * hostEndpoint
  50.     * ipPool
  51.     * networkPolicy
  52.     * networkSet
  53.     * node
  54.     * profile
  55.     * workloadEndpoint
  57.   The resource type is case insensitive and may be pluralized.
  59.   Attempting to get resources that do not exist will simply return no results.
  61.   When getting resources by type, only a single type may be specified at a
  62.   time.  The name and other identifiers (hostname, scope) are optional, and are
  63.   wildcarded when omitted. Thus if you specify no identifiers at all (other
  64.   than type), then all configured resources of the requested type will be
  65.   returned.
  67.   By default the results are output in a ps-style table output.  There are
  68.   alternative ways to display the data using the --output option:
  70.     ps                    Display the results in ps-style output.
  71.     wide                  As per the ps option, but includes more headings.
  72.     custom-columns        As per the ps option, but only display the columns
  73.                           that are requested in the comma-separated list.
  74.     golang-template       Display the results using the specified golang
  75.                           template.  This can be used to filter results, for
  76.                           example to return a specific value.
  77.     golang-template-file  Display the results using the golang template that is
  78.                           contained in the specified file.
  79.     yaml                  Display the results in YAML output format.
  80.     json                  Display the results in JSON output format.
  82.   Note that the data output using YAML or JSON format is always valid to use as
  83.   input to all of the resource management commands (create, apply, replace,
  84.   delete, get).
  86.   Please refer to the docs at https://projectcalico.docs.tigera.io for more details on
  87.   the output formats, including example outputs, resource structure (required
  88.   for the golang template definitions) and the valid column names (required for
  89.   the custom-columns option).

Options

  1. -h --help                    Show this screen.
  2. -f --filename=<FILENAME>     Filename to use to get the resource.  If set to
  3.                              "-" loads from stdin.
  4. -o --output=<OUTPUT FORMAT>  Output format.  One of: yaml, json, ps, wide,
  5.                              custom-columns=..., go-template=...,
  6.                              go-template-file=...   [Default: ps]
  7. -n --namespace=<NS>          Namespace of the resource.
  8.                              Only applicable to NetworkPolicy, NetworkSet, and WorkloadEndpoint.
  9.                              Uses the default namespace if not specified.
  10. -A --all-namespaces          If present, list the requested object(s) across
  11.                              all namespaces.
  12. --export                     If present, returns the requested object(s) stripped of
  13.                              cluster-specific information. This flag will be ignored
  14.                              if the resource name is not specified.

General options

  1. -c --config=<CONFIG>         Path to the file containing connection
  2.                              configuration in YAML or JSON format.
  3.                              [default: /etc/calico/calicoctl.cfg]

Output options

ps

This is the default output format. It displays output in ps-style table output with sufficient columns to uniquely identify the resource.

The headings displayed for each resource type is fixed. However, we wide option for displaying additional columns, and custom-columns for selecting which columns to display.

Example:

  1. calicoctl get hostEndpoint

Response:

  1. NAME          NODE
  2. endpoint1     host1
  3. myhost-eth0   myhost

wide

Similar to the ps format, the wide option displays output in ps-style table output but with additional columns.

The headings displayed for each resource type is fixed. See custom-columns for selecting which columns to display.

Example:

  1. calicoctl get hostEndpoint --output=wide

Response:

  1. NAME           NODE     INTERFACE   IPS                PROFILES
  2. endpoint1      host1                1.2.3.4,0:bb::aa   prof1,prof2
  3. myhost-eth0    myhost                                  profile1

custom-columns

Similar to the ps format, the custom-columns option displays output in ps-style table output but allows the user to specify and ordered, comma-separated list of columns to display in the output. The valid heading names for each resource type is documented in the Resources guide.

Example:

  1. calicoctl get hostEndpoint --output=custom-columns=NAME,IPS

Response:

  1. NAME        IPS
  2. endpoint1   1.2.3.4,0:bb::aa
  3. myhost-eth0

yaml / json

The yaml and json options display the output as a list of YAML documents or JSON dictionaries. The fields for resource type are documented in the Resources guide.

The output from either of these formats may be used as input for all of the resource management commands.

Example:

  1. calicoctl get hostEndpoint --output=yaml

Response:

  1. - apiVersion: projectcalico.org/v3
  2.   kind: HostEndpoint
  3.   metadata:
  4.     labels:
  5.       type: database
  6.     name: endpoint1
  7.   spec:
  8.     node: host1
  9.     expectedIPs:
  10.       - 1.2.3.4
  11.       - 0:bb::aa
  12.     profiles:
  13.       - prof1
  14.       - prof2
  15. - apiVersion: projectcalico.org/v3
  16.   kind: HostEndpoint
  17.   metadata:
  18.     name: myhost-eth0
  19.   spec:
  20.     node: myhost
  21.     profiles:
  22.       - profile1

go-template / go-template-file

The go-template and go-template-file options display the output using a golang template specified as a string on the CLI, or defined in a separate file. When writing a template, be aware that the data passed to the template is a golang slice of resource-lists. The resource-lists are defined in the libcalico API and there is a resource-list defined for each resource type. A resource-list contains an Items field which is itself a slice of resources. Thus, to output the “Name” field from the supplied data, it is necessary to enumerate over the slice of resource-lists and the items within that list.

Example:

  1. bin/calicoctl get hostEndpoint --output=go-template="{{range .}}{{range .Items}}{{.ObjectMeta.Name}},{{end}}{{end}}"
  2. endpoint1,eth0,

See also