Class CIM_ReplicationService
extends CIM_Service

The ReplicationService class provides methods to allow a client to manage copy operations on storage objects, including management of replication groups, manipulation of replication operations, and retrieval of replication relationships.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_ReplicationService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe ReplicationService class provides methods to allow a client to manage copy operations on storage objects, including management of replication groups, manipulation of replication operations, and retrieval of replication relationships.
Experimentalbooleantrue
UMLPackagePathstringCIM::Device::StorageServices
Versionstring2.39.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateGroup (uint32)

Method Qualifiers (CreateGroup)

NameData TypeValue
DescriptionstringCreate a new replication group.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Groups are not nameable, DMTF Reserved, Vendor Specific

Method Parameters (CreateGroup)

NameTypeQualifiers
NameData TypeValue
DeleteOnEmptyElementboolean
DescriptionstringIf true and empty groups are allowed, the group will be deleted when the last element is removed from the group. If empty groups are not allowed, the group will be deleted automatically when the group becomes empty. If this parameter is not NULL, its value will be used to set the group's DeleteOnEmptyElement property. Use the intrinsic method ModifyInstance to change this property after the group is created.
INbooleantrue
DeleteOnUnassociatedboolean
DescriptionstringIf true, the group will be deleted when the group is no longer associated with another group. This can happen if all synchronization associations to the individual elements of the group are dissolved. If this parameter is not NULL, its value will be used to set the group's DeleteOnUnassociated property. Use the intrinsic method ModifyInstance to change this property after the group is created.
INbooleantrue
GroupNamestring
DescriptionstringIf nameable, an end user relevant name for the group being created. If NULL or not nameable, then system assigns a name.
INbooleantrue
Persistentboolean
DescriptionstringIf false, the group, not the elements associated with the group, may be deleted at the completion of a copy operation. Use the intrinsic method ModifyInstance to change Persistencyof a group.
INbooleantrue
ReplicationSettingDatastring
DescriptionstringIf supplied, it provides additional replication settings for the method. For example, to supply the "Description" for the created group.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
MembersCIM_LogicalElement[]
DescriptionstringList of elements to add to the group -- order is maintained. If NULL, the group will be empty -- if empty groups are supported.
INbooleantrue
ReplicationGroup REF CIM_ReplicationGroup
DescriptionstringReference to the created group.
INbooleanfalse
OUTbooleantrue
ServiceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to access point information to allow the service to create a group on a remote system. If NULL, the group is created on the local system.
INbooleantrue

DeleteGroup (uint32)

Method Qualifiers (DeleteGroup)

NameData TypeValue
DescriptionstringDelete a replication group.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, One or more elements in a replication relationship, DMTF Reserved, Vendor Specific

Method Parameters (DeleteGroup)

NameTypeQualifiers
NameData TypeValue
RemoveElementsboolean
DescriptionstringDelete the group even if it is not empty. If one or more elements in the group are in a replication relationship, RemoveElements has no effect.
INbooleantrue
ReplicationSettingDatastring
DescriptionstringIf supplied, it provides additional replication settings for the method. For example, what should happen OnGroupOrListError.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
ReplicationGroup REF CIM_ReplicationGroup
DescriptionstringReference to a replication group.
INbooleantrue
Requiredbooleantrue
ServiceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to access point information to allow the service to delete the group on a remote system.
INbooleantrue

AddMembers (uint32)

Method Qualifiers (AddMembers)

NameData TypeValue
DescriptionstringAdd members to an existing replication group.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Group does not exist, DMTF Reserved, Vendor Specific

Method Parameters (AddMembers)

NameTypeQualifiers
NameData TypeValue
ReplicationSettingDatastring
DescriptionstringIf supplied, it provides additional replication settings for the method. For example, what should happen OnGroupOrListError.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
MembersCIM_LogicalElement[]
DescriptionstringList of elements to add to the group. New members are added, in the order supplied, to the end of the existing members of the group. It is not an error, if a new member is already in the group.
INbooleantrue
ReplicationGroup REF CIM_ReplicationGroup
DescriptionstringReference to an existing replication group.
INbooleantrue
Requiredbooleantrue
ServiceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to access point information to allow the service to access the group on a remote system.
INbooleantrue

RemoveMembers (uint32)

Method Qualifiers (RemoveMembers)

NameData TypeValue
DescriptionstringRemove members from a replication group.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Group does not exist, Member not in group, DMTF Reserved, Vendor Specific

Method Parameters (RemoveMembers)

NameTypeQualifiers
NameData TypeValue
DeleteOnEmptyElementboolean
DescriptionstringIf true and removal of the members causes the group to become empty, the group will be deleted. Note, if empty groups are not allowed, the group will be deleted automatically when the group becomes empty. If this parameter is not NULL, it overrides the group's property DeleteOnEmptyElement.
INbooleantrue
ReplicationSettingDatastring
DescriptionstringIf supplied, it provides additional replication settings for the method. For example, what should happen OnGroupOrListError.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
MembersCIM_LogicalElement[]
DescriptionstringList of elements to remove from a group. A member can not be removed if it is in a replication relationship. Deleting all members of a group is equivalent to deleting the group if empty groups are not supported by the implementation.
INbooleantrue
ReplicationGroup REF CIM_ReplicationGroup
DescriptionstringReference to an existing replication group.
INbooleantrue
Requiredbooleantrue
ServiceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to access point information to allow the service to access the group on a remote system.
INbooleantrue

CreateElementReplica (uint32)

Method Qualifiers (CreateElementReplica)

