Server CLI Commands

The Hawkeye Server supports the following CLI Commands:

Command	Options	Description
backupConfigurationData		Back up the Configuration Database (sql)
	-m , --memberid	Member Id, required when calls are mde from UI
	-n , --notificationType	Notification type, required when calls are mde from UI
	-h , --help	Prints help menu
	-v , --verbose	Verbose output
backupResultsData		Back up the Results Database (elastic)
	-m , --memberid	Member Id, required when calls are mde from UI
	-n , --notificationType	Notification type, required when calls are mde from UI
	-h , --help	Prints help menu
changeDBpasswd		change the SQL database password
changeRepo		Change the Package Repo
	optional arguments:
	-h, --help	show this help message and exit
	--version	show program's version number and exit
	-q, --quiet	Perform quietly; only report errors
	--url URL	Repo base URL
	--release RELEASE	Release version (Major.Minor)
	Diagnostic output options:
	-v, --verbose	Verbose output
	--debug DEBUG	Set debug output level
	--ftrace	Include function trace in debug output
collectDiagnostics		collect system diagnostics for inclusion in support escalations.
	-h, --help	show this help message and exit
	--version	show program's version number and exit
	-d DIAGNOSTICS, --diagnostics DIAGNOSTICS	collect system diagnostics, default: true
	-l LOGS, --logs LOGS	collect system logs, default: true
	-i INTERVAL, --interval INTERVAL	Interval for logs collector, ex: hour, day, week, Jun 1 2020 13:36
	-e ENCRYPT, --encrypt ENCRYPT	Encrypt archive, default: false
	-m MEMBERID, --memberid MEMBERID	Used just for UI calls, when greater han 0 it creates notification
	-td TIMEDIFF, --timeDiff TIMEDIFF	Used just for UI calls, time difference client-server
	-tza TIMEZONEABBREV, --timezoneAbbrev TIMEZONEABBREV	Used just for UI calls, client timezone abbreviation
	-a, --abort	Abort any collectDiagnostics process
	-ir, --isrunning	Check and respond if another collectDiagnostics process is running
hawkeyeConfigurationValidator		Validate the SQL Database configuration
	optional arguments:
	-h, --help	show this help message and exit
	--version	show program's version number and exit
	-q, --quiet	Perform quietly; only have an exit code(0 no failures)
	-v, --verbose	Verbose output
	--debug DEBUG	Set debug output level
	-u USER, --user USER	User name to use for accessing Hawkeye Database
	-p PASSWD, --passwd PASSWD	Password to use for accessing Hawkeye Database
	-g GOLDEN, --golden GOLDEN	Golden file, just the version
	-d GOLDDIR, --golddir GOLDDIR	Directory where the Golden files are located
hawkeyeServices		Restart Hawkeye Services
	optional arguments:
	-h, --help	show this help message and exit
	-i INCLUDE, --include INCLUDE	Include Services
	-e EXCLUDE, --exclude EXCLUDE	Exclude Services
hawkeyeStatus		Check the status of the Hawkeye Services
	optional arguments:
	-h, --help	show this help message and exit
	--version	show program's version number and exit
	-a, --alarms	Include system monitor alarms in output
	-A, --archive_alarms	Include alarms archived in database in output
	-s, --stats	Include system monitor stats in output
	-c, --color	Force color output even if not a TTY
	-q, --quiet	Perform quietly; only report errors
	Diagnostic output options:
	-v, --verbose	Verbose output
	--debug DEBUG	Set debug output level
	--ftrace	Include function trace in debug output
	--timestamps TIMESTAMPS	Include timestamps in logs ('relative' for relative timestamps)
packageCleanup		Removes old packages that are no longer needed. ex. Old Kernel packages
	optional arguments:
	-h, --help	show this help message and exit
	--version	show program's version number and exit
	-y, --assumeyes	Assume "yes" to the delete query
	-f, --force	Force unsafe operation
	-n, --noact	Take no action that actually changes anything, just show what would be done
	-q, --quiet	Perform quietly; only report errors
	Diagnostic output options:
	-v, --verbose	Verbose output
	--debug DEBUG	Set debug output level
	--ftrace	Include function trace in debug output
	--timestamps TIMESTAMPS	Include timestamps in logs ('relative' for relative timestamps)
renameHost		Takes HOSTNAME argument to change Server Hostname
updateServer		Trigger update of the Server from the CLI (online/offline)
	-h , --help	Prints help menu
	-c , --backupConfiguration	Create a backup for configuration (MariaDB)
	-r , --backupResults	Create a backup for results (ElasticSearch)
	-v , --releaseVersion	Set a fix release version, ex: 5.0
	-a , --abort	Stop static files server, restart Hawkeye services
	-C , --checkVersionOnly	Check the current version and the possible update version
	-n , --noninteractive	Interactive mode off
	-u , --ui	Request is performed from UI
	--offline	Perform and update from a local Hawkeye Server ISO