close

keyboard_arrow_left

Table of Contents Expand all

play_arrow Introduction
play_arrow Install
play_arrow Monitor
- Install Contrail Analytics
- Kubectl Contrailstatus
play_arrow Manage
- Manage Single Cluster CN2
- Manage Multi-Cluster CN2
play_arrow Appendix
- Configure Repository Credentials
- Juniper CN2 Technology Previews (Tech Previews)

list Table of Contents

English

Kubectl Contrailstatus

Release: CN2 23.2

date_range 18-Jul-23

arrow_backward

arrow_forward

Syntax

content_copy zoom_out_map
kubectl contrailstatus deployment --plane { config | control | data [--wide] }
kubectl contrailstatus resource { bgprouter [BGP | XMPP] | globalsystemconfig | routinginstance | virtualnetwork [--wide] }
kubectl contrailstatus cresource all [detail]
kubectl contrailstatus configdump
kubectl contrailstatus --all [--wide]
kubectl contrailstatus version

Description

This command displays the status' of various CN2 components. You can display the status' of the Configuration plane components, the Control plane components, the Data plane components, and the BGP routers and other resources.

Options

kubectl contrailstatus deployment --plane config	Displays the status of the Configuration plane components: contrail-k8s-apiserver contrail-k8s-controller contrail-k8s-kubemanager
kubectl contrailstatus deployment --plane control	Displays the status of the Control plane components: contrail-control

kubectl contrailstatus deployment --plane data

Displays the status of the Data plane components:

contrail-vrouter-masters
contrail-vrouter-nodes

kubectl contrailstatus resource bgprouter

Displays the status' of the various BGP and XMPP neighbor relationships.

kubectl contrailstatus resource globalsystemconfig

Displays the status of the GlobalSystemConfig.

kubectl contrailstatus resource routinginstance

Displays the status' of the various RoutingInstances in CN2.

kubectl contrailstatus resource virtualnetwork

Displays the status' of the various VirtualNetworks in CN2.

kubectl contrailstatus cresource all Displays all information about all resources (useful for displaying all information in a single command for debugging). If the detail option is used, the output is displayed in JSON format.

kubectl contrailstatus configdump

Lists the resources and their quantities.

kubectl contrailstatus --all

Displays the status' of the Configuration/Control/Data planes and the BGP and XMPP relationships.

kubectl contrailstatus version

Displays the versions of the various container images.

Additional Information

The --wide qualifier displays more information (if available) on the queried component.

Use the --help qualifier to display the help at any point in the command.

This command looks for the kubeconfig file in the default ~/.kube/config location. You can't use the kubectl --kubeconfig option to specify the location of the kubeconfig file.

Output Fields

Table 1 lists some of the output fields for the kubectl contrailstatus command.

Table 1: kubectl contrailstatus Output Fields
Field Name	Field Description
NAME	The name of the pod or resource.
STATUS	The status of the pod or resource.
NODE	The name of the node on which the pod is running.
IP	The (machine) IP address of the node on which the pod is running.
MESSAGE	Not used.
LOCAL BGPROUTER	The name of the node on which the local BGP router is running.
NEIGHBOR BGPROUTER	The name of the node on which the neighbor BGP router is running.
ENCODING	Whether this connection is XMPP or BGP.
STATE	The state of this connection.
POD	The name of the pod on which the local BGP router is running.

Sample Output