NameData TypeValue
DescriptionstringCreate (or start a job to create) a new storage object, which is a replica of the specified source storage object (SourceElement). Note that using the input parameter, SyncType, this function can be used to instantiate the replica, and to create an ongoing association between the source and replica. If 0 is returned, the function completed successfully and no ConcreteJob instance created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateElementReplica)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringA end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element.
INbooleantrue
Modeuint16
DescriptionstringMode describes whether the target elements will be updated synchronously or asynchronously. If NULL, implementaton decides the mode.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.Mode
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
SyncTypeuint16
DescriptionstringSyncType describes the type of copy that will be made.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.SyncType
Requiredbooleantrue
ValueMapstring.., 6, 7, 8, 9, .., 0x8000..
ValuesstringDMTF Reserved, Mirror, Snapshot, Clone, TokenizedClone, DMTF Reserved, Vendor Specific
WaitForCopyStateuint16
DescriptionstringMethod must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. For example, Initialized: Associations have been established, but there is no data flow. Inactive: Initialization is complete, but the data flow remains idle until it is activated. Synchronized: Replicas are an exact copy of the source. UnSynchronized: Copy operation is in progress.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
ConnectivityCollection REF CIM_ConnectivityCollection
DescriptionstringReference to the ConnectivityCollection - for example, a RemoteReplicationCollection. Since a RemoteReplicationCollection aggregates the ProtocolEndpoints that provide the paths to a remote system, generally, it is not necessary to supply both the ConnectivityCollection and the ServiceAccessPoint.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
SourceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to source access point information. If NULL, service does not need access information to access the source element.
INbooleantrue
SourceElement REF CIM_LogicalElement
DescriptionstringThe source storage object which may be a StorageVolume or other storage objects.
INbooleantrue
Requiredbooleantrue
Synchronization REF CIM_Synchronized
DescriptionstringReference to the created association between the source and the target element. If a job is created, this parameter may be NULL unless the association is actually formed.
INbooleanfalse
OUTbooleantrue
TargetAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to target access point information. If NULL, service does not need access information to access the target elements.
INbooleantrue
TargetElement REF CIM_LogicalElement
DescriptionstringOptionally, as an input, refers to a target element to use. As an output, refers to the created target storage element (i.e., the replica). If a job is created, the target element may not be available immediately.
INbooleantrue
OUTbooleantrue
TargetPool REF CIM_ResourcePool
DescriptionstringThe underlying storage for the target element (the replica) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific. If a target element is supplied, this parameter shall be NULL.
INbooleantrue
TargetSettingGoal REF CIM_SettingData
DescriptionstringThe definition for the SettingData to be maintained by the target storage object (the replica). If a target element is supplied, this parameter shall be NULL.
INbooleantrue

CreateGroupReplica (uint32)

Method Qualifiers (CreateGroupReplica)

NameData TypeValue
DescriptionstringCreate (or start a job to create) a new group of storage objects which are replicas of the specified source storage or a group of source storage objects (SourceElements). Note that using the input parameter, SyncType, this function can be used to instantiate the replicas, and to create an ongoing association between the source(s) and replicas. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateGroupReplica)

NameTypeQualifiers
NameData TypeValue
Consistencyuint16
DescriptionstringOverrides the default group consistency.
INbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringNo Consistency, Sequential Consistency, DMTF Reserved, Vendor Specific
Modeuint16
DescriptionstringMode describes whether the target elements will be updated synchronously or asynchronously. If NULL, implementaton decides the mode.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.Mode
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
RelationshipNamestring
DescriptionstringA user relevant name for the relationship between the source and target groups or between a source element and a target group (i.e. one-to-many). If NULL, the implementation assigns a name. If the individual target elements require an ElementName, the implementation constructs an appropriate ElementName using the RelationshipName. For example, RelationshipName as a prefix followed by "_n" sequence number, where n is a number beginning with 1.
INbooleantrue
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
SyncTypeuint16
DescriptionstringSyncType describes the type of copy that will be made.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.SyncType
Requiredbooleantrue
ValueMapstring.., 6, 7, 8, 9, .., 0x8000..
ValuesstringDMTF Reserved, Mirror, Snapshot, Clone, TokenizedClone, DMTF Reserved, Vendor Specific
TargetElementCountuint64
DescriptionstringThis parameter applies to one-source-to-many-target- elements. It is possible to create multiple copies of a source element. If TargetGroup is supplied, this parameter shall be NULL.
INbooleantrue
WaitForCopyStateuint16
DescriptionstringMethod must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. For example, Initialized: Associations have been established, but there is no data flow. Inactive: Initialization is complete, but the data flow remains idle until it is activated. Synchronized: Replicas are an exact copy of the source. UnSynchronized: Copy operation is in progress.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
ConnectivityCollection REF CIM_ConnectivityCollection
DescriptionstringReference to the ConnectivityCollection - for example, a RemoteReplicationCollection. Since a RemoteReplicationCollection aggregates the ProtocolEndpoints that provide the paths to a remote system, generally, it is not necessary to supply both the ConnectivityCollection and the ServiceAccessPoint.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
SourceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to source access point information. If NULL, service does not need access information to access the source element.
INbooleantrue
SourceElement REF CIM_LogicalElement
DescriptionstringThe source storage object which may be a StorageVolume or other storage objects. If this parameter is not supplied, SourceGroup is required. Both SourceGroup and SourceElement shall not be supplied.
INbooleantrue
SourceGroup REF CIM_ReplicationGroup
DescriptionstringA group of source storage objects which may be one or more StorageVolumes or other storage objects. If this parameter is not supplied, SourceElement is required. Both SourceGroup and SourceElement shall not be supplied.
INbooleantrue
Synchronization REF CIM_Synchronized
DescriptionstringReference to the created group association between the source and the target elements. If a job is created, this parameter may be NULL until the association is actually formed.
INbooleanfalse
OUTbooleantrue
TargetAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to target access point information. If NULL, service does not need access information to access the target element/group.
INbooleantrue
TargetGroup REF CIM_ReplicationGroup
DescriptionstringOptionally, as an input, refers to a target group to use. As an output, refers to the created target group (i.e., the replica group). If a job is created, the target group may not be available immediately. If TargetGroup is supplied, TargetElementCount shall be NULL.
INbooleantrue
OUTbooleantrue
TargetPool REF CIM_ResourcePool
DescriptionstringThe underlying storage for the target elements (the replicas) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific. If target elements are supplied, this parameter shall be NULL.
INbooleantrue
TargetSettingGoal REF CIM_SettingData
DescriptionstringThe definition for the SettingData to be maintained by the target storage objects (the replicas). If target elements are supplied, this parameter shall be NULL.
INbooleantrue

CreateSynchronizationAspect (uint32)

Method Qualifiers (CreateSynchronizationAspect)

NameData TypeValue
DescriptionstringCreate (or start a job to create) a new point-in-time representation of a source element. This representation may be of a form of pointers that keep track of data at the time the point-in-time was created, or a series checkpoints that capture the view of data on the source elements at the time of point-in-time. This method does not include a target element, however, a target element can be added subsequently using the ModifySettingsDefineState method. If the method executes successfully, a SettingsDefineState association is created between the source element and the SynchronizationAspect, which will have the datetime of the point-in-time.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateSynchronizationAspect)

