ConfigMirror

Synopsis

[Actions]
ConfigMirror:Name=Name,Member=Member,Primary=Primary[,Additional Properties]

Where:

• Name is the name of the new mirror (when deploying a primary) or the name of the mirror to join (when deploying a backup, DR async, or reporting async). Name can contain a trailing # to use the index of the hostname to name the mirror. In this case, the hostname must match the regular expression -[0-9]+-[0-9]+$ and the index used in naming the mirror is the first number in the regular expression.

• Member is the mirror member type, primary, backup, drasync, rorasync, rwrasync, or auto.

• Primary is the IP address or name of the primary’s host.

The above properties are required, however, there are many possible optional arguments you can supply to ConfigMirror, some that are commonly used are described below.

• SystemName is the name of the mirror member. If this property is not specified, the mirror member name is automatically derived from the hostname.

• SSLDir is the location on the host of the mirror SSL/TLS configuration for the instance, a directory containing the required Certificate Authority certificate (CAFile.pem), local certificate (CertificateFile.pem), and private key file (PrivateKeyFile.pem). When you are using SSL/TLS for your mirror configuration you must run the SYS.Mirror.AuthorizePendingMembers()Opens in a new tab method on the primary failover member after the merge to allow other members to join the mirror. Also, see Authorize the Second Failover Member or Async (TLS Mirrors Only) for information on how to authorize new mirror members using the Management Portal.

• ArbiterURL is the host (hostname or IP address) and port of the arbiter to be configured for the mirror (when deploying the primary) or configured for existing primary (when deploying a backup, DR async, or reporting async).

If you are using ConfigMirror to deploy a mirror using a single merge file and using hostname matching, the following arguments are needed.

• The Member property should be set to auto to automatically match mirror members to hostnames.

• The Primary property should be set to auto to automatically match mirror members to hostnames.

• Map is optional and sets the pattern used to match mirror members with hostnames; the default is Map="primary,backup"

• Ordinal is optional and an integer offset used to prevent overlap in hostnames between independent clusters; default is 0 (zero).

Description

ConfigMirror defines a mirror configuration. InterSystems IRIS® deploys that mirror configuration when processing the [Actions] section during a configuration merge. During the merge, InterSystems IRIS runs a series of API calls to deploy the mirror configuration.

ConfigMirror is reentrant and will exit if the mirror already exists without updating any properties. The exceptions are the ArbiterURL and SSLDir properties. ArbiterURL allows for the addition of an arbiter if one was not previously configured. The presence or absence of SSLDir gives the ability to enable or disable SSL on an existing mirror.

In addition to the properties described above, you can specify any property in the inventory of the MirrorInfo parameter of the SYS.Mirror.CreateNewMirrorSet()Opens in a new tab method.

For examples on using ConfigMirror, see Mirror the Cluster’s Data Server.

Changing this Operation

This operation is designed to be used during a configuration merge. You can change ConfigMirror by editing the merge file in a text editor (as described in Editing the Active CPF).

See Configuring Mirroring for more information about mirror configurations.