Manual Chapter : BIG-IP Reference guide v3.1: BIG/db Configuration Keys

Applies To:

Show Versions Show Versions

BIG-IP versions 1.x - 4.x

  • 3.1.1 PTF-01, 3.1.1, 3.1.0
Manual Chapter


BIG/db Configuration Keys

Supported BIG/db configuration keys

Currently, the following configuration options are supported by BIG/db:

  • Fail-over
  • State mirroring
  • Gateway pingers
  • Configuration synchronization
  • Interface related settings

    The BIG/db keys for each of these features are described in the following series of tables.

Using the Failover and Cluster keys

The switch-over daemon (sod) uses all .Failover keys (Table 7.1). The sod and the mirroring daemon (sfd) use all .Cluster keys. If you change one of these values, you must update the BIG/ip Controller configuration with the bigpipe failover init command. This command forces sod to reread the BIG/db database and use the new values. To run this command, type the following command:

  bigpipe failover init

For more information about sod, see sod, on page 6-1.

The BIG/db keys that store fail-over information

Fail-Over Key Name Description
Common.Bigip.Failover.AwaitPeerAliveDelay Delay in seconds before testing whether peer is active. This key is used by the sod utility. The default value is 2.
Common.Bigip.Failover.AwaitPeerDeadDelay Delay in seconds before testing whether the peer has failed. This key is used by the sod utility. The default value is 1..
Local.Bigip.Failover.UnitId This key is required. Each controller must have a unique unit ID of 1 or 2 in the event that network communication is not possible with its peer.
Common.Bigip.Failover.ActiveMode Use active-active mode if set to 1. By default this is off and active-standby mode is used.
Common.Bigip.Failover.ManFailBack If using active-active mode, the fail-over mechanism waits until receiving a command before surrendering resources to a rebooted machine.
Common.Bigip.Failover.NoSyncTime By default, one BIG/ip Controller synchronizes its time with the other. Set this key to 1 to turn off the time synchronization feature.
Common.Bigip.Failover.DbgFile File into which fail-over (/sbin/sod) logs debug information.
Common.Bigip.Failover.PrintPeerState The default value for this key is 0. Fail-over daemon (/sbin/sod) writes the state of its connection to its peer, hardwire and/or network. This info is written to the fail-over daemon's debug log file.
Common.Sys.Failover.Network Use the network (via the sfd) as a backup to, or instead of, the serial line for fail-over if this value is 1. By default this feature is off.
Common.Bigip.Cluster.ActiveKeepAliveSec An active unit sends a heartbeat message to its peer with this frequency. This key is used by the sfd utility. The default value for this key is 0
Common.Bigip.Cluster.StandbyTimeoutSec Consider the peer BIG/ip failed if no message is received within the timeout period. This key is used by the sfd utility. Default is 3 seconds.

Using StateMirror keys

The mirroring daemon (sfd) uses all StateMirror keys (Table 7.2). If you change one of these values you must reboot the BIG/ip Controller to load the new configuration and restart the sfd.

The BIG/db keys that store state mirroring information

State Mirroring Key Name Description
Common.Bigip.StateMirror.DbgFile File into which debug information is written, required if debug level is specified (below).
Common.Bigip.StateMirror.DbgLevel The debug level is composed of the following options: 1 - log reads and writes 2 - log connection attempts and results 4 - log state changes 8 - open log files in append mode, the default is to truncate the files when opening. The debug level is zero by default.
Common.Bigip.StateMirror.NoGC By default, state mirroring causes mirrored data structures to be deleted when it receives a new connection. This key is brought up to date by the controller's peer. This can cause a delay if the system is absolutely loaded. Turning off the GC is provided as an option.
Common.Bigip.StateMirror.ActiveFile Enables writing of data from the active unit's kernel into the ActiveFile file. This data file can be read with the sfread program.
Common.Bigip.StateMirror.StandbyFile Enables writing of standby data into the StandBy file. This data file can be read with the sfread program.
Common.Bigip.StateMirror.PeerListenPort Port on which the BIG/ip Controller listens for connections from the active unit. Default is 1028.
Local.Bigip.StateMirror.Ipaddr IP address of this BIG/ip Controller.
Local.Bigip.StateMirror.PeerIpaddr IP address of this BIG/ip Controller's peer controller. A value is required.

The BIG/db keys that store gateway pinger information

Gateway Pinger Key Name Description
Local.Bigip.GatewayPinger.Ipaddr IP address or host name of the gateway router for the BIG/ip Controller
Local.Bigip.GatewayPinger.Pinginterval Ping interval of this BIG/ip Controller gateway pinger
Local.Bigip.GatewayPinger.Timeout Timeout of the BIG/ip Controller gateway pinger

Using configuration syncronization and Interface keys

The First-Time Boot utility sets the configuration syncronization and Interface keys (Table 7.4 and Table 7.5). You should not change these keys manually with bigdba.

The BIG/db keys that store configuration synchronization information.

Configuration Synchronization Key Name Description
Common.Bigip.ConfigSyncKey Used for synchronizing the configuration of two BIG/ip Controllers.
Local.Bigip.FTB.FTP.allow Local.Bigip.FTB.HostName = bigip1
Local.Bigip.FTB.HostNumber = 1
Local.Bigip.FTB.IsRedundant Local.Bigip.FTB.License
Local.Bigip.FTB.Locality = domestic
Local.Bigip.FTB.Product = BIG/ip®
Local.Bigip.FTB.Telnet.allow = yes
Local.Bigip.FTB.TimeZone = US/Pacific
Local.Bigip.FTB.Version = "BIG/ip 3.0"
Local.Bigip.FTB.WebServer.Cert.City = Seattle
Local.Bigip.FTB.WebServer.Cert.Company = "Company"
Local.Bigip.FTB.WebServer.Cert.Country = US
Local.Bigip.FTB.WebServer.Cert.Division = undef
Local.Bigip.FTB.WebServer.Cert.State = WA
Local.Bigip.FTB.WebServer.Prefix = http
Local.Bigip.FTB.WebServer.ReplaceKeys = no
First-Time Boot utility Fields. These fields are populated by the First Time Boot utility. These represent a small fraction of the actual fields produced, as the rest are dynamic and dependent upon First-Time Boot utility user input such as host names and interface identifiers.

The BIG/db keys that store interface information

Interface Key Name Description
The interface name is used as the key for querying or modifying its attributes. The key is common by default, but can be local to accommodate redundant BIG/ip Controllers with different interface names. However, the interface names must all be local or all be common.
Attributes of an interface's addresses. Currently, the BIG/db contains only shared IP addresses.
Common.Bigip.Interface.*.AddrList.*.Type Type is Shared or True. Shared is associated with an IP alias, True is associated with an IP address.
Common.Bigip.Interface.*.AddrList.*.UnitId Common.Bigip.Interface.*.AddrList.*.VlanTag The unit number with which the shared IP alias is associated.