NameTypeQualifiers
NameData TypeValue
Consistencyuint16
DescriptionstringOverrides the default group consistency.
INbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringNo Consistency, Sequential Consistency, DMTF Reserved, Vendor Specific
Modeuint16
DescriptionstringMode describes whether the target elements will be updated synchronously or asynchronously. If NULL, implementaton decides the mode.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.Mode
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
Namestring
DescriptionstringA end user relevant name for the element or relationship being created. If NULL, then a system supplied default name can be used. The value will be stored in the ElementName or relationship name depending on whether an element is created or a group.
INbooleantrue
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
SyncTypeuint16
DescriptionstringSyncType describes the type of copy that will be made.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.SyncType
Requiredbooleantrue
ValueMapstring.., 6, 7, 8, 9, .., 0x8000..
ValuesstringDMTF Reserved, Mirror, Snapshot, Clone, TokenizedClone, DMTF Reserved, Vendor Specific
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
SettingsState REF CIM_SettingsDefineState
DescriptionstringReference to the created association between the source element or group and an instance of SynchronizationAspect. If a job is created, this parameter may be NULL unless the association is actually formed.
INbooleanfalse
OUTbooleantrue
SourceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to source access point information. If NULL, service does not need access information to access the source element/group.
INbooleantrue
SourceElement REF CIM_ManagedElement
DescriptionstringThe source storage object which may be a StorageVolume or other storage objects. If this parameter is not supplied, SourceGroup is required. Both SourceGroup and SourceElement shall not be supplied.
INbooleantrue
SourceGroup REF CIM_ReplicationGroup
DescriptionstringA group of source storage objects which may be one or more StorageVolumes or other storage objects. If this parameter is not supplied, SourceElement is required. Both SourceGroup and SourceElement shall not be supplied.
INbooleantrue

ModifyReplicaSynchronization (uint32)

Method Qualifiers (ModifyReplicaSynchronization)

NameData TypeValue
DescriptionstringModify (or start a job to modify) the synchronization association between two storage objects or replication groups. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 0x1000 is returned, a ConcreteJob was started and a reference to this Job is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyReplicaSynchronization)

NameTypeQualifiers
NameData TypeValue
Forceboolean
DescriptionstringSome operations may cause an inconsistency among the target elements. If true, the client is not warned and the operation is performed.
INbooleantrue
Operationuint16
DescriptionstringOperation describes the type of modification to be made to the replica and/or to the related associations. Abort: Abort the copy operation if it is possible. Activate Consistency: if consistency was not requested when CreateGroupReplica was called. If Consistency is already active, no modification is made. Activate: Activate an inactive or prepared Synchronized association. AddSyncPair: Add pairs of elements already in a relationship to source and target groups -- see SyncPair parameter. Deactivate Consistency: Deactivate consistency. If consistency was not enabled, this operation has no effect. Deactivate: Stop the data flow. Writes to source element are not copied to target. For Snapshots, writes to target are lost as the pointers to changed data are deleted. Detach: 'Forget' the synchronization between two storage objects. Start to treat the objects as independent. Dissolve: Dissolve the synchronization between two storage objects, however, the target element continues to exist. Failover: Use the target element as the source elements. Failback: Reverse the effect of failback. Fracture: Suspend the synchronization between two storage objects. The association and (typically) changes are remembered to allow a fast resynchronization. This may be used during a backup cycle to allow one of the objects to be copied while the other remains in production. RemoveSyncPair: Remove the pair associated via StorageSynchronized from the source and target groups. The pair continue to remain associated but not in the groups. Resync Replica: Re-establish the synchronization. This will negate the action of a previous Fracture/Split operation. Recreate a Point In Time image for a Snapshot or a Clone replication. Restart a Broken or Aborted synchronization relationship. Restore from Replica: Renew the contents of the original storage object from a replica. Resume: Continue the copy operation of a suspended association. Reset To Sync: Change the Mode of the copy operation to Synchronous (e.g., from the Asynchronous Mode). Reset To Async: Change the Mode of the copy operation to Asynchronous (e.g., from the Synchronous Mode). Return to ResourcePool: Dissolve a snapshot and free up its space back to the storage pool. Reverse Roles: Source element becomes the target element and vise versa. Split: Same as Fracture, however steps are taken to ensure the target elements are consistent. For example, stop I/O to source elements, wait for in-transit copy operations between source and target elements to stop, then instantly split source/target groups/elements. Suspend: Stop the background copy previously started. Unprepare: Causes the synchronization to be reinitialized.
INbooleantrue
Requiredbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, .., 0x8000..0xFFFF
ValuesstringAbort, Activate Consistency, Activate, AddSyncPair, Deactivate Consistency, Deactivate, Detach, Dissolve, Failover, Failback, Fracture, RemoveSyncPair, Resync Replica, Restore from Replica, Resume, Reset To Sync, Reset To Async, Return To ResourcePool, Reverse Roles, Split, Suspend, Unprepare, DMTF Reserved, Vendor Specific
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
WaitForCopyStateuint16
DescriptionstringMethod must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. For example, Initialized: Associations have been established, but there is no data flow. Inactive: Initialization is complete, but the data flow remains idle until it is activated. Synchronized: Replicas are an exact copy of the source. UnSynchronized: Copy operation is in progress. Fractured/Split: Target elements are separated from the source elements. Etc.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
SyncPairCIM_StorageSynchronized[]
DescriptionstringThis parameter applies to AddSyncPair/RemoveSyncPair Operations.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if the task completed).
INbooleanfalse
OUTbooleantrue
SettingsState REF CIM_SettingsDefineState
DescriptionstringReference to the association between the source element and an instance of SynchronizationAspect. This parameters applies to operations such as Dissolve, which dissolves the Synchronized relationship, but causes the SettingDefineState association to be created.
INbooleanfalse
OUTbooleantrue
Synchronization REF CIM_Synchronized
DescriptionstringThe reference to the replication association describing the elements/groups relationship.
INbooleantrue
Requiredbooleantrue

ModifyListSynchronization (uint32)

Method Qualifiers (ModifyListSynchronization)

NameData TypeValue
DescriptionstringModify (or start a job to modify) an array of synchronization associations between two storage objects or replication groups. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 4096 is returned, a ConcreteJob was started and a reference to this Job is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyListSynchronization)

