Command Line Utility
Introduction
The KeyHelp command line utility is designed to help administrators and developers access selected KeyHelp features.
This tool is designed for non-interactive operation.
Execution & Operation
To launch the toolbox, first connect to your server. Then call the following command from the command line.
keyhelp [command]For [command], put the name of the function you want to access.
A call without [command] shows the help page of the command and displays all available functions.
Features
Command: help
keyhelp help [command]This command displays the help page of the utility.
You can use the optional parameter [command] to display the help page of the desired command.
Command: login
keyhelp login [username]This command creates a URL that you can use to log into the appropriate user account when called from a web browser.
The parameter [username] determines for which user account the URL should be generated.
If no [username] is specified, the URL is generated for the first main administrator.
The generated login URLs are only valid for a short period of time.
Command: db-login
keyhelp db-loginThis command creates a URL that you can use to log in to the currently configured database management software when called from a web browser.
The login generated this way allows access to all databases and has full root privileges.
The generated login URLs are only valid for a short period of time.
Command: run
keyhelp run [name]This command executes the maintenance interval with the specified name.
If no [name] is specified, the maintenance interval update is executed.
Command: toolbox
keyhelp toolboxThis command opens the interactive console program KeyHelp Toolbox.
Command: version
keyhelp versionThis command displays version information.