|
%SYS
|
|
|
%SYS
|
|
This class contains the public interface (unless otherwise noted) to the Mirroring subsystem. More...
Static Public Member Functions | |
| _.Library.Status | ActivateMirroredDatabase (_.Library.String Directory) |
| Activate a mirrored database for use on this system More... | |
| _.Library.Status | AddDatabase (_.Library.String Directory, _.Library.String MirrorDBName, _.Library.Boolean enableJournalOK) |
| Adds a database to the mirror. More... | |
| _.Library.Status | AddFailoverMember (_.Library.String MirrorSetName, _.Library.String InstanceName, _.Library.String AgentAddress, _.Library.Integer AgentPort) |
| Method to add another failover member to the existing mirror set. More... | |
| _.Library.Status | AsyncDejournalStart (_.Library.String MirrorName) |
| This method is used on an async member to start the dejournaling processs for one. More... | |
| _.Library.String | AsyncDejournalStatus (_.Library.String MirrorName) |
| This method returns the current status of dejournaling on an async member for one. More... | |
| _.Library.Status | AsyncDejournalStop (_.Library.String MirrorName) |
| This method is used on an async member to shut down the dejournaling for one. More... | |
| _.Library.String | AuthorizePendingMembers (_.Library.String DNList) |
| Authorize pending new member or DN updates of existing member. More... | |
| _.Library.Boolean | BecomePrimary () |
| _.Library.Integer | CatchupDB (_.Library.String DBList, _.Library.String JournalLocation, _.Library.String DBErrList) |
| Invoked when this is a mirror member (backup or primary) and we have one. More... | |
| _.Library.Status | ClearNoFailover (_.Library.String MirrorSetName, _.Library.Boolean AlwaysClearLocal) |
| Clear 'no failover' state for the mirror set. More... | |
| _.Library.Status | CreateNewMirrorSet (_.Library.String MirrorSetName, _.Library.String SystemName, _.Library.String MirrorInfo, _.Library.String SSLInfo) |
| Method to create a new mirror set in the system. More... | |
| _.Library.Integer | DatabasesLatency (_.Library.String MirrorName) |
| _.Library.String | DefaultSystemName () |
| Default system name for the local system, it returned the value of $SYSTEM. More... | |
| _.Library.Status | DejournalPauseDatabase (_.Library.SysPath DatabasePath) |
| Stop dejournaling a database on a backup or on an async. More... | |
| _.Library.Status | Demote () |
| Demotes this failover member to a DR async member. | |
| _.Library.Status | DemotePartner () |
| Demotes the other failover member to a DR async member. More... | |
| _.Library.Integer | DistanceFromPrimaryDatabases () |
| _.Library.Integer | DistanceFromPrimaryJournalFiles () |
| _.Library.Status | GetFailoverMemberStatus (_.Library.String ThisMember, _.Library.String OtherMember) |
| Return mirror failover members' status. More... | |
| _.Library.Status | GetPrimaryJournalPosition (_.Library.String MirrorSetName, _.Library.String JournalPosition) |
| Get the journal position of the primary member so a mirror member could check the latency of its journal file or database with this position. More... | |
| _.Library.List | IsFailoverReady (_.Library.Integer numSecOfDBLatency) |
| IsFailoverReady(allowedDejournalLatency) returns success when called from a failover member. More... | |
| _.Library.Integer | IsMirrorStarted (_.Library.String MirrorName) |
| Whether the specific mirror set is started or not. More... | |
| _.Library.Status | JoinMirrorAsAsyncMember (_.Library.String MirrorSetName, _.Library.String SystemName, _.Library.String InstanceName, _.Library.String AgentAddress, _.Library.Integer AgentPort, _.Library.Integer AsyncMemberType, _.Library.String LocalInfo, _.Library.String SSLInfo) |
| Method to join an existing mirror set as an async member. More... | |
| _.Library.Status | JoinMirrorAsFailoverMember (_.Library.String MirrorSetName, _.Library.String SystemName, _.Library.String InstanceName, _.Library.String AgentAddress, _.Library.Integer AgentPort, _.Library.String LocalInfo, _.Library.String SSLInfo) |
| Method to join an existing mirror set as a failover member. More... | |
| _.Library.Integer | JournalFilesLatency (_.Library.String MirrorName) |
| _.Library.Integer | JrnPurgeDefaultWait (_.Library.Integer JrnPurgeWait) |
| _.Library.Status | Promote (_.Library.String UnavailableMembers) |
| Promotes this DR async member to a failover member for use in normal planned cutover scenarios. More... | |
| _.Library.Status | PromoteCheck (_.Library.String UnavailableMembers, _.Library.String Partner) |
| Similar to <METHOD>Promote</METHOD>, check whether it can successfully promote this DR async member to a failover member for use in normal planned cutover scenarios. More... | |
| _.Library.Status | PromoteWithNoPartner (_.Library.String UnavailableMembers, _.Library.Integer Flags) |
| Promotes this DR async member to a failover member for use in unplanned disaster situations where there are no functioning failover member. More... | |
| _.Library.Status | PromoteWithPartner (_.Library.String UnavailableMembers) |
| Similar to <METHOD>Promote</METHOD>, promotes this DR async member to a failover member, automatically identifying the correct failover partner and returning error if the partner cannot be identified. More... | |
| _.Library.Status | PromoteWithSelectedPartner (_.Library.String Partner, _.Library.String UnavailableMembers) |
| Promotes this DR async member to a failover member for use in unplanned disaster situations where there is no functioning primary,. More... | |
| _.Library.Status | PurgeJournalFiles (_.Library.Boolean CheckOnly, _.Library.String StartFile, _.Library.String maxdisconnecttime, _.Library.String mirrorname, _.Library.Integer PurgedCount, _.Library.Integer PurgedMB, _.Library.List PurgedRange, _.Library.String PurgedFiles) |
| _.Library.Status | RemoveFromApprovalList (_.Library.String MemberName, _.Library.String GUID, _.Library.String MirrorSetName) |
| Remove an entry from the PendingDNUpdates or PendingNewMembers list. More... | |
| _.Library.Status | RemoveMirrorConfiguration (_.Library.Boolean DeleteDB, _.Library.Boolean CleanJournal, _.Library.Boolean CleanSSL) |
| Remove the whole mirror configuration. More... | |
| _.Library.Status | RemoveMirroredDatabase (_.Library.String Directory) |
| Remove a database from the mirror More... | |
| _.Library.Status | RemoveOneMirrorSet (_.Library.String MirrorName, _.Library.Boolean DeleteDBs, _.Library.Boolean CleanJournal) |
| Remove the one specific mirror set from configuration. More... | |
| _.Library.Status | SetNoFailover (_.Library.String MirrorSetName) |
| Set 'no failover' state for the mirror set. More... | |
| _.Library.Status | StartMirror (_.Library.String MirrorName) |
| Activate and startup a mirror. More... | |
| _.Library.Status | StopMirror (_.Library.String MirrorName, _.Library.Integer Timeout) |
| Shutdown a mirror. More... | |
| _.Library.Status | UpdateDNinMirrorSetMember () |
| This method will update the local member in MirrorSetMembers section in CPF file, it will update the DN field of the local system. | |
| _.Library.Status | UpdateMirrorSSL (_.Library.String SSLInfo) |
| Method to create or modify Mirror SSL configuration which includes MirrorServer and MirrorClient. More... | |
| _.Library.Status | UpdateMirrorUseSSL (_.Library.String MirrorSetName, _.Library.Boolean Enable) |
| Modify Mirror UseSSL configuration. More... | |
| _.Library.Status | VerifyMirrorSSLCertificates (_.Library.String MirrorSetName, _.Library.Boolean AllMembers) |
| Verifiy mirror SSL certificates against all mirror members or between all members. More... | |
Static Public Attributes | |
| DOMAIN = None | |
| This class contains the public interface (unless otherwise noted) to the Mirroring subsystem. More... | |
| JrnPurgeDefaultWaitDuration = None | |
| Mirror journal purge wait duration. | |
This class contains the public interface (unless otherwise noted) to the Mirroring subsystem.
It contains methods that return information and provide control for customer scripts.
This class can only be used by programs running in SYS. <class>SYSTEM.Mirror</class> contains public methods which can be called by programs running in any namespace.
|
static |
Activate a mirrored database for use on this system
Used when a mirrored database is moved to a home on a system or when it is copied between instances (perhaps restored from a backup) to mark it as "active". A database which is not marked as active is read/only, even on the primary, and it is not kept up to date on a backup. After a database is activated, <method>CatchupDB</method> is used to get it caught up so it can become part of the active mirror.
|
static |
Adds a database to the mirror.
Can only be run on the primary mirror member.
Input Parameters:
If the operation succeeds, the database will be mounted and journaling will be enabled. If the operation fails, the target database may be mounted and journaling may be enabled (assuming EnableJournalOK is not FALSE) depending on where the error occured.
|
static |
Method to add another failover member to the existing mirror set.
The target member should have
two failover members configured in the mirror set. One of the failover member should be this local system. Input Parameters:
|
static |
This method is used on an async member to start the dejournaling processs for one.
mirror that the member is tracking. This is useful after journaling has been stopped with <method>AsyncDejournalStop</method>.
Input Parameters:
|
static |
This method returns the current status of dejournaling on an async member for one.
of the mirrors that the member is tracking.
Input Parameters:
Returns:
|
static |
This method is used on an async member to shut down the dejournaling for one.
mirror that the member is tracking. Dejournaling remains stopped across restarts until it is started again with either <Method>AsyncDejournalStart</Method> or via the management interface. This is useful in a configuration where it is desirable to update the data at some point of the day and then have it remain static until the next update.
Dejournaling can also be controlled on a per database basis using <Method>DejournalPauseDatabase</Method>.
Input Parameters:
|
static |
Authorize pending new member or DN updates of existing member.
Input Parameters:
This method will look through all currently pending list of new member and DN updates of existing member to authorize them.
Return Value:
When the <parameter>DNList</parameter> is in $LIST format, the returned status is also in $LIST format, each DN is processed indpenedently so each result of the DN is returned in corresponding $LIST position. If the <parameter>DNList</parameter> is single DN and not in $LIST then the result is not in $LIST format.
It returns an error if the input DN is not in pending list.
|
static |
Turn the local node into the primary mirror member when it is currently the backup.
This method does not force the node to become the primary "at all costs", it is designed for normal takeover when some external code has determined that the other node is either down or has failed, or the user simply wants this node to become the primary. This method will override the "cstop nofailover" state which may have been declared when the other node shut down. This method works by forcing the other node down.
Return Value:
      TRUE = node is now the primary (could have already been the primary)
      FALSE = failed to become the primary
