Allows you to set OpenSwitch command line options. The [CONFIG] section can contain zero or more NAME options.
[CONFIG] NAME = VALUE NAME = VALUE NAME = VALUE
NAME and VALUE – configuration options specific to OpenSwitch, which are entered in the format:
NAME=VALUE
where:
NAME – is the option being set
VALUE – is the option’s setting
Table 5-1 describes the options you can set (NAME), and the setting available for each option’s VALUE.
The options shown in Table 5-1 are listed alphabetically for easy reference. This is not the order in which the options appear in the configuration file.
The value description also includes information on whether the option is static or dynamic:
Dynamic option – takes effect immediately when you set it and it affects all future connections but does not affect existing connections. Dynamic options usually affect individual connections.
Static option – you cannot change static options while OpenSwitch is running.You must stop and restart OpenSwitch before the changes take effect. Static options usually define the overall characteristics of the OpenSwitch server and its start-up options.
A value of DEFAULT sets the default values for any server
not explicitly listed in this section.
In Table 5-1, the value description includes the command line option that you can set with this parameter. When you start OpenSwitch at the command line, you can enter the command line option to achieve the same results. See “Using command line options”.
Name |
Value |
---|---|
ADMIN_PASSWORD |
There is no command line equivalent for this option. Enter the administrative user password. If USERNAME_PASSWORD_ENCRYPTED is set to 1, this option should contain the encrypted string of the administrative user password. To encrypt a password, use the -E or -p command line option. See “Using encrypted user names and passwords”. This is a dynamic option. |
ADMIN_USER |
There is no command line equivalent for this option. Enter the name of the incoming user connections that should be considered administrative users. An administrative user has no outgoing connection to the remote Adaptive Server and is intended to perform only administrative tasks, mostly through registered procedure calls (RPCs). If the USERNAME_PASSWORD_ENCRYPTED option is set to 1, this option should contain the encrypted string of the administrative user name. To encrypt a user name, use the -E or -p command line options. This is a dynamic option. |
API_CHECK |
There is no command line equivalent for this option. This option indicates whether to enable or disable the validation of Server-Library arguments and state checking, and may be useful for debugging. Enter:
This is a static option. WARNING! Do not set API_CHECK to zero (FALSE) unless your application has been completely debugged with the default setting of 1 (TRUE). If API_CHECK is 0 (zero), arguments are not validated before they are used. If OpenSwitch passes invalid arguments to Open Client or Client-Library, then OpenSwitch does not work correctly, resulting in memory corruption, memory access violations (UNIX core dumps), or incorrect results. No error messages are generated warning of the condition. |
BCP_LOGGED |
There is no command line equivalent for this option. Indicates whether the OpenSwitch supports bcp in operations. If a bcp operation is not logged and a failure occurs while the operation is executing, OpenSwitch cannot guarantee the recovery of all bcp committed transactions after the failover.Therefore, OpenSwitch allows only bcp in operations if the administrator explicitly confirms that the bcp operations are being logged, and are therefore recoverable through the Replication Server. Enter:
This is a dynamic option. |
CACHE_THREADS |
There is no command line equivalent for this option. Enter an integer value that represents the maximum number of connection threads saved in the OpenSwitch server connection cache. This is a dynamic option. |
CANCEL_QUERY_RESP_TIMEOUT |
There is no command line equivalent for this option. Enter:
This is a dynamic option. |
CHARSET |
Sets the -a command line option. Specifies the default character set used by OpenSwitch. This character set is used in communications with client connections. This is a static option. |
CMON |
There is no command line equivalent for this option. Enter:
This is a static option. |
CMON_FAIL_ACTION |
Enter one of these actions:
This parameter is read-only when the CMON configuration parameter is set to 1 (the recommended setting), and when the CMON thread that monitors the health of the Adaptive Server fails to start. See Table 5-1 for information about the CMON parameter. See “CMON_FAIL_ACTION”and “User-specified actions” for more information about this parameter and its actions. |
CMON_PASSWORD |
There is no command line equivalent for this option. Enter the password for CMON_USER. The default is (empty string). If the USERNAME_PASSWORD_ENCRYPTED option is set to 1, this should contain the encrypted string of the CMON user password. To encrypt a password, use the -E or -p command line options. See “Using encrypted user names and passwords”. This is a static option. |
CMON_RESPONSE_TIMEOUT |
There is no command line equivalent for this option. This option allows the connection nonitoring thread to detect if Adaptive Server does not respond within the time you set. Enter an integer representing seconds. The default is 0 (zero). This value should be at least four times the values of CMON_WAITFOR_DELAY. You must set the CMON_WAITFOR_DELAY option when you use CMON_RESPONSE_TIMEOUT. This is a dynamic option. |
CMON_USER |
There is no command line equivalent for this option. Enter the user login used by the connection monitor (CMON) thread to connect to the back-end server. This must be an existing, valid login on each of the Adaptive Servers being used. Verify this user has basic privileges and can issue a “wait for delay” query to the remote data server. For CMON_WAITFOR_DELAY to work properly, this user should not be an administrative user on the remote data server. If the CMON_USER is not a valid Adaptive Server user, the client can be left in an undefined state when OpenSwitch is configured for failover mode and a failover occurs to the secondary Adaptive Server. If USERNAME_PASSWORD_ENCRYPTED is set to 1, this should contain the encrypted string of the CMON user name. To encrypt a user name, use the -E or -p command line options. This is a static option. |
CMON_WAITFOR_DELAY |
There is no command line equivalent for this option. Allows the user to configure the amount of time the CMON thread delays before the WAITFOR expires when it issues the “wait for delay” query. Enter an integer representing seconds. The default is 3600 (1 hour). Set the CMON_WAITFOR_DELAY to a lesser value if you want the shutdown to occur more quickly. Use this when you want the graceful shutdown of an Adaptive Server rather than a shutdown with no wait. You must set the CMON_WAITFOR_DELAY option when you use CMON_RESPONSE_TIMEOUT. This is a dynamic option. |
CMP_FAIL_ACTION
|
Enter one of these actions:
This parameter is used when network connectivity is lost to the companion OpenSwitch in a mutually-aware setup. Once the network is restored and the connection to the companion is re-established, the two OpenSwitch servers synchronize their configurations. See “CMP_FAIL_ACTION”and “User-specified actions” for more information about this parameter and its actions. |
CON_TRACE |
Sets the -C command line option. Set connection-level tracing flags. See “Using command line options” for the available settings. The output of CON_TRACE is directed to the file specified by the DEBUG_FILE. This is a dynamic option. |
CONNECTIONS |
Sets the -u command line option. Enter the maximum number of user or threads the server can handle.
This is a static option. |
COORD_MODE |
There is no command line equivalent for this option. Determines how OpenSwitch behaves when a coordination module (CM or RCM) is used. Enter:
This is a dynamic option. |
COORD_PASSWORD |
There is no command line equivalent for this option. Enter the password used by the coordination module (CM or RCM) logging in as COORD_USER. If the password is not correctly supplied, the coordination module is treated like any other OpenSwitch user and attempts to establish an outgoing server connection. If USERNAME_PASSWORD_ENCRYPTED is set to 1, this option should contain the encrypted string of the coordination module (CM or RCM) user password. To encrypt a password, use the -E or -p command line option. See “Using encrypted user names and passwords”. This is a dynamic option. |
COORD_TIMEOUT |
There is no command line equivalent for this option. The maximum amount of time (in seconds) it should take for a coordination module to respond to a notification before OpenSwitch makes the next CM ID active. When this parameter is set to zero (0), the default, the concurrent CM feature is disabled. See the OpenSwitch Coordination Module Reference Manual for more information about using concurrent coordination modules. This is a static option.
|
COORD_USER |
There is no command line equivalent for this option. Enter the user name used by coordination modules (CM or RCM) to connect to OpenSwitch. This user does not have an outgoing server connection established with it, and can register to receive coordination notifications. If USERNAME_PASSWORD_ENCRYPTED is set to 1, this option should contain the encrypted string of the coordination module (CM or RCM) user name. To encrypt a user name, use the -E or -p command line option. See “Using encrypted user names and passwords”. This is a dynamic option. |
CTX_TRACE |
Sets the -X command line option. Enter context-level tracing flags. See “Using command line options” for the available settings. The output of the CTX_TRACE is directed to the file specified by DEBUG_FILE. This is a static option. |
CURSOR_PREREAD |
There is no command line equivalent for this option. Enter an integer value that represents the number of rows to be returned with a single fetch request for a cursor. This is a dynamic option. |
CUSTOM_SCRIPT |
There is no command line equivalent for this option. The path to the user-created script to invoke. This is a dynamic option.
See “Invoking custom and manual scripts” for details about which exit codes to use in custom scripts. |
DEBUG |
Sets the -t command line option. Enter OpenSwitch debugging flags. See “Using command line options” for valid flags to set. This is a dynamic option. |
DEBUG_FILE |
Sets the -d command line option. Enter the path to and name of the file in which to place debugging output. This option is used only for the context CTX_TRACE and connection CON_TRACE tracing debugging output. This is a static option. |
ECHO_LOG |
Sets the -e command line option. Enter:
This is a static option. |
FREEZE_CFG_ON_FAIL |
There is no command line equivalent for this option. Whether OpenSwitch locks all server and pool configurations (forbids all changes) when a network break is suspected between the companions during CMP_FAIL_ACTION. Enter:
This is a dynamic option. |
FULL_PASSTHRU |
Sets the -f command line option. Full pass-through mode creates a pipeline for client requests to the server, and for results from the server to the client, which can reduce the overhead introduced by OpenSwitch in both directions, and can improve performance significantly. See “Performance” for more information. Enter:
This is a static option. |
HAFAILOVER |
There is no command line equivalent for this option. This is property is required to enable HAFAILOVER. Enter:
This is a dynamic option. |
INTERFACES |
Sets the -I (uppercase “i”) command line option. Enter an alternate location for the sql.ini (Windows) or interfaces (UNIX) file, rather than the default of %SYBASE%\ini\sql.ini (Windows) and $SYBASE/interfaces (UNIX). This is a static option. |
KEEPALIVE |
There is no command line equivalent for this option. Enter:
See the Open Client documentation for CS_CON_KEEPALIVE for more information. This is a dynamic option. |
LOG_FILE |
Sets the -l command line option. Enter the file name in which to save all messages to log_file rather than the default of OpenSwitch.log. This is a static option. |
LOGIN_TIMEOUT |
There is no command line equivalent for this option. Enter the login timeout (CS_LOGIN_TIMEOUT property). The default is 60 seconds. This is a static option. |
MANUAL_SCRIPT |
There is no command line equivalent for this option. The path to the user-created manual script. This is a dynamic option.
See “Invoking custom and manual scripts” for details about which exit codes to use in manual scripts. |
MAX_LOG_MSG_SIZE |
There is no command line equivalent for this option. Set this property when messages are bigger than 2048 characters. By default, OpenSwitch can log messages up to 2048 characters. This is a dynamic option. |
MAX_LOGSIZE |
There is no command line equivalent for this option. Enter the maximum size of the log_file (the default is 4194304). If log_file exceeds the size you set, OpenSwitch moves the current contents of log_file to a file named currentfilename_old and truncates the current log to 0 bytes. This is a static option. |
MAX_PACKETSIZE |
There is no command line equivalent for this option. Enter the maximum size of a TDS packet. The default is 2048. Used to tune throughput across the network. This is a static option. WARNING! If the Adaptive Server max network packet size configuration parameter is set to 512 (the default), clients connections to OpenSwitch fail and the client receives this error message:
See “Connection refused” for corrective actions. |
MSGQ_SIZE |
There is no command line equivalent for this option. Enter the deferred event queue size (SRV_S_DEFQUEUESIZE) for the context of OpenSwitch.The default is 2048. See the Open Server Server-Library/C Reference Manual for more information. This is a static option. |
MUTUAL_AWARE |
Specifies whether to use mutually-aware OpenSwitch servers. Enter:
|
MUTUAL_CLUSTER
|
A string that represents a mutually-aware cluster. This string must be exactly the same on both OpenSwitch servers, and is used to name the configuration table in the CFG_STORAGE servers (see the [SERVER] section). When this parameter is not set, it defaults to “CLUSTER1”. |
NET_FAIL_ACTION
|
Enter one of these actions:
This parameter is used when the local OpenSwitch is experiencing a network outage and cannot communicate with the Adaptive Servers or companion OpenSwitch hosts. See “NET_FAIL_ACTION” and “User-specified actions” for more information about this parameter and its actions. |
NOWAIT_ON_LOCKED |
There is no command line equivalent for this option. If a client tries to log in or fail over to a server or pool that has a LOCKED state, the client connection is refused (by default) until either the status of the locked server or pool is changed to UP or DOWN, or the client times out and disconnects. If the status is set to UP, the client tries to connect to the server. If the status is set to DOWN, the client proceeds to the next available server or pool. To have the clients return immediately without being refused, set this option to 1; OpenSwitch returns an informational message to the clients describing the reason for the failure, without establishing the outgoing connections to the Adaptive Servers. Enter:
This is a dynamic option. |
OPTIMIZE_TEXT |
There is no command line equivalent for this option. Enter:
This is a dynamic option. |
PING_BINARY |
There is no command line equivalent for this option. The absolute path to the system ping command. When this parameter is not set, it defaults to ping, which relies on the PATH environment variable to locate the correct binary. This is a dynamic option. |
PING_RETRIES |
There is no command line equivalent for this option. The number of times that OpenSwitch should ping a server to rule out possible network problems. This parameter is used in numerous places, when the status must be known of a companion or Adaptive Server. The default is “1”. This is a dynamic option. |
PING_THREAD |
There is no command line equivalent for this option. Enter: Valid values are 0 (zero) or 1. The default is 1.
This is a static option.
The length of strings holding the host name of a machine is limited to 30 characters within the OpenSwitch process. If a host name exceeds this limit, only the first 30 characters is used and may lead to incorrect results or failure during execution. |
PING_WAIT |
There is no command line equivalent for this option. The number of seconds that the ping command should wait before returning a failure. This parameter is used in conjunction with PING_RETRIES, on platforms where the ping command blocks instead of returning right away. The default is 10 (seconds). This is a dynamic option. |
PRIMARY_COMPANION
|
Enter:
|
RCM_AUTOSTART |
Instruct OpenSwitch whether to start the replication coordination module (RCM). Enter:
This is a dynamic option. |
RCM_CFG_FILE |
Enter the path where the RCM configuration file is located. This parameter has a null value if you do not specify a path. This is a static option. |
RCM_LOG_FILE |
Enter the path where the RCM log file should be created. This parameter has a NULL value if you do not specify a path. This is a static option. |
RCM_PATH |
Enter the path where OpenSwitch should look for the RCM executable. If you do not enter this path, and are using an RCM, OpenSwitch runs the RCM located in $OPENSWITCH/bin on UNIX systems or in %OPENSWITCH%\bin on Windows systems; where OPENSWITCH is the installation directory. This parameter has a NULL value if you do not specify a path. This is a static option. |
RCM_RETRIES |
Enter how many times OpenSwitch should retry starting the RCM. If the RCM fails for reasons other than the user requesting that the RCM be shut down, OpenSwitch attempts to restart the RCM. If an unrequested shutdown of the RCM occurs within one minute of starting, OpenSwitch logs an error and does not attempt to restart the RCM.
This is a static option. |
RCM_SECONDARY |
Indicate to OpenSwitch whether the RCM it is launching is a primary or a secondary RCM. Valid values are zero (0, primary) or 1 (secondary). If you do not set this value, it remains at zero (0). This is a dynamic option. |
RCM_TRC_FLAG |
There is no command line equivalent for this option. Use this option to set trace flags for RCM when you start RCM from OpenSwitch. Enter:
This is a dynamic option and you can set it with the rp_set registered procedure. See rp_set for more details. |
RESPONSE_TIMEOUT |
There is no command line equivalent for this option. Enter the timeout period for a response to a command (CS_TIMOUT property). The default is 60 seconds. This is a static option. |
RMON |
Sets the -r command line option. Enter:
This is a static option. |
RMON_INTERVAL |
There is no command line equivalent for this option. Set the frequency, in seconds, in which the resource monitoring thread awakens to check for offending connections.The default is 60 seconds. This is a static option. |
RPC_SETFMT |
There is no command line equivalent for this option. Enter:
This is a dynamic option. |
SEC_PRINCIPAL |
Sets the -U command line option. Enter the principal name by which OpenSwitch is known to the security service provider. This sets the SRV_S_SEC_PRINCIPAL property in the Open Server if you are using a third-party security mechanism to check credentials. The default is NULL. This is a static option. |
SERVER_NAME |
Sets the -n command line option. Enter the name in the interfaces file on UNIX and the sql.ini file on Windows by which the OpenSwitch is to be referred. This is a static option. |
SHOW_CONNECT_ERROR |
There is no command line equivalent for this option. Enter:
This is a dynamic option. |
SHOW_SPID |
There is no command line equivalent for this option. Enter:
See rp_who for more information on this command. A value of 1 introduces a small overhead to each new connection and should be set only when necessary. The default is 0. This is a static option. |
SITE_PASSTHRU |
There is no command line equivalent for this option. Determines whether connections from site handlers can be passed through OpenSwitch. Enter:
This is a dynamic option. |
SSLIDENTITY_FILE |
There is no command line equivalent for this option. Use this option to specify the absolute path to the file containing the digital certificate and the associated private key. This is a static option. |
SSLIDENTITY_PASSWORD |
There is no command line equivalent for this option. Use this option to decrypt the private key in the certificate file By default, OpenSwitch does not encrypt the password you specify with SSLIDENTITY_PASSWORD and you can read the password as it displays as clear text in the OpenSwitch configuration file. If you want to encrypt the password in the configuration file, see “Using encrypted user names and passwords”. This is a static option. See the Open Client and Open Server Configuration Guide for more information on client-side SSL. |
SQL_WRAP |
There is no command line equivalent for this option. Enter the maximum number of characters per line for a SQL statement. Used when OpenSwitch writes SQL statements to a log file if the language debug logging option is turned on. This is a dynamic option. |
SRV_TRACE |
Sets the -s command line option. Enter server-level tracing flags. The output is placed into the location of LOG_FILE. See “Using command line options” for available settings. This is a static option. |
STACKSIZE |
Sets the -S command line option. Enter the stack size for each thread. The default is 40960.
This is a static option. |
SUPPRESS_CHARSET |
There is no command line equivalent for this option. Enter:
This is a dynamic option. |
SUPPRESS_DBCTX |
There is no command line equivalent for this option. Enter:
This is a dynamic option. |
SUPPRESS_LANG |
There is no command line equivalent for this option.
This is a dynamic option. |
SVR_FAIL_ACTION
|
Enter one of these actions:
This parameter is used when an Adaptive Server fails to respond in a timely manner, or when the Adaptive Server host cannot be pinged by either OpenSwitch server in a cluster. See “SVR_FAIL_ACTION” for more information. See “User-specified actions” for details about the available actions. |
SWITCH_AT_LOGIN_TIMEOUT |
There is no command line equivalent for this option. This option works in conjunction with LOGIN_TIMEOUT and RESPONSE_TIMEOUT. If a new connection takes longer than the LOGIN_TIMEOUT value to complete, or an existing connection takes longer than RESPONSE_TIMEOUT to receive a reply back from the Adaptive Server, this option tells OpenSwitch whether to switch the affected client to the next available Adaptive Server.
Enter:
This is a dynamic option. |
TCP_NODELAY |
There is no command line equivalent for this option. Enter:
See the Open Client documentation for CS_CON_TCP_NODELAY for more information. This is a dynamic option. |
TEXTSIZE |
There is no command line equivalent for this option. Enter the maximum size, in bytes, of text or image columns that can be handled by OpenSwitch. Due to the way in which Open Server handles large text columns, memory must be allocated in which to hold the entire column while a result set is processed. Although this memory is held only long enough for the entire result set to be returned to the client, setting this option to an unusually large value can affect the total memory consumed by OpenSwitch. This is a dynamic option. |
TRUNCATE_LOG |
Sets the -T command line option. Enter:
This is a static option. |
UPDATE_CFG |
When set to 1, the configuration file
is updated each time a reconfiguration takes place. Zero (0) is
the default setting. You must run mutual-aware support with |
USE_AND_TO_POOL_ATTRIB |
There is no command line equivalent for this option.
Indicates whether all or only one of the connection attributes in the [POOL] section are to be satisfied by a client. Enter:
For example: [CONFIG] USE_AND_TO_POOL_ATTRIB = 1 [POOl=POOL1:MODE=CHAINED,CACHE=0] servers: ASE1 connections: username: john appname: isql In this example, if USE_AND_TO_POOL_ATTRIB is set to 1, only clients with the user name of “john” and the application name of “isql” are allowed to use POOL1. If USE_AND_TO_POOL_ATTRIB is set to 0, any client with either the user name of “john” or the application name “isql” is allowed to use POOL1. This is a dynamic option. |
USE_AND_TO_RMON_ATTRIB |
There is no command line equivalent for this option.
Indicates whether the connection attributes in the [LIMIT_RESOURCE] section can use “AND” or “OR.” Enter:
For example: [CONFIG] RMON= 1 USE_AND_TO_RMON_ATTRIB=1 [LIMIT_RESOURCE:ACTION=KILL,BUSY=60] username: john appname: isql hostname: machine type:client In the example, set to 1, only connections from the user “john” running the application “isql” from the host “machine” and not a site-handler are monitored and disconnected by the resource manager if their transactions take longer than 60 seconds to complete. If the example used “0”, all connections from the user “john” or from the application “isql” or from the host “machine” or of the client type are monitored and disconnected by the resource manager if their transactions take longer than 60 seconds to complete. This is a dynamic option. |
USE_DONEINPROCS |
When set to 1, OpenSwitch sends the TDS DONEPROC and DONEINPROCS tokens received from the Adaptive Server to connected clients. The default is zero (0). |
USERNAME_PASSWORD_ENCRYPTED |
There is no command line equivalent for this option. Enter:
This is a static option. |
In this example, “LOG_FILE
” identifies
that the -l flag is being set, and OpenSwitch.log is
the value to use.
UNIX:
[CONFIG] LOG_FILE = OpenSwitch.log ... COORD_MODE = ALWAYS RCM_AUTOSTART = 1 RCM_RETRIES = 3 RCM_PATH = /opt/sybase/OpenSwitch-15_1/bin/rcm RCM_CFG_FILE = /opt/sybase/OpenSwitch-15_1/config/rcm1.cfg RCM_LOG_FILE = /opt/sybase/OpenSwitch-15_1/logs/rcm.log RCM_SECONDARY = 0 ... ... ...
Windows:
[CONFIG] LOG_FILE = OpenSwitch.log ... COORD_MODE = ALWAYS RCM_AUTOSTART = 1 RCM_RETRIES = 3 RCM_PATH = C:\sybase\OpenSwitch-15_1\bin\rcm.exe RCM_CFG_FILE = C:\sybase\OpenSwitch-15_1\config\rcm1.cfg RCM_LOG_FILE = C:\sybase\OpenSwitch-15_1\logs\rcm.log RCM_SECONDARY = 0 ... ... ...