NameTypeQualifiers
NameData TypeValue
Forceboolean
DescriptionstringSome operations may cause an inconsistency among the target elements. If true, the client is not warned and the operation is performed.
INbooleantrue
Operationuint16
DescriptionstringOperation describes the type of modification to be made to the replica and/or to the related associations. Abort: Abort the copy operation if it is possible. Activate: Activate an inactive or prepared Synchronized association. Deactivate: Stop the data flow. Writes to source element are not copied to target. For Snapshots, writes to target are lost as the pointers to changed data are deleted. Detach: 'Forget' the synchronization between two storage objects. Start to treat the objects as independent. Dissolve: Dissolve the synchronization between two storage objects, however, the target element continues to exist. Failover: Use the target element as the source elements. Failback: Reverse the effect of failback. Fracture: Suspend the synchronization between two storage objects using Mirror or Snapshot replication. The association and (typically) changes are remembered to allow a fast resynchronization. This may be used during a backup cycle to allow one of the objects to be copied while the other remains in production. Resync Replica: Re-establish the synchronization. This will negate the action of a previous Fracture/Split operation. Recreate a Point In Time image for a Snapshot or a Clone replication. Restart a Broken or Aborted synchronization relationship. Restore from Replica: Renew the contents of the original storage object from a replica. Resume: Continue the copy operation of a suspended association. Reset To Sync: Change the Mode of the copy operations to Synchronous (e.g., from the Asynchronous Mode). Reset To Async: Change the Mode of the copy operations to Asynchronous (e.g., from the Synchronous Mode). Return to ResourcePool: Dissolve a snapshot and free up its space back to the storage pool. Reverse Roles: Source element becomes the target element and vise versa. Split: Same as Fracture, however steps are taken to ensure the target elements are consistent. For example, stop I/O to source elements, wait for in-transit copy operations between source and target elements to stop, then instantly split source/target groups/elements. Suspend: Stop the background copy previously started. Unprepare: Causes the synchronization to be reinitialized.
INbooleantrue
Requiredbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, .., 0x8000..0xFFFF
ValuesstringAbort, DMTF Reserved, Activate, DMTF Reserved, DMTF Reserved, Deactivate, Detach, Dissolve, Failover, Failback, Fracture, DMTF Reserved, Resync Replica, Restore from Replica, Resume, Reset To Sync, Reset To Async, Return To ResourcePool, Reverse Roles, Split, Suspend, Unprepare, DMTF Reserved, Vendor Specific
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
WaitForCopyStateuint16
DescriptionstringMethod must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. For example, Initialized: Associations have been established, but there is no data flow. Inactive: Initialization is complete, but the data flow remains idle until it is activated. Synchronized: Replicas are an exact copy of the source. UnSynchronized: Copy operation is in progress. Fractured/Split: Target elements are separated from the source elements. Etc.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
SettingsStateCIM_SettingsDefineState[]
DescriptionstringReferences to the associations between the source element and an instance of SynchronizationAspect. This parameters applies to operations such as Dissolve, which dissolves the Synchronized relationship, but causes the SettingDefineState association to be created..
INbooleanfalse
OUTbooleantrue
SynchronizationCIM_Synchronized[]
DescriptionstringArray of replication associations describing the elements/groups relationship. All elements of this array shall be the same concrete class, i.e. StorageSynchronized or GroupSynchronized, and shall have the same SyncType, the same Mode, and the Operation must be valid for the ReplicationType -- SyncType, Mode, Local/Remote.
INbooleantrue
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if the task completed).
INbooleanfalse
OUTbooleantrue

ModifySettingsDefineState (uint32)

Method Qualifiers (ModifySettingsDefineState)

NameData TypeValue
DescriptionstringModify (or start a job to modify) the SettingsDefineState association between the storage objects and SynchronizationAspect. The modification could range from introducing the target elements, which creates a new StorageSynchronized association to dissolving the SettingsDefineState association. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 4096/0x1000 is returned, a ConcreteJob was started and a reference to this Job is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifySettingsDefineState)

NameTypeQualifiers
NameData TypeValue
Operationuint16
DescriptionstringOperation describes the type of modification to be made to the related associations. Activate Consistency: if consistency was not requested when CreateSynchronizationAspect was called. If Consistency is already active, no modification is made. Deactivate Consistency: Deactivate consistency. If consistency was not enabled, this operation has no effect. Delete: Remove the SettingsDefineState association. Copy To Target: Introduces the target elements and forms the necessary associations between the source and the target elements i.e. StorageSynchronized and GroupSynchronized. Detach: Removes the association between the SynchronizationAspect and the target element. Restore: Restore the source element from the associated SynchronizationAspect. Attach To Target: Same as Copy To Target except no data is copied.
INbooleantrue
Requiredbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, .., 0x8000..0xFFFF
ValuesstringActivate Consistency, Deactivate Consistency, Delete, Copy To Target, Detach, Restore, Attach To Target, DMTF Reserved, Vendor Specific
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
TargetElementCountuint64
DescriptionstringThis parameter applies to one-source-to-many-target- elements. It is possible to create multiple copies of a source element. If TargetCount is supplied, TargetElement and TargetGroup shall be NULL.
INbooleantrue
WaitForCopyStateuint16
DescriptionstringMethod must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. For example, Initialized: Associations have been established, but there is no data flow. Inactive: Initialization is complete, but the data flow remains idle until it is activated. Synchronized: Replicas are an exact copy of the source. UnSynchronized: Copy operation is in progress. Fractured/Split: Target elements are separated from the source elements. Etc.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if the task completed).
INbooleanfalse
OUTbooleantrue
SettingsState REF CIM_SettingsDefineState
DescriptionstringReference to the association between the source element and an instance of SynchronizationAspect.
INbooleantrue
Requiredbooleantrue
Synchronization REF CIM_Synchronized
DescriptionstringThe reference to the created replication association describing the elements/groups relationship.
INbooleanfalse
OUTbooleantrue
TargetAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to target access point information. If NULL, service does not need access information to access the target elements/group.
INbooleantrue
TargetElement REF CIM_LogicalElement
DescriptionstringOptionally, as an input, refers to a target element to use. If TargetElement is supplied, TargetGroup and TargetCount shall be NULL. As an output, refers to the created target storage element (i.e., the replica). If a job is created, the target element may not be available immediately.
INbooleantrue
OUTbooleantrue
TargetGroup REF CIM_ReplicationGroup
DescriptionstringOptionally, as an input, refers to a target group to use. If TargetGroup is supplied, TargetElement and TargetCount shall be NULL. As an output, refers to the created target group (i.e., the replica group). If a job is created, the target group may not be available immediately. If TargetGroup is supplied, TargetElementCount shall be NULL.
INbooleantrue
OUTbooleantrue
TargetPool REF CIM_ResourcePool
DescriptionstringThe underlying storage for the target element (the replica) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific. If a target element is supplied, this parameter shall be NULL.
INbooleantrue
TargetSettingGoal REF CIM_SettingData
DescriptionstringThe definition for the SettingData to be maintained by the target storage object (the replica). If a target element is supplied, this parameter shall be NULL.
INbooleantrue

