Skip to main content
Calico Enterprise 3.21 (latest) documentation

calicoctl bgp peers

This section describes the calicoctl bgp peers command.

Read the calicoctl overview for a full list of calicoctl commands.

Note, this command can be run from any location that has access to the cluster (e.g. anywhere with kubeconfig).

Displaying the help text for 'calicoctl bgp peers' command​

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

Usage:
  calicoctl bgp peers <NAME> [--config=<CONFIG>]

Options:
  -h --help             Show this screen.
  -c --config=<CONFIG>  Path to the file containing connection configuration in
                        YAML or JSON format.
                        [default: /etc/calico/calicoctl.cfg]

Description:
  The bgp peers command prints BGP related information about a given node's peers. For the
  NAME parameter, you can provide either the node name or pod name of the node instance.

Examples​

calicoctl bgp peers name-of-node
calicoctl bgp peers name-of-pod

General options​

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

See also​