ra_config

Description

Returns help information for Mirror Replication Agent configuration parameters, or sets the value of a specified configuration parameter.

Syntax

ra_config [param [, value]]

Parameters

param: The name of a Mirror Replication Agent configuration parameter.

value: The value to be assigned to the configuration parameter specified in the param option. You can use the keyword default to set the specified parameter to its default value.

Examples

Example 1

ra_config use_rssd

This command returns the current value of the use_rssd configuration parameter.

Example 2

ra_config scan_sleep_max, 60

This command changes the value of the scan_sleep_max parameter to 60.

Usage

If ra_config is invoked with no option, it returns a list of all Mirror Replication Agent configuration parameters. The following information is returned for each configuration parameter:
- Parameter name
- Parameter type – the datatype of the parameter’s value (for example, string, numeric, or Boolean).
- Current value – the value of the parameter in effect at the time ra_config is invoked.
- Pending value – if different from the current value, the value to which the parameter was set by a previous invocation of the ra_config command, but which has not yet taken effect.
- Default value – the value of the parameter when the Mirror Replication Agent instance configuration file is created.
- Legal values – the values that are allowed for the parameter, for example, a range of numbers or a list of specific strings.
- Category – this refers to the Mirror Replication Agent component affected by the value of the parameter.
- Restart – this refers to parameters that require the Mirror Replication Agent instance to be shut down and restarted before a change in value takes effect.
If ra_config is invoked with the param option, it returns information only for the specified configuration parameter.
If ra_config is invoked with the param and value options, it changes the setting of the specified configuration parameter to the value specified in the value option.
You can use the keyword default in place of the value option to reset a configuration parameter to its default value. For example:
```
ra_config use_rssd, default
```
When ra_config is invoked with either no option, or only the param option, the command is valid when the Mirror Replication Agent instance is in either Admin or Replicating state.
If ra_config is invoked when the Mirror Replication Agent instance is in Replicating state, with the param and value options for a parameter that can be changed only in Admin state, it returns an error.
When ra_config is invoked with the param and value options, the command is always valid when the Mirror Replication Agent instance is in Admin state.
See Chapter 5, “Mirror Replication Agent Configuration Parameters,” for more information.