GetAvailableTargetElements (uint32)

Method Qualifiers (GetAvailableTargetElements)

NameData TypeValue
DescriptionstringGet (or start a job to get) all of the candidate target elements for the supplied source element. If a job is started, once the job completes, examine the AffectedJobElement associations for candidate targets.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (GetAvailableTargetElements)

NameTypeQualifiers
NameData TypeValue
Modeuint16
DescriptionstringMode describes whether the target elements will be updated synchronously or asynchronously. If NULL, the implementation decides.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.Mode
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
SyncTypeuint16
DescriptionstringSyncType describes the type of copy.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.SyncType
Requiredbooleantrue
ValueMapstring.., 6, 7, 8, 9, .., 0x8000..
ValuesstringDMTF Reserved, Mirror, Snapshot, Clone, TokenizedClone, DMTF Reserved, Vendor Specific
CandidatesCIM_LogicalElement[]
DescriptionstringThe list of the candidate target elements.
OUTbooleantrue
TargetPoolsCIM_ResourcePool[]
DescriptionstringThe storage pools for the target elements. If NULL, all storage pools (on the given system) will be examined.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if the task completed).
INbooleanfalse
OUTbooleantrue
SourceElement REF CIM_LogicalElement
DescriptionstringThe source storage object which may be a StorageVolume or other storage objects.
INbooleantrue
Requiredbooleantrue
TargetAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to access point information. If NULL, only local system is examined.
INbooleantrue
TargetSettingGoal REF CIM_SettingData
DescriptionstringDesired target SettingData. If NULL, settings of the source element will be used.
INbooleantrue

GetPeerSystems (uint32)

Method Qualifiers (GetPeerSystems)

NameData TypeValue
DescriptionstringGet (or start a job to get) all of the peer systems. A peer system is a system that is known and visible to the Replication Service. Peer systems are discovered through discovery services and/or implementation specific services.If a job is started, once the job completes, examine the AffectedJobElement associations for the peer systems.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (GetPeerSystems)

NameTypeQualifiers
NameData TypeValue
Optionsuint16
DescriptionstringThis parameter specifies which peer systems to return. If NULL, all known systems are returned, whether those systems are currently reachable or not.
INbooleantrue
ValueMapstring2, .., 0x8000..
ValuesstringOnly systems currently reachable, DMTF Reserved, Vendor Specific
SystemsCIM_ComputerSystem[]
DescriptionstringList of peer ComputerSystems.
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if the task completed).
INbooleanfalse
OUTbooleantrue

GetReplicationRelationships (uint32)

Method Qualifiers (GetReplicationRelationships)

NameData TypeValue
DescriptionstringGet (or start a job to get) all of the synchronization relationships known to the processing replication service. If a job is started, once the job completes, examine the AffectedJobElement associations for the synchronization relationships.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (GetReplicationRelationships)

NameTypeQualifiers
NameData TypeValue
CopyStateuint16
DescriptionstringOnly retrieve synchronization relationships that are currently in this CopyState. If this parameter is not supplied, relationships are retrieved regardless of their current CopyState.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
Localityuint16
DescriptionstringDescribes the desired locality. If this parameter is not supplied, all replication relationships are retrieved, regardless of the locality of elements. Local only: Source and target elements are contained in the same system. Remote only: Source and target elements are contained in two different systems.
INbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringLocal only, Remote only, DMTF Reserved, Vendor Specific
Modeuint16
DescriptionstringDescribes the desired mode. If this parameter is not supplied, both synchronous and asynchronous modes are retrieved.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.Mode
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
SyncTypeuint16
DescriptionstringDescribes the desired synchronization type. If this parameter is not specified, all SyncType are retrieved.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.SyncType
ValueMapstring.., 6, 7, 8, 9, .., 0x8000..
ValuesstringDMTF Reserved, Mirror, Snapshot, Clone, TokenizedClone, DMTF Reserved, Vendor Specific
Typeuint16
DescriptionstringThe type of synchronization relationships, for example, StorageSynchronized or GroupSynchronized. If this parameter is not supplied, all such relationships are retrieved.
INbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringStorageSynchronized, GroupSynchronized, DMTF Reserved, Vendor Specific
SynchronizationsCIM_Synchronized[]
DescriptionstringAn array of elements found.
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if the task completed).
INbooleanfalse
OUTbooleantrue

GetServiceAccessPoints (uint32)

Method Qualifiers (GetServiceAccessPoints)

NameData TypeValue
DescriptionstringGet (or start a job to get) ServiceAccessPoints associated with a peer system. If a job is started, once the job completes, examine the AffectedJobElement associations for the peer system's ServiceAccessPoints.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (GetServiceAccessPoints)

NameTypeQualifiers
NameData TypeValue
ServiceAccessPointsCIM_ServiceAccessPoint[]
DescriptionstringList of ServiceAccessPoints for the supplied System.
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if the task completed).
INbooleanfalse
OUTbooleantrue
System REF CIM_ComputerSystem
DescriptionstringThis parameter specifies the peer system.
INbooleantrue
Requiredbooleantrue

AddReplicationEntity (uint32)

Method Qualifiers (AddReplicationEntity)

NameData TypeValue
DescriptionstringIntroduces a new instance of ReplicationEntity in the specified Namespace.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (AddReplicationEntity)

NameTypeQualifiers
NameData TypeValue
InstanceNamespacestring
DescriptionstringNamespace of created instance. If null, created instance will be in the same namespace as the service.
INbooleantrue
Persistentboolean
DescriptionstringIf true, the instance must persist across Management Server reboot. If NULL, the value will be based on the default value of the class in the MOF. Use the intrinsic method ModifyInstance to change the Persistency value.
INbooleantrue
ReplicationEntitystring
EmbeddedInstancestringCIM_ReplicationEntity
INbooleantrue
Requiredbooleantrue
ReplicationEntityPath REF CIM_ReplicationEntity
DescriptionstringReference to the created instance.
OUTbooleantrue

