Configuration file example
When the configuration file is created, it provides examples of the required configuration parameters that you can use to create a configuration file to satisfy your network requirements. The following file is an example of the file when it is installed.
# Licensed Materials - Property of IBM®
# 5725-C43
# US Government Users Restricted Rights - Use, duplication or disclosure
# Copyright International Business Machines Corp. 2008, 2013. All Rights Reserved
# restricted by GSA ADP Schedule Contract with IBM® Corp.
# Please refer to the Administrator's Guide for instructions regarding this
# Configuration file for BigFix® Remote Control Gateway
# configuration file.
# Logging levels
#
# 0 no logging
#1 error
# 2 informational (default)
# 4 debug information (only by request from IBM®)
# LogLevel = 2
# Log rotation and rollover
LogRotation = Weekly
LogRollover = Daily
# LogRotation Rotate between log files (Daily, Weekly, Monthly, Disabled)
# LogRollover Switch log files (Hourly, Daily)
#
# Defaults
# LogRotation Weekly
# LogRollover Daily
# Use a FIPS certified cryptographic provider for all cryptographic functions
FIPSCompliance = No
# Request Pool
# The gateway stores session requests that it is processing in the request
# pool. The request pool uses a fixed amount of memory.
# Size of the request pool (kilobytes)
# Each request needs 32 bytes
# RequestPool.Size = 2048
# Time before a request from the pool can be re-used, in minutes
# RequestPool.MinimumTTL = 5
# Defaults
#
# RequestPool.Size 2048
# RequestPool.MinimumTTL 5
# Inbound Connections
# Connections to accept incoming connections from endpoints and gateways
# Inbound.1.ConnectionType = Inbound
# Inbound.1.PortToListen = 8881
# Inbound.PortToListen TCP port that gateways and endpoints should
# use to connect to this gateway (required)
# Inbound.BindTo Accept incoming connections on the
# specified IP address only (optional)
# Inbound.RetryDelay Time, in seconds, between attempts to
# listen for incoming connections (optional)
# Inbound.Passphrase Secret passphrase that remote gateways are
# required to authenticate with (optional)
# Inbound.1.AllowGateways Allow gateways to connect to this connection
# (yes/no or true/false) (optional)
# Inbound.1.AllowEndpoints Allow endpoints to connect to this connection
# Defaults
# (yes/no or true/false) (optional)
#
# Inbound.BindTo 0.0.0.0
# Inbound.RetryDelay 45
# Inbound.AllowGateways yes
# Inbound.AllowEndpoints yes
# Examples
# Inbound.2.ConnectionType = Inbound
# Inbound.2.PortToListen = 8881
# Inbound.2.BindTo = 192.168.74.254
# Inbound.2.Passphrase = qagumczw0krbmyajcjOkehnrryuTv1zxyevdckcwsrk}bjfi
# Inbound.2.AllowGateways = true
# Inbound.2.AllowEndpoints = false
# Inbound.3.ConnectionType = Inbound
# Inbound.3.PortToListen = 8881
# Inbound.3.BindTo = 192.168.75.254
# Inbound.4.ConnectionType = Inbound
# Inbound.4.PortToListen = 8881
# Inbound.4.BindTo = 192.168.76.254
# Inbound.4.RetryDelay = 30
# Gateway Connections
# Outgoing control connections to neighbour gateways
# Gateway.1.ConnectionType = Gateway
# Gateway.1.DestinationAddress = 192.168.77.254
# Gateway.1.DestinationPort = 8881
# Gateway.DestinationAddress IP address of the remote gateway
# Gateway.DestinationPort TCP port of the remote gateway
# Gateway.BindTo Force outgoing connections from the
# specified IP address only (optional)
# Gateway.SourcePort Force outgoing connections from the
# specified port only (optional)
# Gateway.RetryDelay Time, in seconds, between attempts to
# connect to the remote gateway (optional)
# Gateway.KeepAlive Time, in seconds, between keepalive
# requests (optional)
# Gateway.Timeout Time, in seconds, before a connection
# attempt is considered to have timed
# out (optional)
# Gateway.Passphrase Secret passphrase if the remote gateway
# requires authentication
# Defaults
#
# Gateway.BindTo 0.0.0.0
# Gateway.SourcePort 0
# Gateway.RetryDelay 45
# Gateway.KeepAlive 900
# Gateway.Timeout 90
# Examples
# Gateway.2.ConnectionType = Gateway
# Gateway.2.DestinationAddress = 192.168.78.254
# Gateway.2.DestinationPort = 8881
# Gateway.2.BindTo = 192.168.74.254
# Gateway.2.SourcePort = 8882
# Gateway.2.RetryDelay = 90
# Gateway.2.KeepAlive = 180
# Gateway.2.Timeout = 30
# Endpoint connections
# Configures the gateways to try to find an endpoint when a session request
# is received
# Endpoint.1.ConnectionType = Endpoint
# Endpoint.SubnetAddress The network address for the subnet that
# this connection can reach (optional)
# Endpoint.SubnetMask The network mask for the subnet that this
# connection can reach (optional)
# Endpoint.BindTo Force outgoing connections from the
# specified IP address only (optional)
# Endpoint.SourcePort Force outgoing connections from the
# specified port only (optional)
# Endpoint.Timeout Time, in seconds, before a connection
# attempt is considered to have timed
# out (optional)
# Defaults
#
# Endpoint.SubnetAddress 0.0.0.0
# Endpoint.SubnetMask 0.0.0.0
# Endpoint.BindTo 0.0.0.0
# Endpoint.SourcePort 0
# Endpoint.Timeout 45
# Examples
# Endpoint.2.ConnectionType = Endpoint
# Endpoint.2.SubnetAddress = 192.168.79.0
# Endpoint.2.SubnetMask = 255.255.255.0
# Endpoint.3.ConnectionType = Endpoint
# Endpoint.3.SubnetAddress = 192.168.80.0
# Endpoint.3.SubnetMask = 255.255.255.0
# Endpoint.4.ConnectionType = Endpoint
# Endpoint.4.BindTo = 192.168.74.254
# Endpoint.4.SourcePort = 8882
# Tunnel connections
# Tunnel connections are used to provide connections to the TRC server for the endpoints
# when they cannot reach the server directly or via an http proxy.
# Setting up a tunnel requires two types of connections. On the gateways that can reach
# the server, an outbound tunnel connection needs to be configured. On the gateways that
# the endpoints can reach, an inbound tunnel is required. When an endpoint connects to the
# inbound tunnel port, the gateway will locate one of the corresponding outbound tunnels
# through the gateway control network. The outbound tunnel then connects to the server to
# complete the tunnel. At that point, the gateways will forward all traffic between the
# endpoint and the server through the tunnel.
# Outbound tunnel connection
# OutboundTunnel.1.ConnectionType = OutboundTunnel
# OutboundTunnel.1.DestinationAddress IP address of the server (required)
# OutboundTunnel.1.DestinationPort TCP port of the server (optional)
# OutboundTunnel.1.TunnelID ID to relate inbound and outbound
# tunnels to each other (optional)
# OutboundTunnel.1.BindTo Force outgoing connections from the
# specified IP address (optional)
# OutboundTunnel.1.Timeout Time, in seconds, before a connection
# attempt is considered to have timed
# out (optional).
# Defaults
#
# DestinationPort 80
# TunnelID TRCSERVER
# BindTo 0.0.0.0
# Timeout 90
#
# Examples
# OutboundTunnel.2.ConnectionType = OutboundTunnel
# OutboundTunnel.2.DestinationAddress = 192.168.81.52
# OutboundTunnel.3.ConnectionType = OutboundTunnel
# OutboundTunnel.3.DestinationAddress = 192.168.81.52
# OutboundTunnel.3.DestinationPort = 443
# Inbound tunnel connection
# InboundTunnel.1.ConnectionType = InboundTunnel
# InboundTunnel.1.PortToListen TCP port that endpoints should use to
# connect to the tunnel (required)
# InboundTunnel.1.TunnelID ID to relate inbound and outbound
# tunnels to each other (optional)
# InboundTunnel.1.BindTo Accept incoming connections on the
# specified IP address only (optional)
# InboundTunnel.1.RetryDelay Time, in seconds, between attempts to
# listen for incoming connections (optional)
# Defaults
#
# TunnelID TRCSERVER
# BindTo 0.0.0.0
# RetryDelay 45