[CONFIG]

Description

Allows you to set OpenSwitch command line options. The [CONFIG] section can contain zero or more NAME options.

Format

[CONFIG]
NAME = VALUE
NAME = VALUE
NAME = VALUE

Parameters

NAME and VALUE – configuration options specific to OpenSwitch, which are entered in the format:

NAME=VALUE

where:

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:

NoteA 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”.

Table 5-1: [CONFIG] NAME and VALUE 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:

  • 1 – to check all APIs internally for invalid parameters before execution. This is the default.

  • 0 – to execute all internal APIs without checking for invalid parameters. This setting can speed up performance, but it should be used with caution.

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:

  • 1 – to specify that bcp operations are being logged and are recoverable through the Replication Server.

  • 0 – to specify that bcp operations are not being logged and are not allowed to go through OpenSwitch.This is the default setting.

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:

  • 1 – to cancel the query when the timeout period you set for a query with RESPONSE_TIMEOUT expires.

  • 0 – to allow the query to continue even when the timeout period set in RESPONSE_TIMEOUT expires. This is the default.

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:

  • 1 – to use a single monitoring thread to monitor the health of each of the Adaptive Servers connected to OpenSwitch and to facilitate a failover when necessary. This must be set for OpenSwitch to support Adaptive Server HA clusters, but is also recommended for other non-cluster servers. This must also be set for OpenSwitch to allow mutually-aware support (MAS). CMON is set to 1 (one) by default.

  • 0 – to have each thread rely on receiving its own asynchronous notification from the Adaptive Server to tell it whether a failover is necessary. This setting can be used if there are no Adaptive Server HA clusters among the servers being connected to.

This is a static option.

CMON_FAIL_ACTION

Enter one of these actions:

  • DEFAULT

  • CUSTOM

  • MANUAL

  • CUSTOM_MANUAL

NoteOpenSwitch currently supports only the DEFAULT action for CMON_FAIL_ACTION.

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

NoteRequired only when MUTUAL_AWARE=1.

Enter one of these actions:

  • DEFAULT

  • CUSTOM

  • MANUAL

  • CUSTOM_MANUAL

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.

NoteSet this parameter to a value smaller than the maximum number of file descriptors (see UNIX ulimit -Ha command) to prevent OpenSwitch from using more descriptors than are available.

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:

  • NONE – to not use a coordination module. This still allows coordination modules to be connected, but the modules do not receive any OpenSwitch notifications.

  • AVAIL – to use a coordination module if one is available. If a coordination module is not available, OpenSwitch decides how to deal with client connections.

  • ALWAYS – to use a coordination module, which must be available. If none is attached, all user connections requiring the services of a coordination module are refused until one becomes available.

    NoteTo use the RCM, you must set COORD_MODE to ALWAYS. The RCM can then coordinate the switch of users between the active and the standby Adaptive Servers so the OpenSwitch server does not allow users to connect unless the RCM is available. See the OpenSwitch Coordination Module Reference Manual for details.

  • ENFORCED – to use a coordination module, which must be available. If none is attached, all user connections requiring the services of a coordination module are refused with an informational message.

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.

NoteIf you are using an RCM, COORD_TIMEOUT must be set to zero (0) for the RCM to start.

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.

NoteWhen MUTUAL_AWARE=1, the scripts for both OpenSwitch companions must perform the same action. When a server fails over and SVR_FAIL_ACTION is set to MANUAL or CUSTOM, only one of the companions executes the script that notifies the administrator or restarts the server.

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:

  • 1 – to have all messages that are sent to the log display simultaneously to stderr while the current session of OpenSwitch is running.This is the default.

  • 0 – to have all messages sent only to the log and not display to stderr.

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:

  • 0 – to have the OpenSwitch server continue servicing clients as if it were the only OpenSwitch running in a mutually-aware cluster. All configuration changes, including server and pool status changes, are permitted. This is the default.

  • 1 – to have the OpenSwitch server continue servicing clients, but forbids any changes to the server or pool configuration and status.

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:

  • 1 – to turn on full pass-through mode for communication between clients and the remote database servers.

  • 0 – to turn off full pass-through mode. All communications between the clients and the database servers are tracked by OpenSwitch so they can be restored properly during a failover.This is the default.

This is a static option.

HAFAILOVER

There is no command line equivalent for this option.