AddServiceAccessPoint (uint32)

Method Qualifiers (AddServiceAccessPoint)

NameData TypeValue
DescriptionstringIntroduces a new instance of a ServiceAccessPoint, or one of its subclasses, for example, a RemoteServiceAccessPoint in the specified namespace.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (AddServiceAccessPoint)

NameTypeQualifiers
NameData TypeValue
InstanceNamespacestring
DescriptionstringNamespace of created instance. If null, created instance will be in the same namespace as the service.
INbooleantrue
ServiceAccessPointstring
EmbeddedInstancestringCIM_ServiceAccessPoint
INbooleantrue
Requiredbooleantrue
ServiceAccessPointPath REF CIM_ServiceAccessPoint
DescriptionstringReference to the created instance.
OUTbooleantrue

AddSharedSecret (uint32)

Method Qualifiers (AddSharedSecret)

NameData TypeValue
DescriptionstringIntroduces a new instance of SharedSecret in the specified namespace and optionally associates it to an instance of a ServiceAccessPoint.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (AddSharedSecret)

NameTypeQualifiers
NameData TypeValue
InstanceNamespacestring
DescriptionstringNamespace of created instance. If null, created instance will be in the same namespace as the the service.
INbooleantrue
SharedSecretstring
EmbeddedInstancestringCIM_SharedSecret
INbooleantrue
Requiredbooleantrue
ServiceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringAssociate created instance to this ServiceAccessPoint. If null, no such association is established.
INbooleantrue
SharedSecretPath REF CIM_SharedSecret
DescriptionstringReference to the created instance.
OUTbooleantrue

CreateListReplica (uint32)

Method Qualifiers (CreateListReplica)

NameData TypeValue
DescriptionstringCreate (or start a job to create) new storage objects, which are replicas of the specified source storage objects (SourceElements). Note that using the input parameter, SyncType, this function can be used to instantiate the replicas, and to create an ongoing association between the source and replica elements. If 0 is returned, the function completed successfully and no ConcreteJob instance created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateListReplica)

NameTypeQualifiers
NameData TypeValue
Modeuint16
DescriptionstringMode describes whether the target elements will be updated synchronously or asynchronously. If NULL, the implementation decides the mode. The same Mode applies to all elements in the list.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.Mode
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the provider uses the default replication setting data. The same ReplicationSettingData applies to all SourceElements entries.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
SyncTypeuint16
DescriptionstringSyncType describes the type of copy that will be made. The same SyncType applies to all elements in the list.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.SyncType
Requiredbooleantrue
ValueMapstring.., 6, 7, 8, 9, .., 0x8000..
ValuesstringDMTF Reserved, Mirror, Snapshot, Clone, TokenizedClone, DMTF Reserved, Vendor Specific
WaitForCopyStateuint16
DescriptionstringMethod must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. For example, Initialized: Associations have been established, but there is no data flow. Inactive: Initialization is complete, but the copy operation remains idle until it is activated. Synchronized: Replicas are an exact copy of the sources. UnSynchronized: Copy operation is in progress. If this parameter is supplied, then all the created replication relationships shall have this supplied CopyState before the method returns.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
ElementNamesstring[]
DescriptionstringAn array of end user relevant names for the elements being created. If NULL, then a system supplied name is used. The value will be stored in the 'ElementName' property for the created element. The first element of the array ElementNames is assigned to the first replica, the second element to the second replica and so on. If there are more SourceElements entries than ElementNames, the system supplied name is used.
INbooleantrue
SourceElementsCIM_LogicalElement[]
DescriptionstringA list of source storage objects which may be StorageVolumes or other storage objects. All the source elements shall be of the same type -- for example, all StorageVolumes.
INbooleantrue
Requiredbooleantrue
SynchronizationsCIM_Synchronized[]
DescriptionstringReference to the created associations between the source and the target elements. If a job is created, this parameter may be NULL unless the associations are actually formed.
INbooleanfalse
OUTbooleantrue
TargetElementsCIM_LogicalElement[]
DescriptionstringOptionally, as an input, refers to the target elements to use. If specified, the elements will match one to one with SourceElements[]. As an output, refers to the created target storage elements (i.e., the replicas). If a job is created, the target elements may not be available immediately.
INbooleantrue
OUTbooleantrue
ConnectivityCollection REF CIM_ConnectivityCollection
DescriptionstringReference to the ConnectivityCollection - for example, a RemoteReplicationCollection. Since a RemoteReplicationCollection aggregates the ProtocolEndpoints that provide the paths to a remote system, generally, it is not necessary to supply both the ConnectivityCollection and the ServiceAccessPoint.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
SourceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to source access point information. If NULL, service does not need access information to access the source element. This parameter applies to all elements in the source list.
INbooleantrue
TargetAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to target access point information. If NULL, service does not need access information to access the target elements. This parameter applies to all elements in the target list.
INbooleantrue
TargetPool REF CIM_ResourcePool
DescriptionstringThe underlying storage for the target elements (the replicas) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific. If the target elements are supplied, this parameter shall be NULL. This parameter applies to all elements in the target list.
INbooleantrue
TargetSettingGoal REF CIM_SettingData
DescriptionstringThe definition for the SettingData to be maintained by the target storage objects (the replicas). If the target elements are supplied, this parameter shall be NULL. This parameter applies to all elements in the target list.
INbooleantrue

CreateGroupReplicaFromElements (uint32)

Method Qualifiers (CreateGroupReplicaFromElements)

NameData TypeValue
DescriptionstringCreate (or start a job to create) new storage objects, which are replicas of the specified source storage objects (SourceElements). Note that using the input parameter, SyncType, this function can be used to instantiate the replicas, and to create an ongoing association between the source and replica elements. If 0 is returned, the function completed successfully and no ConcreteJob instance created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. This method combines the functionality of CreateGroup and CreateGroupReplica, in one call.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateGroupReplicaFromElements)

