NovaStar Program Reference / System / novastar5
Overview
The novastar
program controls NovaStar system processes and sets program state.
On system start, novastar5 start
is run if the
database configuration table has a record with name='system_up'
and a value='true'
.
The program can manage a single program or all NovaStar5 processes.
See the table below for command line parameters. The major operations are as follows:
On start (novastar5 all start
, which is the default):
- perform log file maintenance using
nslogmaintenance
- perform database maintenance using
nsdbmaintenance
- start
nsdbrep
- database replication - start
nsrecdata
- ALERT and ALERT2 data collection - start
ns50386server
- HydroLynx server - start
nsautointer
- polled station data collection - start
nsdataloader-datafiler
- load data from intermediate table into permanent data tables - start
nsdataloader-filereader
- read data from files in the hotfolder - start
nsmapdisplay
- hardware map display interface - start
nsalerttalk3
- AlertTalk3 notification system - start
nsnetcat
- network to serial interface, used in Jordan system siren control - start
nssystemcommand
- run system commands in database system commands table - start
nssiren
- siren controller
On stop (novastar5 all stop
):
- stop
nsautointer
- stop
nsmapdisplay
- stop
nsalerttalk3
- stop
nsrecdata
- stop
ns50386server
- stop
nsdataloader-datafiler
- stop
nsdataloader-filereader
- stop
nsdbrep
- stop
nsnetcat
- stop
nssystemcommand
- stop
nssiren
On restart (novastar5 all restart
):
novastar5 all stop
novastar5 all start
On status (novastar all status
):
- Display status of
nsdbrep
- Display status of
nsautointer
- Display status of
nsrecdata
- Display status of
ns50386server
- Display status of
nsdataloader-datafiler
- Display status of
nsdataloader-filereader
- Display status of
nsmapdisplay
- Display status of
nsalerttalk3
- Display status of
nsetcat
- Display status of
nssystemcommand
- Display status of
nssiren
On state (novastar all state
):
- Display configuration state of
nsdbrep
- Display configuration state of
nsautointer
- Display configuration state of
nsrecdata
- Display configuration state of
ns50386server
- Display configuration state of
nsdataloader-datafiler
- Display configuration state of
nsdataloader-filereader
- Display configuration state of
nsmapdisplay
- Display configuration state of
nsalerttalk3
- Display configuration state of
nsetcat
- Display configuration state of
nssystemcommand
- Display configuration state of
nssiren
Command Line Usage
The command must be run as the root
user except for actions status
, statusword
, or uptime
.
The command line syntax is:
novastar5 subsystem action [portname] [options...]
novastar5 subsystem state [portname] [options...]
Optional values are shown in square brackets. Subsystems for commands are as follows.
novastar5
Subsystems for Command Line Parameters
Subsystem | Description | Default |
---|---|---|
all |
Control all data collection processes. | This is the default subsystem. |
dbrep |
Control database replication processes. | |
alert [portname] |
Control ALERT data collection processes. 'portname' is the optional port name to control. For example: alert_port1 , alert_port2 . |
Use portname from configuration data. |
50386 [portname] |
Control 50386 data collection processes. 'portname' is the optional port name to control. For example: 50386_port1 , 50386_port2 |
Use portname from configuration data. |
autointer |
Control automatic interrogation processes. | |
mapdisplay |
Control map display processes. | |
alerttalk3 |
Control AlertTalk3 processes. | |
nsdataloader-datafiler |
Control filing data from the data_load table. | |
netcat |
Control netcat processes. | |
nsdataloader-filereader [program number] |
Control adding data to the data_load table. 'program number' is the optional program configuration to control. For example: data_loader_file_reader1 , data_loader_file_reader2 . |
TODO |
siren |
Control novastar5 siren processes. | |
systemcommand |
Control system command processes. | |
system |
Control novastar5 system start. |
Actions for command line parameters are as follows.
novastar5
Actions for Command Line Parameters
Action | Description |
---|---|
force-start |
Force starting a NovaStar service (enable and start). |
force-restart |
Force restarting a NovaStar service (enable and restart). |
start |
Start a NovaStar service. |
stop |
Stop a NovaStar service. |
restart |
Restart a NovaStar service. |
status |
Print the status for NovaStar service. |
statusword |
Currently partially enabled. Custom action to print the service status as one word:
|
uptime |
Currently partially enabled. Custom action to print the service uptime:
|
States for command line parameters are as follows.
novastar5
States for Command Line Parameters
Subsystem | Description |
---|---|
disable |
Disable a subsystem. |
false |
Disable a subsystem. |
enable |
Enable a subsystem. |
true |
Enable a subsystem. |
master |
|
backup |
|
slave |
|
single |
|
failover |
Command line parameters are:
novastar5
Command Line Parameters
Parameter | Description | Default |
---|---|---|
--debug |
Turn on debug messages. | |
-h -help --help |
Display help. | |
--net |
Execute on all replication nodes. | Only current node is changed. |
--quiet |
Do not prompt for root password, exit with status 1 , used with automated testing. |
Prompt for root password if necessary. |
-version --version |
Print program version. |
Examples
The following is an example of a typical system start:
$ sudo novastar5 start
[ ok ] Starting NovaStar5 system start: /usr/bin/novastar5 start.
[ ok ] Starting NovaStar5 System command on dleadernb3: /usr/bin/nssystemcommand :.
[ ok ] Starting NovaStar5 Network serial port pipe on dleadernb3: /usr/bin/nsnetcat /dev/siren1 -fnsatifilter -l -nnovastar5 -p8501:.
[ ok ] Starting NovaStar5 Network serial port pipe on dleadernb3: /usr/bin/nsnetcat /dev/siren1 -fnsatifilter -nnovastar5 -p8502:.
[ ok ] Starting NovaStar5 ALERT data collection on dleadernb3: /usr/bin/nsrecdata /dev/rtdd1 :.
[ ok ] Starting NovaStar5 ALERT data collection on dleadernb3: /usr/bin/nsrecdata 192.168.1.91:2101 -a2 -S1 -r1minute:.
[ ok ] Starting NovaStar5 ALERT data collection on dleadernb3: /usr/bin/nsrecdata 192.168.1.90:4200 -Galert2 -a1 -S4,2 -r5minutes:.
[ ok ] Starting NovaStar5 Automatic interrogation on dleadernb3: /usr/bin/nsautointer :.
[ ok ] Starting NovaStar5 Map display on dleadernb3: /usr/bin/nsmapdisplay -n:8502 -U1,2:.
[ ok ] Starting NovaStar5 AlertTalk3 on dleadernb3: /usr/bin/nsalerttalk3 -n:8503 -U1,2:.
[ ok ] Starting NovaStar5 siren on dleadernb3: /usr/bin/nssiren /dev/siren1 hormann:.
Scheduling
The script is not run on a schedule. However, once programs are started, nshealthcheck
may restart some processes.
NovaStar Administrator Interface
On the Configuration List menu, click Configuration Edit on system_up.
At the page bottom in the Execute section, the novastar5
command is executed
with the network state and action selected.
For example, the following illustrates restarting the system.
novastar5 restart
(see also the full-size image)
For individual data collection such as alert_data_collection,
the Execute section executes the novastar5
program with the network state,
the alert control type, and the action selected, as shown below:
novastar5 alert restart
(see also the full-size image)
Troubleshooting
If database_replication
is not present in the configuration table,
starting programs may not work as expected.
The novastar5
program log file can be found in the following location:
/var/log/novastar5/novastar5.log
.