Understanding property and configuration files

The following property files are available to you.

Note

Not all changes to these files are maintained during application upgrades.

Database properties file

Location: BCAN_DATA/database.properties

This property file contains the default database settings for the TrueSight Network Automation system. During installation, the database type (Oracle, Microsoft SQL Server, or PostgreSQL), host, and port specified by you are written to this file. Typically there is no need to modify this file.

Global properties files

This section lists the global properties files.

Global properties

Location: BCAN_DATA/global.properties

This property file contains a variety of configuration variables that are used only by the server (not the device agents). Some of the variables are specified by you during installation and written to this file.

Most of the variables are settings that do not change, but are made available to you to tweak the TrueSight Network Automation system. Each variable in the file is prefixed with a comment describing its function, possible values, and default value.

You can view the contents of a default global.properties file in the Default-global-properties-file topic.

Global properties imported

Location: BCAN_DATA/global.properties.imported

This property file contains a variety of configuration variables that are used by both the server and the device agents. The values are set at the server and cannot be manipulated independently at the device agent. This configuration file is created during server installation and deployed to the device agents during handshaking.

Global properties installed

Location: BCAN_DATA/global.properties.installed

This property file contains a variety of configuration variables that are used by both the server and the device agents. This configuration file is created independently during server installation and device agent installations. The values in the configuration file can be manipulated independently at the server and each device agent.

Logging properties file

Location: BCAN_DATA/logging.properties

This property file contains the default logging settings for the TrueSight Network Automation system. For troubleshooting the TrueSight Network Automation system, you can modify the settings to get additional information in the log files. See the comment lines in this file for details. Any manual change will not apply until you restart the web server service.

Note that you may edit this file via the TrueSight Network Automation GUI. Changes made via the GUI are applied immediately, without having to restart the web server service.

Web server (Tomcat) configuration files

Location: BCAN_HOME/tomcat/conf/server.xml

This is one of the Tomcat web server configuration files. You do not normally have to make changes to this file. During installation, the optional HTTP redirection is written to this file as a second <Connector>. You can disable the HTTP redirect by deleting this <Connector>. Note however that this change is not preserved upon subsequent upgrades.

The authentication parameters for Local, LDAP, Active Directory, RADIUS, and TACACS authentication, entered by you during installation, are also contained in this file. Although you can manually modify these values, it is better to rerun the installation to change these settings.

If you want to change this file directly, the following example illustrates the configuration for different authentication mechanisms:

Example

<\!-\- BCA-Networks realm for Local JDBC authentication \-->
Realm className="org.apache.catalina.realm.JDBCRealm"
        driverName="org.postgresql.Driver"
        connectionURL="${bna.jdbcRealm.connectionURL}"
        connectionName="${bna.jdbcRealm.connectionUsername}"
        connectionPassword="${bna.jdbcRealm.connectionPassword}"
        userTable="usr"
        userNameCol="user_name"
        userCredCol="encrypted_password"
        userRoleTable="usr"
        roleNameCol="realm_role_name"
        digest="SHA"/>
<\!-\- BCA-Networks realm for Radius authentication via JAAS \-->
<Realm className="org.apache.catalina.realm.JAASRealm"
        useContextClassLoader="false"
        appName="Radius"
        userClassNames="com.theorem.radius3.login.RADIUSPrincipal"
        roleClassName="com.bmc.bcan.engine.user.security.RolePrincipal"/>
<\!-\- BCA-Networks realm for Tacacs authentication via JAAS \-->
<Realm className="org.apache.catalina.realm.JAASRealm"
        useContextClassLoader="false"
        appName="Tacacs"
        userClassNames="com.bmc.bcan.engine.user.security.TacacsPrincipal"
        roleClassName="com.bmc.bcan.engine.user.security.RolePrincipal"/>
<\!-\- BCA-Networks realm for Active Directory and LDAP authentication \-->
<Realm className="org.apache.catalina.realm.JNDIRealm"
        connectionURL="${bna.jndiRealm.connectionURL}"
        connectionName="${bna.jndiRealm.principal},${bna.jndiRealm.baseDN}"
        connectionPassword="${bna.jndiRealm.connectionPassword}"
        userBase="${bna.jndiRealm.userBase}${bna.jndiRealm.baseDN}"
        userSearch="${bna.jndiRealm.userSearch}"
        userSubtree="${bna.jndiRealm.userSubtree}"
        referrals="${bna.jndiRealm.referrals}"/>

Location: BCAN_HOME/tomcat/conf/catalina.properties

This is the second of the Tomcat web server configuration files. You do not normally have to make changes to this file. During installation, the HTTPS port, and HTTP redirect port (optional) specified by you are written to this file. You can manually change the port by modifying the bna.* settings toward the end of this file. These changes are preserved upon subsequent upgrade.

This file also includes Local, Active Directory, and LDAP authentication settings. You can manually edit these if, for example, you need to change the connection username or password. Such changes are preserved upon subsequent upgrades.