How to check the status of the Engine using the command line interface (CLI)?

Question:

When connected to the Appliance hosting the Engine, using the command line interface (CLI), which command can I use to see if the Engine is up and running?

Answer:

In general, the current status of the Engine can be checked in the Web Console:

If you cannot access the Web Console and want to check if the Engine service is OK, the nxinfo info command can be used to get an overview of the status of the Engine process and its database.

CODE

$ nxinfo info
engine:
 name ................... SupLabEngine-1
 dns .................... support
 state .................. Running
 version ................ 6.30.1.2
 architecture ........... x64
 timezone ............... europe/madrid
 finder ................. tcp/999
 collector .............. udp/999
 api .................... tcp/1671
process:
 id ..................... 24223
 executable ............. /var/nexthink/engine/common/bin/nxengine
 virtual memory ......... 6.9GB
 physical memory ........ 6.6GB
 start time ............. 2021-04-15T18:04:43
 build time ............. 2021-03-10T14:30:44
 uptime ................. 7d 22h 42min 40s
database:
 logins ................. 56
 sources ................ 9200
 servers ................ 200
 endpoints .............. 9000
 mobile devices ......... 0
 destinations ........... 5680
 domains ................ 121110
 printers ............... 52
 ports .................. 120832
 users .................. 30466
 applications ........... 2917
 executables ............ 10343
 binaries ............... 39355
 packages ............... 21336
 alert definitions ...... 32
 services ............... 46
 events:
  maximum events ......... 100000000
  total .................. 99969892
  connections ............ 42661605
  requests ............... 31131431
  executions ............. 23885283
  print jobs ............. 204
  performances ........... 877235
  machines ............... 722713
  alerts ................. 4287
  installations .......... 511365
  issues ................. 15636
  metrics samples ........ 0
  mobile syncs ........... 0
  first .................. 2021-03-07T17:00:00
  last ................... 2021-04-23T17:00:00
 internal:
  signatures ............. 1323480
  visit .................. 3889798
  usages ................. 3172451
  loggages ............... 168040
  installations .......... 1706622
  prints ................. 117
  alerts ................. 3419
  deployments ............ 1
  targets ................ 0
  profile ................ 32

If you get any unexpected output that is different from the sample above, that means something is happening with the Engine service, or the engine is booting at the moment and needs to finalize its database cleanup tasks before being able to process the nxinfo commands.

Some other times it is because the Engine service failed to start, or stops responding.

You can quickly check the current status of the Engine service using the systemctl command:

CODE

sudo systemctl status nxengine@1

Expected output:

CODE

● nxengine@1.service - Nexthink Engine 1
   Loaded: loaded (/usr/lib/systemd/system/nxengine@.service; enabled; vendor preset: disabled)
   Active: active (running) since Thu 2021-04-15 18:04:42 CEST; 1 weeks 0 days ago
 Main PID: 24223 (nxengine_main)
   CGroup: /system.slice/system-nxengine.slice/nxengine@1.service
           └─24223 /var/nexthink/engine/common/bin/nxengine -g 1