|
static |
Invoked when this is a mirror member (backup or primary) and we have one.
or more mirrored database which needs to be "caught up" and "linked in" to the active system. This generally occurs when a database is dismounted on a backup or or after a mirrored database is restored from backup, copied between systems, etc.
Input Parameters:
Return Value:
0 - Failed - no databases were caught up
1 - Success, at least one database was caught up - DBErrList contains a $LIST of
         the sfn's which were not caught up as part of the operation. The list is empty
         if all of the requested databases have been caught up.
         Additional information regarding errors might be found in the console log.
Allocates a block of dejournaling memory and uses the C based dejournaler to apply journal records to the mirrored databases.
This can be used by non-mirror members, but they must have a copy of the mirror journal log available so they can build a list of journal files to restore.
On active mirror members the databases become "active" at the end of a successful operation. On a backup this means they're linked into the active dejournaling system. On the primary this means transaction rollback is performed and then the databases are marked read/write and are available for use.
|
static |
Clear 'no failover' state for the mirror set.
This function clears 'no failover' state which was set by 'SetNoFailover' function.
It reaches out the other failover member (if exist) to notify it to clear 'no failover' state.
If the other failover member is not reachable, there is an option to clear it locally with 'AlwaysClearLocal' set.
Only failover member can call this function.
The 'MirrorSetName' is the name of the mirror set, if can be null for the current mirror set.
The 'AlwaysClearLocal' is an option for this function, when it is set it ignores the error when the other failover member is not reachable and clear 'no failover' state locally, otherwise it returns error to indicate the other failover member is not reachable. The default value is 'not set'.
This method returns all detected errors if there is any.
|
static |
Method to create a new mirror set in the system.
There should be no mirror set existing in the system before this call.
This method will create the very first failover member of the mirror set.
Input Parameters:
|
static |
On a connected backup or async member this returns an indication of how up to date (in seconds) the active databases are with respect to the journal data we've received from the primary.
Return Value:
|
static |
Default system name for the local system, it returned the value of $SYSTEM.
But if the length is greater than MaxMirrorSYSLen (32) then it returned a null string.
|
static |
Stop dejournaling a database on a backup or on an async.
mirror member.
Dejournaling is restarted when the system is restarted or when the <method>CatchupDB</method> is used to restore the missing data to the database and link it into the active journaling system. It is not an error to call this on a database which is requires catchup or if the journaling system is shut down.
|
static |
Demotes the other failover member to a DR async member.
The other failover member does not need to be running, but its agent must be available. This fails if the other failover member is primary.
|
static |
On a connected backup or async member this returns an indication of how up to date the active databases are with respect to the journal data we've received from the primary.
Return Value:
|
static |
On a connected backup or async member this returns an indication of how up to date the node is with respect to retrieving journal data from the current primary.
Return Value:
|
static |
Return mirror failover members' status.
Returned member information in $List format.
It contains $LB(MirrorMemberName,AgentIP,Primary/Backup,Status,MirrorAddress,ECPAddress).
The Status in the list can be:
'Active' - This system is actively involved in mirroring as opposed to being in an initialization or 'Catchup' state.
'Restart' - This system was a mirror and is still starting up. Set when we load the mirror config data and when a backup resets. Cleared during primary/backup init or explicitly by $SYSTEM.Mirror.ResetBackup().
'Trouble' - This backup member is no longer active and won't take over without contacting the other failover system.
'Failover' - This is a backup becoming the new primary because the primary failed. Incoming ECP sessions should be put on hold while in 'Failover' state.
'Recovery' - This is a backup becoming the new primary because the primary failed and we should accept existing ECP sessions but not new ones.
'Deciding' - This system is in the state to decide which failover member can become primary.
'Exit' - The mirroring of this system is shutting down.
'Inactive' - This failover member is not a primary member nor a backup member. 'Catchup' - This system is catching up all mirrored databases with existing mirror journal files.
|
static |
Get the journal position of the primary member so a mirror member could check the latency of its journal file or database with this position.
MirrorSetName: The mirror set name of the primary member.
JournalPosition: Returned journal position of the primary, it will be a null string if it is not success. The returned string conatained MirrorJournalFileCount^JournalOffset^TimeStampOfJournalBlock.
|
static |
IsFailoverReady(allowedDejournalLatency) returns success when called from a failover member.
if the mirror is in a state where the backup should take over if the primary fails, and when dejournaling on the backup is within the specified # of seconds of latency. All of the mirrored databases on the backup which are marked mount required at startup need to be active on the backup and, if the arbiter is configured the mirror must be in arbiter controlled mode.
Returns failure otherwise, including if there is only a single failover member configured.
This method is designed to be used from a failover member in a Mirror montitor to indicate whether the mirror is functioning in its High Availability role. The method can be executed on either failover member. Executing this on an async member or a non-mirror member, returns failure.
If the <parameter>numSecOfDBLatency</parameter> parameter is zero or omitted, the default value of 60 seconds is used. The latency parameter is checked last so if this method returns failure due to the latency being out of range, all of the other checks have passed. Note that the latency is calculated between the end of the journal data the backup has received and the current dejournal checkpoint for journal data restored on the backup. The end of the journal file on the primary can be different. However the backup is marked active so during a failover event, it has all of the journal data it needs to become the primary.
Return Value:
      $LB(1) - success
      $LB(0,<reason text>) - failure