This is property is required to enable HAFAILOVER. Enter:

  • 0 – to disable OpenSwitch from recognizing Adaptive Server HA events and error messages. This is the default.

  • 1 – to enable OpenSwitch to recognize Adaptive Server HA events and error messages.

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:

  • 1 – to turn KEEPALIVE on.

  • 0 – to turn KEEPALIVE off. This is the default.

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.

NoteWhen you set MUTUAL_AWARE=1, the scripts for both OpenSwitch companions must perform the same action. This is because during a server failover, if you have set SVR_FAIL_ACTION to MANUAL or CUSTOM, only one of the companions executes the script that notifies the administrator or restarts the server.

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:

The packet size (2048) specified at login time is illegal. Legal values are between 512 and 512.

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:

  • 1 for a mutually-aware OpenSwitch.

  • 0 for a non-mutually-aware OpenSwitch, which is the default.

MUTUAL_CLUSTER

NoteRequired only when MUTUAL_AWARE=1.

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

NoteRequired only when MUTUAL_AWARE=1. However, this parameter is not specific to only mutually-aware OpenSwitch servers; it applies to all OpenSwitch servers with CMON set to 1.

Enter one of these actions:

  • DEFAULT

  • CUSTOM

  • MANUAL

  • CUSTOM_MANUAL

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:

  • 1 – to not block clients trying to connect to a LOCKED server or pool. Instead, return error message 20103 to them immediately. If the client is an administrator (ADMIN_USER) trying to execute rp_switch to switch connections to a LOCKED server, error message 20104 is sent to the administrator instead.

  • 0 – to block clients trying to connect to a LOCKED server or pool. The blocked clients appears to have stopped responding until the affected server or pool is marked as either UP or DOWN. This is the default.

This is a dynamic option.

OPTIMIZE_TEXT

There is no command line equivalent for this option. Enter:

  • 1 – to optimize the processing of text or image data returned from the server by sending the data in “chunks” to the client. This option is used only in the processing of result rows where the result consists of a single column of the text or image datatype. This is the default.

  • 0 – to conserve memory, which is preferable, especially when the text/image data received are usually small in size (less than 100 rows).

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.

NoteYou can use PING_THREAD even if you do not enable mutually-aware support.

  • When set to 1, PING_THREAD detects the failure when an Adaptive Server host or network stops running.

    In a mutually-aware environment, the primary companion OpenSwitch checks to see if the entire network or only the Adaptive Server host network has failed. If the Adaptive Server host network has failed, the primary companion OpenSwitch is notified immediately and the action set for SVR_FAIL_ACTION is invoked.

  • When set to zero (0), PING_THREAD is not available to detect the network failure of an Adaptive Server proactively on behalf of OpenSwitch.

    However, OpenSwitch can still ping Adaptive Server and OpenSwitch receives a notification of a network failure of Adaptive Server. OpenSwitch receives the notification only after 8 minutes, which is the default TCP/IP tcp_ip_abort_interval configuration parameter.

    For mutually-aware support enabled OpenSwitch environments, you must use PING_BINARY, PING_RETRIES, and PING_WAIT in the configuration file, even if you set PING_THREAD to zero (0).

    OpenSwitch uses these parameters while it pings the companion OpenSwitch host and Adaptive Server hosts that store mutually-aware configuration information.

    These are Adaptive Server hosts which have CFG_STORAGE set to 1 in OpenSwitch configuration file.

This is a static option.

NoteDo not use this parameter to monitor the network between clients and OpenSwitch. If the network connection from the client to the OpenSwitch fails, the client detects the failure only when the tcp_ip_abort_interval time has elapsed. This is a kernel parameter that defaults to 8 minutes, but can be tuned to a lower value if the default is unacceptable.

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

NoteRequired only when MUTUAL_AWARE=1.

Enter:

  • 0 – when this is not the primary companion. Zero (0) is the default.

  • 1 – when this is the designated primary companion. A primary companion is responsible for writing to the Adaptive Server cluster tables.

RCM_AUTOSTART

Instruct OpenSwitch whether to start the replication coordination module (RCM). Enter:

  • 0 – to not automatically start the RCM when OpenSwitch starts. This is the default value.

  • 1 – to start the RCM automatically when you start OpenSwitch.

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.

  • 0 – OpenSwitch does not attempt to restart the RCM.

  • Any numeric value – enter the number of times OpenSwitch should attempt to start 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:

  • 1 – to set trace flags for RCM.

  • 0 – to disable trace flags for RCM. This is the default.

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

