Paragon Insights Command-Line Options
Use -h (help) to view all available command-line
options for the healthbot command.
root@choc-ubuntu1:~# healthbot
$ healthbot -h
usage: healthbot.py [-h] [-v] [-nc]
{ansible,auditlogs,setup,reconfigure,status,remove,start,stop,uninstall,gen-compose,list-plugins,load-plugin,remove-plugin,backup-grafana,restore-grafana,modify-workflow-engine,modify-uda-engine,modify-udf-engine,restart,cli,copy,logs,mgd,tsdb,add-node,remove-node,get-nodes,runtime,cluster-health,patch,version,publish-license-files,connection-state-reset,k,debug,sync-channel-to-master,sync-channel,get-k8s-dashboard-token,postgres,reload-udp-ingest-common-config,cluster-exec,reset-password,migrate-user,create-health-database}
...
positional arguments:
{ansible,auditlogs,setup,reconfigure,status,remove,start,stop,uninstall,gen-compose,list-plugins,load-plugin,remove-plugin,backup-grafana,restore-grafana,modify-workflow-engine,modify-uda-engine,modify-udf-engine,restart,cli,copy,logs,mgd,tsdb,add-node,remove-node,get-nodes,runtime,cluster-health,patch,version,publish-license-files,connection-state-reset,k,debug,sync-channel-to-master,sync-channel,get-k8s-dashboard-token,postgres,reload-udp-ingest-common-config,cluster-exec,reset-password,migrate-user,create-health-database}
sub-command help
setup
Setup healthbot
reconfigure
Reconfigure healthbot
status
Show healthbot status
remove
Remove/Delete services for a group
start
Start healthbot. This command will start common services and services for configured device and network groups
stop
Stop all running healthbot services
uninstall
Uninstall healthbot
gen-compose
Generate compose files of services for the given group
list-plugins
List plugins available in Healthbot
load-plugin
Load a plugin
remove-plugin
Remove a plugin
backup-grafana
Backup Grafana data
restore-grafana
Restore Grafana data
modify-workflow-engine. Modify WORKFLOW engine
modify-uda-engine
Modify UDA engine
modify-udf-engine
Modify UDF engine
restart
Restart the service(s) for a group
cli
Gain cli access to a service
logs
Access service logs
mgd
Spin up MGD container for writing rules
tsdb
update TSDB settings
add-node
add new worker nodes to kubernetes cluster. eg: healthbot add-node node1 node2
remove-node
remove existing worker nodes from kubernetes cluster.eg: healthbot remove-node node1
get-nodes
Get the list of nodes in current kubernetes cluster
runtime
print runtime details
cluster-health
Check cluster health
patch
patch healthbot service
version
Print healthbot version information
publish-license-files Publish license files
connection-state-reset Command to reset connection states manually
k
Run kubectl commands
debug
Debug healthbot
sync-channel-to-master Force sync config manager's channel to master node (applicable for Kubernetes environment)
sync-channel
Force sync given channel to all nodes (applicable for Kubernetes environment)
get-k8s-dashboard-token Prints kubernetes dashboard token
postgres
Postgres commands
reload-udp-ingest-common-config
This command helps a service reload its config. Its
support is very limited now
cluster-exec
Execute commands on nodes
reset-password
Reset password for a user
migrate-user
Migrate user configuration from HealthBot 3.2.x
create-health-database Check cluster health
optional arguments:
-h, --help show this help message and exit
-v, --verbose Increase output verbosity
-nc, --no-color No color
——————————————————————————————————————————————————————————————————————You can also use -h with an option to view more information.
For example:
$ healthbot status -h
usage: healthbot status [-h]
[--network-group NETWORK_GROUP | --device-group DEVICE_GROUP]
[-j]
optional arguments:
-h, --help show this help message and exit
--network-group NETWORK_GROUP
Show network group status
--device-group DEVICE_GROUP
Show device group status
-j, --json Display data in JSON format.