Lead your team forward
OCT 24 / 9AM ET Register nowOnlineCtl
OnlineCtl is a command line tool used mostly for performing ONE Runtime Server-related tasks.
It is launched by running <ATACCAMA_HOME>/bin/onlinectl.[bat|sh]
.
If you run OnlineCtl without any parameters, you get a short summary of options and commands available to you depending on your product, like the one shown here. |
Usage: java com.ataccama.dqc.server.bin.OnlineCtl <options> <command>
Options:
-hostname hostname or IP address of the online server
-port service port used for internal communication
-secret secret used for secret authentication method
-username user for password authentication method
-password password used in password authentication method
-config path to configuration file with server details
-license path to license file which should be used for online
mode
Basic commands:
listServices Displays list of services being hosted.
password [-aes|-des|-desede] passphrase
Uses DES or AES cipher to create the hash for the
password given as second argument.
refresh Refreshes versioned filesystem folders.
reloadServices Reloads the configuration for online services.
start Starts the online services.
status Displays whether the server is online or not.
stop Stops the online services.
The target server always has to be specified. This can be done in one of two ways:
-
Using a path to the server configuration (the
config
option; only applicable for servers running on your local machine). -
Using
-hostname
and-port
options.
OnlineCtl commands
The following are basic OnlineCtl commands available with any product. Product-specific commands are described in the documentation for these products. A Linux OS is assumed.
start
Starts the online server and services defined in the configuration files described in the given server configuration file.
onlinectl.sh -config default.serverConfig start
stop
Stops the currently running online server and all its services. In the first example here, the server configuration file is provided in order to get the server port number and authentication configuration.
onlinectl.sh -config default.serverConfig stop
onlinectl.sh -hostname localhost -port 7777 stop
refresh
Instructs the server to load data from folders specified under Versioned File System Component. Once the new versions of files are completely loaded and validated, the server (online services, plans) starts using them.
onlinectl.sh -config default.serverConfig refresh
reloadServices
Instructs the sever to reload the online service configuration.
The server looks for files with a .online
extension in the configFolder
of the Online Services Component.
The services defined in the files that have been deleted are stopped, the services defined in the new files are started, and the services defined in the files that existed before the refresh command was executed reload all of their configuration files (.comp
or .plan
files).
While the modified services are being reloaded, all services still respond to incoming requests with the old configuration until the new configuration is successfully loaded. Once it is loaded, service requests are redirected to the new configuration and the old one is released from memory.
If it is not possible to load some of the new configuration (for example, because of a configuration error, insufficient memory or disk space, network problems when connecting to the databases), the server switches completely to the previous configuration that worked before the command was invoked.
That is, all changes in the services defined in all .online
files remain in the same state as before and you have to invoke the refresh command again after you fix the problem.
onlinectl.sh -config default.serverConfig reloadServices
status
Indicates whether the online server is running or not.
onlinectl.sh -config default.serverConfig status
listServices
Lists the services running on the online server (when the server is running).
onlinectl.sh -config default.serverConfig listServices
password
Prints an encoded password to the output. Optionally, it is possible to select the encryption method used.
You can use this encoded password string in the configuration of FileBasedIdentityProvider to set the password for a user.
onlinectl.sh [-aes|-des|-desede] passphrase
OnlineCtl security
If the Server Configuration file defines the usage of password-protected access to the server and services, you have to use the -secret
or -user
and -password
command line options for all commands except the start
command.
Otherwise, the command is not executed and a "Not authorized access" error is reported in the log.
See Server Security.
Use the Authentication Service Component, which is the recommended solution for password-protected access to the server.
Was this page useful?