NameTypeQualifiers
NameData TypeValue
Consistencyuint16
DescriptionstringOverrides the default group consistency.
INbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringNo Consistency, Sequential Consistency, DMTF Reserved, Vendor Specific
Modeuint16
DescriptionstringMode describes whether the target elements will be updated synchronously or asynchronously. If NULL, implementaton decides the mode.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.Mode
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
RelationshipNamestring
DescriptionstringA user relevant name for the relationship between the source and target groups or between a source element and a target group (i.e. one-to-many). If NULL, the implementation assigns a name. If the individual target elements require an ElementName, the implementation constructs an appropriate ElementName using the RelationshipName. For example, RelationshipName as a prefix followed by "_n" sequence number, where n is a number beginning with 1.
INbooleantrue
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
SourceGroupNamestring
DescriptionstringAs in parameter, the name of the group to be created. If the name is not supplied, the implementation may assign a group name and return it in this parameter.
INbooleantrue
OUTbooleantrue
SyncTypeuint16
DescriptionstringSyncType describes the type of copy that will be made.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.SyncType
Requiredbooleantrue
ValueMapstring.., 6, 7, 8, 9, .., 0x8000..
ValuesstringDMTF Reserved, Mirror, Snapshot, Clone, TokenizedClone, DMTF Reserved, Vendor Specific
WaitForCopyStateuint16
DescriptionstringMethod must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. For example, Initialized: Associations have been established, but there is no data flow. Inactive: Initialization is complete, but the data flow remains idle until it is activated. Synchronized: Replicas are an exact copy of the source. UnSynchronized: Copy operation is in progress.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
SourceElementsCIM_LogicalElement[]
DescriptionstringA list of source storage objects which may be StorageVolumes or other storage objects. All the source elements shall be of the same type -- for example, all StorageVolumes.
INbooleantrue
Requiredbooleantrue
ConnectivityCollection REF CIM_ConnectivityCollection
DescriptionstringReference to the ConnectivityCollection - for example, a RemoteReplicationCollection. Since a RemoteReplicationCollection aggregates the ProtocolEndpoints that provide the paths to a remote system, generally, it is not necessary to supply both the ConnectivityCollection and the ServiceAccessPoint.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
SourceAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to source access point information. If NULL, service does not need access information to access the source elements.
INbooleantrue
Synchronization REF CIM_Synchronized
DescriptionstringReference to the created group association between the source and the target elements. If a job is created, this parameter may be NULL until the association is actually formed.
INbooleanfalse
OUTbooleantrue
TargetAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to target access point information. If NULL, service does not need access information to access the target element/group.
INbooleantrue
TargetGroup REF CIM_ReplicationGroup
DescriptionstringOptionally, as an input, refers to a target group to use. As an output, refers to the created target group (i.e., the replica group). If a job is created, the target group may not be available immediately.
INbooleantrue
OUTbooleantrue
TargetPool REF CIM_ResourcePool
DescriptionstringThe underlying storage for the target elements (the replicas) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific. If target elements are supplied, this parameter shall be NULL.
INbooleantrue
TargetSettingGoal REF CIM_SettingData
DescriptionstringThe definition for the SettingData to be maintained by the target storage objects (the replicas). If target elements are supplied, this parameter shall be NULL.
INbooleantrue

GetReplicationRelationshipInstances (uint32)

Method Qualifiers (GetReplicationRelationshipInstances)

NameData TypeValue
DescriptionstringGet (or start a job to get) all of the synchronization relationships known to the processing replication service. If a job is started, once the job completes, examine the AffectedJobElement associations for the synchronization relationships. This method is similar to GetReplicationRelationships, except that this method returns the instances as opposed to object paths.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (GetReplicationRelationshipInstances)

NameTypeQualifiers
NameData TypeValue
CopyStateuint16
DescriptionstringOnly retrieve synchronization relationships that are currently in this CopyState. If this parameter is not supplied, relationships are retrieved regardless of their current CopyState.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
Localityuint16
DescriptionstringDescribes the desired locality. If this parameter is not supplied, all replication relationships are retrieved, regardless of the locality of elements. Local only: Source and target elements are contained in the same system. Remote only: Source and target elements are contained in two different systems.
INbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringLocal only, Remote only, DMTF Reserved, Vendor Specific
Modeuint16
DescriptionstringDescribes the desired mode. If this parameter is not supplied, both synchronous and asynchronous modes are retrieved.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.Mode
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
SyncTypeuint16
DescriptionstringDescribes the desired synchronization type. If this parameter is not specified, all SyncType are retrieved.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.SyncType
ValueMapstring.., 6, 7, 8, 9, .., 0x8000..
ValuesstringDMTF Reserved, Mirror, Snapshot, Clone, TokenizedClone, DMTF Reserved, Vendor Specific
Typeuint16
DescriptionstringThe type of synchronization relationships, for example, StorageSynchronized or GroupSynchronized. If this parameter is not supplied, all such relationships are retrieved.
INbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringStorageSynchronized, GroupSynchronized, DMTF Reserved, Vendor Specific
Synchronizationsstring[]
DescriptionstringAn array of instances found.
EmbeddedInstancestringCIM_Synchronized
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if the task completed).
INbooleanfalse
OUTbooleantrue

ModifyListSettingsDefineState (uint32)

Method Qualifiers (ModifyListSettingsDefineState)

NameData TypeValue
DescriptionstringModify (or start a job to modify) a list of SettingsDefineState associations. These associations are between the storage objects and SynchronizationAspect. The modification could range from introducing the target elements, which creates a new StorageSynchronized association to dissolving the SettingsDefineState association. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 4096/0x1000 is returned, a ConcreteJob was started and a reference to this Job is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyListSettingsDefineState)

