Opswise Properties
From OpsWise Documentation Wiki
Contents |
Properties Set at Installation
Opswise uses several properties files that allow you to configure options that control its operation. In general there is one property file for each of the Opswise components: core, msghub, transporter, and agent. These properties files are filled in by the installation process, based on information provided by the user during installation. If necessary, you can change these settings after the installation by editing the files. If you do so, the changes will take effect the next time you start the related process.
Opswise "glide.properties"
This properties file is read by the core processor, which is started by Tomcat. The table below describes the properties that must be set before Tomcat is started. Initially, the core installation process sets these properties using the values you supply for that command. The glide.properties file resides here:
<tomcat directory>\webapps\opswise\WEB-INF\properties
| Property Name | Description | Default |
|---|---|---|
| (For MySQL) | ||
| glide.db.rdbms=mysql | Specify this if you are using a MySQL database. | |
| glide.db.url=jdbc:mysql://localhost/ | Specify this if you are using a MySQL database. | |
| (For SQLServer) | ||
| glide.db.rdbms=sqlserver | Specify this if you are using a SQLServer database. | |
| glide.db.url=jdbc:sqlserver://localhost:1433;DatabaseName=opswise | Specify this if you are using a SQLServer database. | |
| (For all databases) | ||
| glide.db.user= | The login ID that OpsWise will use to log in to your database. | root |
| glide.db.password= | The password that OpsWise will use to log in to your database. | (None) |
| glide.db.name= | The name for the OpsWise database. | opswise |
| glide.sys.boot_script= | A script use to initialize the database. Internal use only; do not change. | zboot_opswise.js |
| glide.db.pooler.connections= | 25 | |
| glide.db.pooler.connections.max= | 100 | |
| glide.servlet.port= | The port number used by Tomcat. | 8080 |
Message Hub Properties "msghub.props"
The table below describes the properties that must be set prior to starting the Message Hub. Normally these properties are set when you run the outboard installer using the values you supply for that command. This file resides here:
<agent install directory>\etc
| Property Name | Description | Default |
|---|---|---|
| config.loglvl=[ s | e | w | i | d | t ] | Level of logging for this process, as follows:
|
i (informational) |
| config.txtdebug=[ y | n ] | Specifies whether all messages are logged to the console, as opposed to being written to the log. | n |
| network.transports= | The port and network address of the Opswise Transporter(s) used for messaging. When using multiple Transporters, separate each port@network address by a comma or semicolon. | 4803@127.0.0.1 |
| network.core= | Queue name for the message hub. | HUB01 |
| network.tpqname= | Deprecated. | TP01 |
| network.gmsg= | Specifies whether Guaranteed messaging is used. | false |
| (Database - Set the appropriate parameters for your database as described below.) | ||
| For MySQL database, set these parameters: | ||
| database.rdbms= | Database type. | mysql |
| database.server= | IP address of database server. | localhost |
| database.port= | Port number for database server. | 3306 |
| database.name= | Name of database. | opswise |
| database.user= | Database login ID. | root |
| database.password= | Database password. | |
| database.driver= | Database driver. | MySQL ODBC 5.1 Driver |
| For SQL Server database, set these parameters: | ||
| database.rdbms= | Database type. | sqlserver |
| database.server= | IP address of database server. | localhost |
| database.port= | Port number for database server. | 1433 |
| database.name= | Name of database. | opswise |
| database.user= | Database login ID. | root |
| database.password= | Database password. | |
| database.driver= | Database driver. | SQl Native Client |
| database.warn= | y | |
| For Oracle XE database, set these parameters: | ||
| database.rdbms= | Database type. | oracle |
| database.server= | IP address of database server. | localhost |
| database.port= | Port number for database server. | 1521 |
| database.name= | Name of database. | opswise |
| database.user= | Database login ID. | root |
| database.password= | Database password. | |
| database.driver= | Database driver. | Oracle in XE |
| SSL Properties | ||
| ssl.crlfile= | Path to the Certificate Revocation List (CRL) file. | none |
| ssl.authmodel= | Authentication model. The value authmodel=1 enables SSL communications. The value authmodel=2 disables SSL communications. | 2 |
| ssl.certstore= | Path to the root certificates store. | none |
| ssl.public.cert= | Path to the public certificate file. | c:\opswise\etc\pubcert.pem |
| ssl.private.key= | Path to the private key file. | c:\opswise\etc\privkey.pem |
| ssl.keypassword= | Private key password. | 12345 |
Transport Properties "transport.props"
The table below describes the properties that must be set prior to starting the Transporter. Normally these properties are set when you run the outboard installer using the values you supply for that command. This file resides here:
<agent install directory>\etc
| Property Name | Description | Default |
|---|---|---|
| subnet1.ipaddr= | The subnet broadcast address for the segment where this Transporter is running. | 127.0.0.255 |
| subnet1.port= | The port number used for client to client communication by this transporter. | 4803 |
| subnet1.machine1= | The IP address or hostname where this Transporter is running. | localhost |
| subnet1.name= | The Queue name used by this Transporter. | TP01 |
| SSL Properties | ||
| ssl.crlfile= | Path to the Certificate Revocation List (CRL) file. | none |
| ssl.authmodel= | Authentication model. The value authmodel=1 enables SSL communications. The value authmodel=2 disables SSL communications. | 2 |
| ssl.certstore= | Path to the root certificates store. | none |
| ssl.public.cert= | Path to the public certificate file. | c:\opswise\etc\pubcert.pem |
| ssl.private.key= | Path to the private key file. | c:\opswise\etc\privkey.pem |
| ssl.keypassword= | Private key password. | 12345 |
Agent Properties "agent.props"
The table below describes the properties that must be set prior to starting the Agent. Normally these properties are set when you run the outboard installer using the values you supply for that command. This file resides here:
<agent install directory>\etc
| Property Name | Description | Default |
|---|---|---|
| config.loglvl=[ s | e | w | i | d | t ] | Level of logging for this process, as follows:
|
i |
| config.txtdebug=[ y | n ] | Specifies whether all messages are logged to the console, or mostly to the log. | n |
| config.prtyhigh=- | Operating system dependent value used for switching priority of a job controlled by this agent. | 10 |
| config.prtymed= | Operating system dependent value used for switching priority of a job controlled by this agent. | 5 |
| config.prtylow= | Operating system dependent value used for switching priority of a job controlled by this agent. | 1 |
| config.clusters= | Names of one or more agent clusters separated by commas that this agent will join when initialized. | Opswise - Default Linux/Unix Cluster |
| network.transports= | The port and network address of the Opswise Transporter(s) used for messaging. When using multiple Transporters, separate each port@network address by a comma or semicolon. | 4803@127.0.0.1 |
| network.name= | A Queue name normally automatically assigned by the core to this agent. | OPSAUTOCONF |
| network.core= | Queue name for the message hub. | HUB01 |
| SSL Properties | ||
| ssl.crlfile= | Path to the Certificate Revocation List (CRL) file. | none |
| ssl.authmodel= | Authentication model. The value authmodel=1 enables SSL communications. The value authmodel=2 disables SSL communications. | 2 |
| ssl.certstore= | Path to the root certificates store. | none |
| ssl.public.cert= | Path to the public certificate file. | c:\opswise\etc\pubcert.pem |
| ssl.private.key= | Path to the private key file. | c:\opswise\etc\privkey.pem |
| ssl.keypassword= | Private key password. | 12345 |
Properties Set at Any Time
You can set these properties any time after the system is in operation.
Opswise System Properties
The table below describes which system properties you can customize at any time. These properties do not reside in a properties file but are set through the browser interface. To set OpsWise system properties, select Configuration > Properties from the navigation pane and open the record for the property you want to change.
| Property Name | Description | Default |
|---|---|---|
| Administrator Email Address | Address specified in emails for administrator action. | (None) |
| Agent Cache Retention Period in Days | Number of days that cache files (stdout, stderr) are retained by the system. | 7 |
| Agent Heartbeat Interval in Seconds | The number of seconds between each heartbeat message sent by the agent to the core processor. | 120 |
| Agent Prefix | A prefix appended to the Queue name for newly registered agents. A 4 digit number is appended to this prefix. | AGNT |
| Export Agent References | Whether Opswise should allow references of tasks, triggers, etc. are exported for the export command. | false |
| Export Path | The pathname where exported xml files are written. | /home/prod/tomcat/opswise_export |
| Forecast Period in Days | The number of days to be included in a trigger forecast. See Displaying Trigger Forecast Information. | 31 |
| Heartbeat Processing Interval in Seconds | The interval that the various watchdogs inspect the heartbeats of attached components. | 10 |
| Input Queue Processing Interval in Seconds | The number of seconds that are used to poll the incoming message queues. | 5 |
| List Qualifying Times Format | The format you want the system to use when listing qualifying times for Time and Cron Triggers. See Displaying Trigger Forecast Information. | EEEEE, MMMMMMM dd, yyyy HH:mm:ss z Z |
| Log File Retention Period in Days | Number of days that log files (opswise core, or outboard) are retained by the system. | 5 |
| Maximum Nested Variable Depth | The maximum number of nested variables allowed. | 25 |
| Maximum Processing Threads | The maximum number of processing threads used. | 1000 |
| Opswise Log Level | Level of logging for this process, as follows:
|
INFO |
| Opswise Mode | Used internally to determine how incoming messages are processed by the core process. | REVERSE MSG |
| Platform Log Level | Level of logging for this process, as follows:
|
INFO |
| Start Server Paused | Can be used to start the Opswise server in a paused mode. The Maintenance scripts contain a script that can activate scheduler processing. | false |
Command Line Tool "<anyname.cfg>"
The table below describes the properties that you can set in a file in order to run the command line interface utility. You can also set these values using command switches and/or variables, but the easiest method is to pass them into the command via this properties file. For details, see Command Line Interface > Required Parameters.
| Property Name | Description | Default |
|---|---|---|
| network.transports= | Port number @ machine name (host name of IP address) where the OpsWise transporter is running. | 4803@localhost |
| network.core= | Queue name for the message hub. | HUB01 |
| security.userid= | User ID that the CLI utility will use to log into OpsWise. | |
| security.password= | Password that the CLI utility will use to log into OpsWise. |
