Troubleshoot Using the paragon CLI Utility

We've introduced the paragon command CLI utility to run commands on pods running in the system. The paragon commands are a set of intuitive commands to enable you to analyze, query, and troubleshoot your cluster. To execute the commands, log in to any of the primary nodes. The output of the commands is color-coded because the paragon command utility executes the kubecolor commands instead of kubectl, kubecolor color codes your kubectl command output. See Figure 1 for an example output.

To view the entire set of commands available, use:

You can use the tab option to view possible auto-completion options for the commands. To see top-level command auto-completion, type paragon and press tab. For example:

To view the kubecolor command that a paragon command runs, use the echo or -e option. For example:

To execute a paragon command as well as view the kubecolor command that it runs, use the debug or -d option. For example:

To view the entire list of paragon commands and the corresponding kubecolor commands that they run, use:

Figure 1: Example paragon command output Example paragon command output

Problem

Solution

The complete set of commands are listed in Table 1.

Table 1: paragon CLI Utility
Command	Description
`paragon ambassador get emissary`	Gets paragon ambassador emissary pods.
`paragon ambassador get pods`	Gets all paragon ambassador pods.
`paragon ambassador get services`	Gets all paragon ambassador services.
`paragon common postgres roles`	Helps to find the postgres roles.
`paragon describe node`	Gets the description of particular node in the cluster.Use Argument: --node <node-ip>. For example, --node 172.16.x.221. Run "paragon get nodes all" to get node ip.
`paragon ems get devicemanager`	Gets device manager paragon ems pod.
`paragon ems get jobmanager`	Gets job manager paragon ems pod.
`paragon ems get pods`	Gets all paragon ems pods.
`paragon ems get services`	Gets all paragon ems services.
`paragon ems logs devicemanager`	Shows the logs of paragon ems device manager pod. Use argument "--type follow" to get live streaming logs.
`paragon ems logs jobmanager`	Shows the logs of paragon ems job manager pod. Use argument "--type follow" to get live streaming logs.
`paragon get namespaces`	Gets all namespaces available in Paragon.
`paragon get nodes all`	Gets list of all nodes in cluster.
`paragon get nodes diskpressure`	Validates if kubelet has any disk pressure. Use Argument: --node <node_ip/node_name>. For example: --node 172.16.x.221
`paragon get nodes memorypressure`	Validates if kubelet has sufficient memory. Use Argument: --node <node_ip/node_name>. For example: --node 172.16.x.221
`paragon get nodes networkunavailable`	Validates for any issue with calico and network.Use Argument: --node <node_ip/node_name>. For example: --node davinci-master
`paragon get nodes notready`	Gets list of all nodes that is not ready in the cluster.
`paragon get nodes pidpressure`	Validates if kubelet has sufficient pid available.Use Argument: --node <node_ip/node_name>>,Eg: --node davinci-worker1
`paragon get nodes ready`	Gets list of all nodes that is ready in the cluster.
`paragon get nodes taint`	Gets list of all taint on the nodes.
`paragon get pods healthy`	Gets all healthy paragon pods.
`paragon get pods unhealthy`	Gets all unhealthy paragon pods.
`paragon get services exposed`	Gets all paragon services exposed.
`paragon insights cli alerta`	Gets into the CLI of paragon insights alerta pod.
`paragon insights cli byoi`	Gets into the CLI of byoi plugin. Usage : --byoi <BYOI plugin name>.
`paragon insights cli configserver`	Gets into the CLI of paragon insights config-server pod.
`paragon insights cli grafana`	Gets into the CLI of paragon insights grafana pod.
`paragon insights cli influxdb`	Gets into the CLI of paragon insights InfluxDB pod. Use Argument: --influx <influxdb-nodeip> to specify the node ip, else the command will use first influx node as default. Eg: --influx influxdb-172-16-x-21
`paragon insights cli mgd`	Gets into the CLI of paragon insights mgd pod.
`paragon insights describe alerta`	Describes paragon insights alerta pod.
`paragon insights describe api`	Describes paragon insights rest api pod.
`paragon insights describe configserver`	Describes paragon insights configserver pod.
`paragon insights describe grafana`	Describes paragon insights grafana pod.
`paragon insights describe influxdb`	Describes paragon insights InfluxDB pod. Use Argument: --influx <influxdb-nodeip> to specify the node ip,else the command will use first influx node as default. \Eg: --influx influxdb-172-16-x-21
`paragon insights describe mgd`	Describes paragon insights mgd pod.
`paragon insights get alerta`	Gets the paragon insights alerta pod.
`paragon insights get api`	Gets the paragon insights rest api pod.
`paragon insights get configserver`	Gets the paragon insights config-server pod.
`paragon insights get devicegroups`	Gets all paragon insights device groups. The default user name will be - admin (This can be modified using command : paragon set user --cred <username> ). Please set the paragon (UI host) password as a prerequisite using command - paragon set password --cred <password>.
`paragon insights get devices`	Gets all paragon insights devices. The default user name will be - admin (This can be modified using command : paragon set user --cred <username> ). Please set the paragon (UI host) password as a prerequisite using command - paragon set password --cred <password>.
`paragon insights get grafana`	Gets the paragon insights grafana pod.
`paragon insights get influxdb`	Gets the paragon insights InfluxDB pod.
`paragon insights get ingest`	Gets the paragon insights network telemetry ingestion pods.
`paragon insights get mgd`	Gets the paragon insights mgd pod.
`paragon insights get playbooks`	Gets all paragon insights playbooks. The default user name will be - admin (This can be modified using command : paragon set user --cred <username> ). Please set the paragon (UI host) password as a prerequisite using command - paragon set password --cred <password>.
`paragon insights get pods`	Gets all paragon insights pods.
`paragon insights get services`	Gets all paragon insights services.
`paragon insights logs alerta`	Shows the logs of paragon insights alerta pod.
`paragon insights logs api`	Shows the logs of paragon insights rest api pod.
`paragon insights logs byoi`	Shows the logs of paragon insights byoi plugin. Use Argument : --byoi <BYOI plugin name>.
`paragon insights logs configserver`	Shows the logs of paragon insights config-server pod.
`paragon insights logs devicegroup analytical`	Shows the logs of paragon insights device group for service analytical engine. Use Argument :--dg <device Group name with subgroup> Eg: --dg controller-0 (where controller is devicegroup name and 0 is the subgroup).
`paragon insights logs devicegroup itsdb`	Shows the logs of paragon insights device group for service itsdb. Use Argument : --dg <device Group name with subgroup> Eg: --dg controller-0 (where controller is devicegroup name and 0 is the subgroup).
`paragon insights logs devicegroup jtimon`	Shows the logs of paragon insights device group for service jtimon.Use Argument : --dg <device Group name with subgroup> Eg: --dg controller-0 (where controller is devicegroup name and 0 is the subgroup).
`paragon insights logs devicegroup native`	Shows the logs of paragon insights device group for service jti native. Use Argument : --dg <device Group name with subgroup> Eg: --dg controller-0 (where controller is devicegroup name and 0 is the subgroup).
`paragon insights logs devicegroup syslog`	Shows the logs of paragon insights device group for service syslog. Use Argument : --dg <device Group name with subgroup> Eg: --dg controller-0 (where controller is devicegroup name and 0 is the subgroup).
`paragon insights logs grafana`	Shows the logs of paragon insights grafana pod.
`paragon insights logs influxdb`	Shows the logs of paragon insights InfluxDB pod. Use Argument: --influx <influxdb-nodeip> to specify the node ip, else the command will use first influx node as default. Eg: --influx influxdb-172-16-x-21
`paragon insights logs mgd`	Shows the logs of paragon insights mgd pod.
`paragon pathfinder cli bmp`	Gets into the CLI of paragon pathfinder BMP container.
`paragon pathfinder cli configserver`	Gets into the CLI of paragon pathfinder ns-configserver container.
`paragon pathfinder cli crpd`	Gets into the CLI of paragon pathfinder cRPD container.
`paragon pathfinder cli debugutils`	Gets into the CLI of paragon pathfinder debugutils container.
`paragon pathfinder cli netconf`	Gets into the CLI of paragon pathfinder netconf container.
`paragon pathfinder cli pceserver`	Gets into the CLI of paragon pathfinder ns-pceserver container [(PCEP) services].
`paragon pathfinder cli pcserver`	Gets into the CLI of paragon pathfinder ns-pcserver container [Path Computation Server (PCS)].
`paragon pathfinder cli pcviewer`	Gets into the CLI of paragon pathfinder ns-pcsviewer container [paragon Planner Desktop application].
`paragon pathfinder cli scheduler`	Gets into the CLI of paragon pathfinder scheduler container.
`paragon pathfinder cli toposerver`	Gets into the CLI of paragon pathfinder ns-toposerver container [Topology service].
`paragon pathfinder cli web`	Gets into the CLI of paragon pathfinder ns-web container.
`paragon pathfinder debug bgpls config`	Debugs paragon pathfinder cRPD routing-options configuration related to BGP-LS.
`paragon pathfinder debug bgpls routes`	Debugs paragon pathfinder cRPD route table lsdist.0 hidden related to BGP-LS.
`paragon pathfinder debug genjvisiondata help`	Shows paragon pathfinder debugutils genjvisiondata help.
`paragon pathfinder debug genjvisiondata params`	Shows paragon pathfinder debugutils genjvisiondata params.
`paragon pathfinder debug lsp`	Debugs paragon pathfinder PCE server pod learned LSPs from the PCC " >>> show lsp all list".
`paragon pathfinder debug postgres status`	Shows the kubernetes cluster postgres status.
`paragon pathfinder debug rabbitmq status`	Shows the rabbitmqctl cluster status.
`paragon pathfinder debug snoop amqp`	Runs paragon pathfinder debugutils pod to snoop and decode data exchanged between AMQP.
`paragon pathfinder debug snoop help`	Shows paragon pathfinder debugutils snoop help.
`paragon pathfinder debug snoop postgres`	Runs paragon pathfinder debugutils pod to snoop and decode data exchanged between Postgres.
`paragon pathfinder debug snoop redis link`	Runs paragon pathfinder debugutils pod to snoop and decode data exchanged between Redis link.
`paragon pathfinder debug snoop redis lsp`	Runs paragon pathfinder debugutils pod to snoop and decode data exchanged between Redis lsp.
`paragon pathfinder debug snoop redis node`	Runs paragon pathfinder debugutils pod to snoop and decode data exchanged between redis nodes.
`paragon pathfinder debug topoutil help`	Shows paragon pathfinder debugutils topo_util help.
`paragon pathfinder debug topoutil safemode deactivate`	Shows paragon pathfinder debugutils topo_util tool to deactivate safe mode.
`paragon pathfinder debug topoutil topo refresh`	Runs paragon pathfinder debugutils topo_util tool to refresh the current topology.
`paragon pathfinder debug topoutil topo save`	Runs paragon pathfinder debugutils topo_util tool to save the current topology snapshot.
`paragon pathfinder describe bmp`	Describes paragon pathfinder pod including cRPD and BMP containers.
`paragon pathfinder describe configserver`	Describes paragon pathfinder pod including configserver container.
`paragon pathfinder describe debugutils`	Describes paragon pathfinder pod including debugutils container.
`paragon pathfinder describe netconf`	Describes paragon pathfinder pod including ns-netconfd container.
`paragon pathfinder describe pceserver`	Describes paragon pathfinder pod including ns-pceserver container [(PCEP) services].
`paragon pathfinder describe pcserver`	Describes paragon pathfinder pod including ns-pcserver container [path computation server (PCS)].
`paragon pathfinder describe pcviewer`	Describes paragon pathfinder pod including ns-pcsviewer container [paragon planner desktop application].
`paragon pathfinder describe scheduler`	Describes paragon pathfinder pod including scheduler container.
`paragon pathfinder describe toposerver`	Describes paragon pathfinder pod including ns-toposerver container [topology service].
`paragon pathfinder describe web`	Describes paragon pathfinder pod including web container.
`paragon pathfinder get bmp`	Gets paragon pathfinder pod including cRPD and BMP containers.
`paragon pathfinder get configserver`	Gets paragon pathfinder pod including ns-configserver and syslog containers.
`paragon pathfinder get debugutils`	Gets paragon pathfinder pod including debugutils container.
`paragon pathfinder get netconf`	Gets paragon pathfinder pod associated with the netconf process.
`paragon pathfinder get pceserver`	Gets paragon pathfinder pod including ns-pceserver container [(PCEP) services].
`paragon pathfinder get pcserver`	Gets paragon pathfinder pod including ns-pcserver container [Path Computation Server (PCS)].
`paragon pathfinder get pcviewer`	Gets paragon pathfinder pod including ns-pcsviewer container [paragon Planner Desktop application].
`paragon pathfinder get pods`	Gets all paragon pathfinder pods.
`paragon pathfinder get scheduler`	Gets paragon pathfinder pod associated with the scheduler process.
`paragon pathfinder get services`	Gets all paragon pathfinder services.
`paragon pathfinder get toposerver`	Gets paragon pathfinder pod including ns-toposerver container [Topology service].
`paragon pathfinder get web`	Gets paragon pathfinder pod associated with the ns-web process.
`paragon pathfinder logs bmp container bmp`	Shows the logs of paragon pathfinder bmp pods bmp container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs bmp container crpd`	Shows the logs of paragon pathfinder bmp pods cRPD container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs bmp container syslog`	Shows the logs of paragon pathfinder bmp pods syslog container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs configserver container nsconfigserver`	Shows the logs of paragon pathfinder configserver pods ns-configserver container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs configserver container syslog`	Shows the logs of paragon pathfinder configserver pods syslog container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs netconf container nsnetconfd`	Shows the logs of paragon pathfinder netconf pods ns-netconfd container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs netconf container syslog`	Shows the logs of paragon pathfinder netconf pods syslog container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs pceserver container nspceserver`	Shows the logs of paragon pathfinder pceserver pods ns-pceserver container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs pceserver container syslog`	Shows the logs of paragon pathfinder pceserver pods syslog container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs pceserver syslog filtered`	Shows processed logs of paragon pathfinder pceserver pods syslog container fetching only timestamp,level and message. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs pcserver container nspcserver`	Shows the logs of paragon pathfinder pcserver pods ns-pcserver container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs pcserver container syslog`	Shows the logs of paragon pathfinder pcserver pods syslog container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs pcserver syslog filtered`	Shows processed logs of paragon pathfinder pceserver pods syslog container fetching only with timestamp,level and message. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs pcviewer container nspcviewer`	Shows the logs of paragon pathfinder pcviewer pods ns-pcviewer container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs pcviewer container syslog`	Shows the logs of paragon pathfinder pcviewer pods syslog container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs toposerver container nstopodbinit`	Shows the logs of paragon pathfinder toposerver pods ns-topo-dbinit container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs toposerver container nstopodbinitcache`	Shows the logs of paragon pathfinder toposerver pods ns-topo-dbinit-cache container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs toposerver container nstoposerver`	Shows the logs of paragon pathfinder toposerver pods ns-toposerver container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs toposerver container syslog`	Shows the logs of paragon pathfinder toposerver pods syslog container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs toposerver syslog filtered`	Shows processed logs of paragon pathfinder toposerver pods syslog container fetching only with timestamp,level and message. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs web container nsweb`	Shows the logs of paragon pathfinder web pods ns-web container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs web container nswebdbinit`	Shows the logs of paragon pathfinder web pods ns-web-dbinit container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder logs web container syslog`	Shows the logs of paragon pathfinder web pods syslog container. Please use argument "--type follow" to get live streaming logs.
`paragon pathfinder rabbitmq geoha status`	Shows the federation status(from rabbitmq-0 instance). GeoHa status only available for dual cluster setup.
`paragon rookceph ceph osddf`	Reports Rook and Ceph OSD file system disk space usage.
`paragon rookceph ceph osdpoolstats`	Gets Rook and Ceph OSD pool statistics.
`paragon rookceph ceph osdstatus`	Gets Rook and Ceph OSD status.
`paragon rookceph ceph osdtree`	Gets Rook and Ceph OSD tree.
`paragon rookceph ceph osdutilization`	Gets Rook and Ceph OSD utilization.
`paragon rookceph ceph pgstat`	Gets Rook and Ceph pg status.
`paragon rookceph ceph status`	Gets Rook and Ceph status.
`paragon rookceph cli toolbox`	Gets into the CLI of Rook and Ceph toolbox pod.
`paragon rookceph get pods`	Gets Rook and Ceph pods.
`paragon rookceph get services`	Gets Rook and Ceph services.
`paragon rookceph radosgw get period`	This is RADOS gateway user administration utility which gets the period info.
`paragon rookceph radosgw synch status`	This is RADOS gateway user administration utility which gets the metadata sync status.
`paragon set password`	Sets the paragon (UI host) password for rest calls authentications. This is a one time set password mandatory command. Please use argument "--cred <password>" to set the password.
`paragon set username`	Sets the paragon (UI host) username for rest calls authentications. Default username will be - admin. Please use argument "--cred <username>" to set a differnt username.

ON THIS PAGE

Troubleshoot Using the paragon CLI Utility

Problem

Solution