ra_config

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

Syntax

ra_config [ { param [, value] | password_parameter, [value] } ]

Parameters

Examples

Usage

  • If ra_config is invoked with no option, it returns a list of all Replication Agent configuration parameters.

  • 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
  • The following information is returned for each configuration parameter:
    • Parameter name – the name of the parameter.

    • Parameter type – the datatype of the parameter 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 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 – refers to the Replication Agent component affected by the value of the parameter.

    • Restart – refers to parameters that require the Replication Agent instance to be shut down and restarted before a change in value takes effect.

  • When ra_config is invoked with either no option, or only the param option, the command is valid when the Replication Agent instance is in the Admin, Replicating, or Replication Down state.

  • If ra_config is invoked when the 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 Replication Agent instance is in the Admin or Replication Down state.

Related reference
ra_set_login
ra_help