NameTypeQualifiers
NameData TypeValue
Operationuint16
DescriptionstringOperation describes the type of modification to be made to the related associations. Activate Consistency: if consistency was not requested when CreateSynchronizationAspect was called. If Consistency is already active, no modification is made. Deactivate Consistency: Deactivate consistency. If consistency was not enabled, this operation has no effect. Delete: Remove the SettingsDefineState association. Copy To Target: Introduces the target elements and forms the necessary associations between the source and the target elements i.e. StorageSynchronized and GroupSynchronized.
INbooleantrue
Requiredbooleantrue
ValueMapstring2, 3, 4, 5, .., 0x8000..0xFFFF
ValuesstringActivate Consistency, Deactivate Consistency, Delete, Copy To Target, DMTF Reserved, Vendor Specific
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
TargetElementCountuint64
DescriptionstringThis parameter applies to one-source-to-many-target elements. It is possible to create multiple copies of a source element. If TargetCount is supplied, TargetElement and TargetGroup shall be NULL.
INbooleantrue
WaitForCopyStateuint16
DescriptionstringMethod must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. For example, Initialized: Associations have been established, but there is no data flow. Inactive: Initialization is complete, but the data flow remains idle until it is activated. Synchronized: Replicas are an exact copy of the source. UnSynchronized: Copy operation is in progress. Fractured/Split: Target elements are separated from the source elements. Etc.
INbooleantrue
ModelCorrespondencestringCIM_Synchronized.CopyState
SettingsStatesCIM_SettingsDefineState[]
DescriptionstringAn array of references to the associations between the source elements and instances of SynchronizationAspect.
INbooleantrue
Requiredbooleantrue
SynchronizationsCIM_Synchronized[]
DescriptionstringThe reference to the created replication associations describing the elements/groups relationship.
INbooleanfalse
OUTbooleantrue
TargetElementsCIM_LogicalElement[]
DescriptionstringOptionally, as an input, refers to a list of target elements to use. If TargetElements are supplied, TargetGroups and TargetCount shall be NULL. As an output, refers to the created target storage elements (i.e., the replicas). If a job is created, the target elements may not be available immediately.
INbooleantrue
OUTbooleantrue
TargetGroupsCIM_ReplicationGroup[]
DescriptionstringOptionally, as an input, refers to a list of target groups to use. If TargetGroups are supplied, TargetElements and TargetCount shall be NULL. As an output, refers to the created target groups (i.e., the replica groups). If a job is created, the target groups may not be available immediately. If TargetGroups are supplied, TargetElementCount shall be NULL.
INbooleantrue
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if the task completed).
INbooleanfalse
OUTbooleantrue
TargetAccessPoint REF CIM_ServiceAccessPoint
DescriptionstringReference to target access point information. If NULL, service does not need access information to access the target elements/group.
INbooleantrue
TargetPool REF CIM_ResourcePool
DescriptionstringThe underlying storage for the target element (the replica) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific. If a target element is supplied, this parameter shall be NULL.
INbooleantrue
TargetSettingGoal REF CIM_SettingData
DescriptionstringThe definition for the SettingData to be maintained by the target storage object (the replica). If a target element is supplied, this parameter shall be NULL.
INbooleantrue

AddToRemoteReplicationCollection (uint32)

Method Qualifiers (AddToRemoteReplicationCollection)

NameData TypeValue
DescriptionstringAdd (or start a job to add) additional service access points (i.e. ProtocolEndpoints) and/or remote systems associations to an existing instance of RemoteReplicationCollection.If 0 is returned, the function completed successfully and no ConcreteJob instance created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. If parameter AccessPoints is NULL, then only the RemoteComputerSystem is added for the existing AccessPoints associated to the RemoteReplicationCollection. If RemoteComputerSystem is NULL, then only AccessPoints are added for the existing remote ComputerSystems known to the RemoteReplicationCollection.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (AddToRemoteReplicationCollection)

NameTypeQualifiers
NameData TypeValue
LocalAccessPointsCIM_ServiceAccessPoint[]
DescriptionstringAn array of references to local ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.
INbooleantrue
RemoteAccessPointsCIM_ServiceAccessPoint[]
DescriptionstringAn array of references to remote ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.
INbooleantrue
ConnectivityCollection REF CIM_ConnectivityCollection
DescriptionstringThe reference to the RemoteReplicationCollection to be expanded.
INbooleantrue
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
RemoteComputerSystem REF CIM_ComputerSystem
DescriptionstringA reference to the remote system.
INbooleantrue

CreateRemoteReplicationCollection (uint32)

Method Qualifiers (CreateRemoteReplicationCollection)

NameData TypeValue
DescriptionstringCreate (or start a job to create) a new instance of RemoteReplicationCollection, and optionally supply the remote system and the paths (i.e. ProtocolEndpoints) that are used to perform replication operations to/from the remote system. If 0 is returned, the function completed successfully and no ConcreteJob instance created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. Once the job completes, examine the AffectedJobElement associations for the created instance of RemoteReplicationCollection.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateRemoteReplicationCollection)

NameTypeQualifiers
NameData TypeValue
Activeboolean
DescriptionstringIf true, the instance of RemoteReplicationCollection will be enabled and allows replication operations to to the remote system. Use the intrinsic method ModifyInstance to change this property after the RemoteReplicationCollection is created.
INbooleantrue
DeleteOnUnassociatedboolean
DescriptionstringIf true, the instance of RemoteReplicationCollection will be deleted when it is no longer associated to a ServiceAccessPoint. Use the intrinsic method ModifyInstance to change this property after the RemoteReplicationCollection is created.
INbooleantrue
ElementNamestring
DescriptionstringA end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element.
INbooleantrue
ReplicationSettingDatastring
DescriptionstringIf supplied, it provides additional replication settings for the method. For example, enable data compression.
EmbeddedInstancestringCIM_ReplicationSettingData
INbooleantrue
LocalAccessPointsCIM_ServiceAccessPoint[]
DescriptionstringAn array of references to local ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.
INbooleantrue
RemoteAccessPointsCIM_ServiceAccessPoint[]
DescriptionstringAn array of references to remote ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.
INbooleantrue
ConnectivityCollection REF CIM_ConnectivityCollection
DescriptionstringReference to the created instance of RemoteReplicationCollection.
INbooleanfalse
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
RemoteComputerSystem REF CIM_ComputerSystem
DescriptionstringA reference to the remote system.
INbooleantrue

RemoveFromRemoteReplicationCollection (uint32)

Method Qualifiers (RemoveFromRemoteReplicationCollection)

NameData TypeValue
DescriptionstringRemove (or start a job to remove) service access points (i.e. ProtocolEndpoints) and/or remote systems associations from an existing instance of RemoteReplicationCollection.If 0 is returned, the function completed successfully and no ConcreteJob instance created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. If parameter AccessPoints is NULL, then only the remote ComputerSystem is removed for the existing AccessPoints associated to the RemoteReplicationCollection. If ComputerSystem is NULL, then only AccessPoints are removed from the existing remote ComputerSystems known to the RemoteReplicationCollection.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (RemoveFromRemoteReplicationCollection)

NameTypeQualifiers
NameData TypeValue
LocalAccessPointsCIM_ServiceAccessPoint[]
DescriptionstringAn array of references to local ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.
INbooleantrue
RemoteAccessPointsCIM_ServiceAccessPoint[]
DescriptionstringAn array of references to remote ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.
INbooleantrue
ConnectivityCollection REF CIM_ConnectivityCollection
DescriptionstringThe reference to the RemoteReplicationCollection to affect.
INbooleantrue
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
RemoteComputerSystem REF CIM_ComputerSystem
DescriptionstringA reference to the remote system to remove.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service