|
static |
Whether the specific mirror set is started or not.
It checked whether the MIRRORMGR master daemon of the specific mirror set is running or not.
MirrorName needs to be specified and it has to be a non null value for this method.
Returned 1 if the specific mirror set is started, otherwise returned 0.
|
static |
Method to join an existing mirror set as an async member.
The target member should be
a failover member. This method makes the local system as an async member in the mirror set. If this member has been setup as an async member then it could be used to add a mirror set to its tracking list.
Input Parameters:
|
static |
Method to join an existing mirror set as a failover member.
The target member should be
the only failover member in the mirror set. This method makes the local system as the second failover member in the mirror set.
If UseSSL is not set in the configuration then this method will automatically ask the primary to add this new failover member to its configuration. So users don't need to call <method>AddFailoverMember</method> method in the primary member to add this member in. Input Parameters:
|
static |
On a connected backup or async member this returns an indication of how up to date the node is with respect to retrieving journal data from the current primary in time (seconds)
Return Value:
|
static |
Set or get default value for how many days the mirror journal files are kept for non-failover/async nodes to connect and sync with failover members.
If no param specified, the current value is returned.
Note: this parameter applies to failover members only.
|
static |
Promotes this DR async member to a failover member for use in normal planned cutover scenarios.
The current primary is automatically selected as its failover partner. If there is no current primary, then the member that was most recently primary is automatically selected as the failover partner. The other failover member, if any, is automatically demoted to DR async.
Returns an error if this member cannot contact the agents of any of the failover members, or if this member is not a DR async member.
If this method returns an error ($$$FailoverNoAgent) due to one or more failover members being unavailable, <parameter>UnavailableMembers</parameter> will be non-null and contain a comma-delimited list of the member names which could not be contacted.
This method returns an error ($$$NeedVIPInterface) if the Virtual IP address is configured for the mirror but this member does not have a network interface defined for it in its configuration. To avoid this error, if using Virtual IP, use <CLASS>Config.MirrorMember</CLASS> to set the VirtualAddressInterface property with the interface name supporting the virtual IP. If there is no network interface supporting the virtual IP, and you wish to promote it anyway, set the VirtualAddressInterface to "NoMatchedSubnet", and this member becomes primary, it will skip acquiring the virtual IP.
|
static |
Similar to <METHOD>Promote</METHOD>, check whether it can successfully promote this DR async member to a failover member for use in normal planned cutover scenarios.
It won't actually promote this DR memebr.
This method returns $$$OK instead of an error ($$$FailoverNoAgent) due to one or more failover members being unavailable, <parameter>UnavailableMembers</parameter> will be non-null and contain a comma-delimited list of the member names which could not be contacted.
If all failover members are reachable, the value of Partner will be set with either current primary member or the member that was most recently primary.
This method returns an error ($$$NeedVIPInterface) if the Virtual IP address is configured for the mirror but this member does not have a network interface defined for it in its configuration. To avoid this error, if using Virtual IP, use <CLASS>Config.MirrorMember</CLASS> to set the VirtualAddressInterface property with the interface name supporting the virtual IP. If there is no network interface supporting the virtual IP, and you wish to promote it anyway, set the VirtualAddressInterface to "NoMatchedSubnet", and this member becomes primary, it will skip acquiring the virtual IP.
|
static |
Promotes this DR async member to a failover member for use in unplanned disaster situations where there are no functioning failover member.
This member becomes the only failover member and will become primary without requiring any additional journal data from the former failover members. WARNING: This can result in the loss of some global update operations, and the other mirror members may need to be rebuilt.
If a running primary is found, this method returns error.
This member attempts to automatically demote the other failover member(s) to DR Async. IMPORTANT: On success, <Parameter>UnavailableMembers</Parameter> will contain a comma-delimited list of the failover member names that could not be automatically demoted. Before you restart those unavailable members, you must manually edit their .cpf configuration files, and in the [MirrorMember] section set ValidatedMember=0. Failure to do so could result in having two primary members running simultaneously.
If <Parameter>Flags</Parameter> = 1, then the mirror is set into "no failover" mode and this member will wait for it to be cleared before becoming primary.
This method returns an error ($$$NeedVIPInterface) if the Virtual IP address is configured for the mirror but this member does not have a network interface defined for it in its configuration. To avoid this error, if using Virtual IP, use <CLASS>Config.MirrorMember</CLASS> to set the VirtualAddressInterface property with the interface name supporting the virtual IP. If there is no network interface supporting the virtual IP, and you wish to promote it anyway, set the VirtualAddressInterface to "NoMatchedSubnet", and this member becomes primary, it will skip acquiring the virtual IP.
|
static |
Similar to <METHOD>Promote</METHOD>, promotes this DR async member to a failover member, automatically identifying the correct failover partner and returning error if the partner cannot be identified.
The difference is that this method succeeds even if the member to be demoted (the one that is not to be the failover partner) cannot be contacted for demotion. In this case, it will return success with non-null <Parameter>UnavailableMembers</Parameter>.
IMPORTANT: On success, check the value of <Parameter>UnavailableMembers</Parameter>. If non-null, it contains the name of the failover member that could not be automatically demoted. Before you restart that member, you must manually edit its .cpf configuration file, and in the [MirrorMember] section set ValidatedMember=0. Failure to do so could result in having two primary members running simultaneously.
This method returns an error ($$$FailoverNoAgent) upon failure to contact a failover member's agent that is required for this operation. In that case, <Parameter>UnavailableMembers</Parameter> will be non-null and contain a comma-delimited list of the failover member names which could not be contacted. Unlike the success case, however, no changes were made to the mirror configuration and there is no need to manipulate the configuration file of the unavailable members.
This method returns an error ($$$NeedVIPInterface) if the Virtual IP address is configured for the mirror but this member does not have a network interface defined for it in its configuration. To avoid this error, if using Virtual IP, use <CLASS>Config.MirrorMember</CLASS> to set the VirtualAddressInterface property with the interface name supporting the virtual IP. If there is no network interface supporting the virtual IP, and you wish to promote it anyway, set the VirtualAddressInterface to "NoMatchedSubnet", and this member becomes primary, it will skip acquiring the virtual IP.
|
static |
Promotes this DR async member to a failover member for use in unplanned disaster situations where there is no functioning primary,.
but a failover member is available from which this member should retrieve journals before becoming primary. This member becomes a failover member with the member name specified in the <Parameter>Partner</Parameter> as its failover partner. WARNING: If the partner specified does not have the most recent journal data in the mirror (e.g. because it was not the most recent primary), then this can result in the loss of some global update operations, and the other mirror members may need to be rebuilt. The other failover member, if any, is automatically demoted to DR Async.
IMPORTANT: On success, <Parameter>UnavailableMembers</Parameter> will contain a comma-delimited list of the failover member names whose configuration could not be automatically updated. Before you restart those unavailable members, you must manually edit their .cpf configuration file, and in the [MirrorMember] section set ValidatedMember=0. Failure to do so could result in having two primary members running simultaneously.
This method returns an error ($$$NeedVIPInterface) if the Virtual IP address is configured for the mirror but this member does not have a network interface defined for it in its configuration. To avoid this error, if using Virtual IP, use <CLASS>Config.MirrorMember</CLASS> to set the VirtualAddressInterface property with the interface name supporting the virtual IP. If there is no network interface supporting the virtual IP, and you wish to promote it anyway, set the VirtualAddressInterface to "NoMatchedSubnet", and this member becomes primary, it will skip acquiring the virtual IP.
|
static |
Optionally purges and returns information on mirror journal files which were/can be
purged because they are no longer required by the mirrored databases on this, or by other mirror members.
Called from the purge routine in ^JRNUTIL when journal files are purged to see if we can remove the mirror journal files corresponding to the same criteria (e.g. a date, a backup, a filename, etc). Calling this method directly bypasses the consideration of subsystems outside of mirroring (eg. backups) which may require older journal files than are required to support mirroring.
A journal file is eligible to be purged if it is not required on this node for transaction rollback or journal restore and we have sent the journal file to the other failover members or we can determine that they do not require it. For reporting async members we only keep the journal files they require if they have connected within a certain time frame specified by the <parameter>maxdisconnecttime</parameter> parameter.
Input Parameters:
Output Parameters:
|
static |
Remove an entry from the PendingDNUpdates or PendingNewMembers list.
Input Parameters:
|
static |
Remove the whole mirror configuration.
Input Parameters:
This method is not allowed to be called when the system is a primary mirror member.
|
static |
Remove a database from the mirror
Updates a database so that it is no longer considered part of a mirror so that it can be mounted read/write on any InterSystems IRIS instance (eg. not just the primary member of the mirror it was a part of).
Typically used in cases where a mirrored database is moved to a non-mirror member or when a mirror member is removed from the mirror and the former mirrored databases need to be mounted read/write.
|
static |
Remove the one specific mirror set from configuration.
Input Parameters:
This method is not allowed to be called when the system is a primary mirror member.
When this method is called in failover member, it worked like <Method>RemoveMirrorConfiguration</Method> method with 'CleanSSL' cleared.
When this method is called in async member, the '[MirrorMember]' setion of the configuration won't be changed.
|
static |
Set 'no failover' state for the mirror set.
This function prevents this mirror set from failover when primary is shutdown or crashed.
It reaches out the other failover member (if exist) to notify it to set 'no failover' state.
Only failover member can call this function.
The 'MirrorSetName' is the name of the mirror set, if can be null for the current mirror set.
This method returns all detected errors if there is any.
|
static |
Activate and startup a mirror.
When MirrorName is null it must be a initial startup. Otherwise it is a restart. Returns $$$ERROR(reason) if we fail to startup the mirror. Otherwise returns $$$OK.
|
static |
Shutdown a mirror.
Only Backup or Reporting node could be shutdown. Primary node Shutdown is not allowed.
When MirrorName is null it will shutdown all mirrors for Reporting node. The Timeout is time (in seconds) to wait on the shutdown to be completed. Returns $$$ERROR(reason) if we fail to stop the mirror. Otherwise returns $$$OK.
|
static |
Method to create or modify Mirror SSL configuration which includes MirrorServer and MirrorClient.
SSL configurations. Input Parameters:
|
static |
Modify Mirror UseSSL configuration.
Input Parameters:
Only primary member can call this query.
On non-primary members, users should create mirror SSL configurations before setting UseSSL in primary member.
You can't disbale UseSSL when journal ecnryption is enabled.
For non-primary members, their UseSSL will be updated when they connect to primary member, they will get Config.Mirrors configuration from primary and update local Config.Mirrors. Also before calling this method, users should make sure the MirrorServer and MirrorClient SSL configurations were created if 'Enable' is set to 1. To create mirror SSL configurations users can call <method>UpdateMirrorSSL</method> to create new or update existing SSL configurations.
|
static |
Verifiy mirror SSL certificates against all mirror members or between all members.
Input Parameters:
This method returns all detected errors if there is any.
|
static |
This class contains the public interface (unless otherwise noted) to the Mirroring subsystem.
It contains methods that return information and provide control for customer scripts.
This class can only be used by programs running in SYS. <class>SYSTEM.Mirror</class> contains public methods which can be called by programs running in any namespace.
Default Localization Domain
1.9.1