NoteYou must set this option for attributes under the [LIMIT_RESOURCE] section to take effect.

Sets the -r command line option. Enter:

  • 1 –to enable the OpenSwitch resource monitoring thread.

  • 0 – to disable the resource monitoring thread so resource governing is turned off. This is the default. See “Resource governing” for more information.

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:

  • 0 – to have OpenSwitch return the results for an RPC in the order that is specified by the client return format. This is the default.

  • 1 – to have OpenSwitch return the results in the order that they are returned from the Adaptive Server.

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:

  • 1 – to have all ct_connect failure messages sent to the OpenSwitch log file.

  • 0 – the default. To not send ct_connect failure messages.

This is a dynamic option.

SHOW_SPID

There is no command line equivalent for this option. Enter:

  • 0 – to prevent rp_who from showing the corresponding spid of a client connection to Adaptive Server.

  • 1 – to allow rp_who to show the corresponding spid of a client connection to Adaptive Server.

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:

  • 1 – to have connections pass through as normal client connection.

  • 0 – to have connections treated as from an administrator and not establish the outgoing connection.

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.

NoteOn 64-bit platforms, double this value to prevent a stack overflow.

This is a static option.

SUPPRESS_CHARSET

There is no command line equivalent for this option. Enter:

  • 1 – to suppress the 5704 error message from the server and the informational message reported by OpenSwitch when the OpenSwitch character set is different from the client application character set. The default is 1.

  • 0 – to log a warning message in the LOG_FILE (and also sent to stderr if ECHO_LOG=1) when a client connects to OpenSwitch with a character set different from the one defined in CHARSET.

This is a dynamic option.

SUPPRESS_DBCTX

There is no command line equivalent for this option.

Enter:

  • 0 – to allow the database context change error message (5701).

  • 1 – suppresses the database context change error message (5701). The default is 1.

This is a dynamic option.

SUPPRESS_LANG

There is no command line equivalent for this option.

  • 0 – to allow the database language change error message (5703).

  • 1 – to suppress the language change error message (5703) from the server. The default is 1.

This is a dynamic option.

SVR_FAIL_ACTION

NoteRequired only when MUTUAL_AWARE=1.

Enter one of these actions:

  • DEFAULT

  • CUSTOM

  • MANUAL

  • CUSTOM_MANUAL

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.

NoteIf this option is set to 1, you must ensure that LOGIN_TIMEOUT and RESPONSE_TIMEOUT are both set to realistic values that, when exceeded, indicate a real problem in the server that warrants a failover.

Enter:

  • 0 – to have the connection try the next server only if a connection failure error is received (CS_SV_COMM_FAIL). The default is zero (0).

  • 1 – to have the connection try the next server if there is a time-out error. OpenSwitch fails over to a backup server, even if the network is just slow or Adaptive Server is too busy to respond.

This is a dynamic option.

TCP_NODELAY

There is no command line equivalent for this option. Enter:

  • 1 – to turn TCP_NODELAY on.

  • 0 – to turn TCP_NODELAY off. This is the default.

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:

  • 1 – to truncate the output logging file prior to start-up. For more information on the output logging file, see LOG_FILE in this table.

  • 0 – to append the log file rather than truncate it. This is the default.

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 UPDATE_CFG=1.

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:

  • 1 – to specify that only a client that satisfies all the connection attributes under a pool is allowed to use the pool.

  • 0 – to specify that only a client that satisfies any one of the connection attributes under a pool is allowed to use the pool. This is the default.

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:

  • 1 – to specify that only a client that satisfies all the attributes under the [LIMIT_RESOURCE] sections is subject to the resource governing rules.

  • 0 – to specify that any client that satisfies any one of the attributes under the [LIMIT_RESOURCE] section is subject to resource governing rules. This is the default.

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:

  • 1– to indicate user name and password encryption. OpenSwitch expects ADMIN_USER, ADMIN_PASSWORD, COORD_USER, COORD_PASSWORD, CMON_USER, and CMON_PASSWORD to be encrypted.

  • 0 – to specify no user name and password encryption. OpenSwitch expects clear text for ADMIN_USER, ADMIN_PASSWORD, COORD_USER, COORD_PASSWORD, CMON_USER, and CMON_PASSWORD.

This is a static option.

Example

In this example, “LOG_FILE” identifies that the -l flag is being set, and OpenSwitch.log is the value to use.