You can use the Fernhill SCADA Server Parameters to change how the SCADA Server runs. There are two places where you can set parameters:
The recommended way to set server parameters is using the Server Configuration File.
The Fernhill SCADA Server supports these parameters:
Displays the supported commands and then stops.
Available on | Linux, macOS |
Configuration file | No |
Example | --Help |
Runs the Fernhill SCADA Server as a daemon.
Available on | Linux, macOS |
Configuration file | No |
Example | --Daemon |
Writes the process identifier of the daemon to a file. Intended for use with the systemd services manager. For more information see Manage the Fernhill SCADA Server with systemd.
Available on | Linux, macOS |
Configuration file | No |
Example | --PidFile=/var/run/fernhill-scada.pid |
Tests the server configuration file then stops.
Available on | Linux, macOS |
Configuration file | No |
Example | --TestConf |
Enables guest login with username 'Guest' and an empty password. This option also enables Anonymous login in the OPC UA Server.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --GuestLogin |
Enables recording of passwords of failed logins in the event log. Normally a failed login is recorded in the event log using this message:
An attempt to login failed: User 'XXXXXX'
When RecordFailedLoginPassword is enabled, a failed login is recorded using this message:
An attempt to login failed: User 'XXXXXX', Password 'YYYYY'
This option should only be used to help diagnose failed logins.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --RecordFailedLoginPassword |
Changes the working folder to a different path.
Available on | Windows, Linux, macOS |
Configuration file | No |
Example | --WorkingFolder=E:\FernhillSCADA |
Default Value |
Depends on the edition of Fernhill SCADA:
|
Changes the port number the server listens on for connections.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --PortNumber=50000 |
Default Value | 20295 |
A text string describing the location of the Fernhill SCADA Server. If set, this string appears in the tag status report of the database root folder. This can help users of the Configuration Tool identity the server they are connected to.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --Location="Western Treatment Works" |
Default Value |
Sets the maximum size of a result set of an SQL query.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --MaxSQLResultSize=50M |
Default Value | 50M (50 megabytes) |
The level of detail in the server log files:
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --ServerLogDetail=4 |
Default Value | 2 (Request) |
The location of the server log files.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --ServerLogFolder=E:\Fernhill-SCADA-Logs |
Default Value |
Depends on the edition of Fernhill SCADA:
|
The total size of all server log files.
Diagnostic information from the Fernhill SCADA Server is stored in a rolling set of log files. Each log file in the set is limited to a maximum size. When the current log file reaches the maximum size, a new log file is opened. When the total size of the log files reaches this parameter, the oldest log file is deleted.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --ServerLogSize=20M |
Default Value |
Depends on the edition of Fernhill SCADA:
|
The level of detail in the driver log files:
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --DriverLogDetail=4 |
Default Value | 8 (Transaction Analysis) |
The location of the driver log files. Note: The new path will be used when the Fernhill SCADA Server next starts.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --DriverLogFolder=E:\Fernhill-SCADA-DriverLogs |
Default Value |
Depends on the edition of Fernhill SCADA:
|
The total size of one set of driver log files.
The Fernhill SCADA Server usually creates multiple sets of log files for drivers. One log file set is created for each:
Each log file in the set is limited to a maximum size. When the current log file reaches the maximum size, a new log file is opened. When the total size of the log files in the set reaches this parameter, the oldest log file is deleted.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --DriverLogSize=20M |
Default Value |
Depends on the edition of Fernhill SCADA:
|
The location of the historic data files. When changing this parameter use these steps to avoid data loss:
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --HistoricDataFolder=E:\Fernhill-SCADA-History |
Default Value |
Depends on the edition of Fernhill SCADA:
|
The location of the files for the Event Log. When changing this parameter use these steps to avoid data loss:
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --EventLogFolder=E:\Fernhill-SCADA-Events |
Default Value |
Depends on the edition of Fernhill SCADA:
|
The total number of records to store in the Event Log.
The size of one event record is 512 bytes. To calculated the total storage required by the event log, multiply this parameter by 512.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --EventLogRecords=50M |
Default Value |
Depends on the edition of Fernhill SCADA:
|
Whether the SCADA Server also runs the OPC UA Server.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --OpcUAServer |
Default Value | Not enabled |
The TCP Port number of the OPC UA Server.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --OpcUAServerPort=50001 |
Default Value | 20296 |
The level of detail for requests to the OPC UA Server:
If not set, the parameter default is 2 (Request).
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --OpcUAServerLogDetail=4 |
Default Value | 2 (Request) |
Whether the OPC UA Server enables the deprecated security policies Basic128Rsa15 and Basic256. By default these security policies are not enabled.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --OpcUAServerWeakSecurity |
Default Value | Strong security only |
The address of the computer running the standby Fernhill SCADA Server. The ADDR parameter can be:
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --StandbyServerName=SERVER1 |
Default Value | Not set. The Fernhill SCADA Server operates in standalone mode. |
An alternative link to the standby Fernhill SCADA Server. The ADDR parameter can be:
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --StandbyServerBackupLink=192.168.5.2 |
Default Value | Not set. The Fernhill SCADA Server operates without a backup link. |
The TCP Port number of the standby Fernhill SCADA Server.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --StandbyServerPort=50000 |
Default Value | 20295 |
The password used to authenticate server to server communication. To set up a redundant server pair, both servers must use the same password.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --StandbyServerPassword=IN8J9w7JjmApKNJKXunQ9qBkujs= |
The interval between the transfer of changes from the main server to the standby server. The default interval is 2s (seconds). Use a smaller interval to reduce the delay in the transfer of data from the main to the standby server.
Note: Using a very small interval could result in high CPU usage in the SCADA Server.
Available on | Windows, Linux, macOS |
Configuration file | Yes |
Example | --StandbyTransferInterval=500ms |
The Server Configuration File is a text file that allows you to set SCADA Server Parameters. The location of the file depends on the operating system:
Operating System | Location |
---|---|
Windows |
The default location is: C:\ProgramData\Fernhill Software\Fernhill SCADA\FHServer\Server.conf Note: Using this option on the command line will change the file location: --WorkingFolder=FOLDER To edit this file:
|
Linux and macOS |
The location is: /etc/fernhill-scada/server.conf |
In the Server Configuration File you can use any of the Server Parameters where Configuration File column contains a Yes. For example:
# Allow login with the username 'Guest' and # an empty password. # Type: Boolean GuestLogin = True
To set a Server Parameter on the command line, you should prefix the command with two hyphens (-). For example:
--GuestLogin=True
Where to enter Command Line Parameters depends on the operating system:
Operating System | Location |
---|---|
Windows | Server Command Parameters are entered in the Start Parameters field in the service configuration.
To enter parameters into the Start Parameters field:
Note: Parameters entered here are temporary and will not be saved if the computer is restarted. |
Linux | On Linux, the Fernhill SCADA Server is run from a command. The location of the command depends on the init system used by the Linux distribution.
|
macOS | Server Command Parameters are added to the property list for the Fernhill SCADA Server.
To do this:
Note: After an upgrade to a new version of the software, the .plist file will be reset back to defaults. You will need to manually re-apply any changes after an upgrade. |
To learn more about the Fernhill SCADA Server.
To learn about the tools in Fernhill SCADA.
Configuration ToolTo learn about configuring Fernhill SCADA.
For the meaning of terms used in Fernhill SCADA.