configure RMS

Returns configuration parameter information for the Replication Monitoring Services, or sets the value of a specified RMS configuration parameter.

Syntax

configure [param [= value]]

Parameters

param – Specifies the name of an RMS configuration parameter.

value – The value to be assigned to the configuration parameter specified in the param option.

RMS Parameters
Parameter	Value
`Logconfig`	The path to the RMS log config file.
`Name`	The name of the RMS server. This name must appear in the Sybase interfaces file.
`Password`	The password used to connect to the RMS. The value of this parameter is not displayed by the configure command.
`ping_interval`	The number of seconds between the end of one monitoring cycle and the beginning of the next. It ranges from 30 seconds to 3600 seconds.
`Port`	The IP port used by the RMS. It ranges from 1024 to 65,535.
`SybaseHome`	The Sybase home directory. This directory contains the interfaces file.
`Username`	The user name to connect to the RMS.
`Version`	The version string of the RMS. This is a read-only parameter.
`includeLDAP`	A flag that turns LDAP support on or off.
`ldapTimeout`	A user-configurable timeout value.

Examples

Example 1 – Returns the list of RMS configuration parameters and their current value in this format:

configure

Parameter Name Parameter Type Current Value
-------------- -------------- ------------------
includeldap    boolean        false
ldaptimeout    integer        35
logconfig      string         ../plugins/
                              com.sybase.rms/
                              log4j.properties
name           string         RedtailRMS

Pending Value Default Value         Legal Values
------------- --------------------- ----------------
NULL          false                 List: true,false
NULL          180                   N/A
N/A           ../log4j.properties   N/A
NULL          Rms                   N/A

Category  Restart Required
--------  ----------------
Rms       false
Rms       false
Rms       N/A
Rms       true

Description
-----------------------------------------
A flag that turns LDAP support on or off.
A user configurable timeout value.
The path to the RMS log config file.
The name of the RMS server.

...

Example 2 – Configures a user name of “sa” for the RMS:
```
configure username=sa
```

Usage

The configure RMS command returns this result set, if you do not include a value parameter:

Default RMS Result Set
Column	Description
`Parameter Name`	The name of the parameter, such as `logconfig`, `name`, `port`, and `password`.
`Parameter Type`	The type of parameter, such as `boolean`, `integer`, `string`, and `password`.
`Current Value`	The current value of the parameter.
`Pending Value`	The value the parameter will be after the server is restarted.
`Default Value`	The default value of the parameter.
`Legal Values`	A string that defines the legal values for the parameter. This can be a list, or a numeric range.
`Category`	The name of the category for the parameter. You can use categories to group related parameters together.
`Restart Required`	A flag indicating whether the server must be restarted for the parameter to take effect.
`Description`	The parameter description.