Class CIM_FileSystemReplicationServiceCapabilities
extends CIM_Capabilities

A subclass of Capabilities that defines the Capabilities of a ReplicationService. An instance of FileSystemReplicationServiceCapabilities is associated with a ReplicationService using ElementCapabilities.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_Capabilities
   |
   +--CIM_FileSystemReplicationServiceCapabilities

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA subclass of Capabilities that defines the Capabilities of a ReplicationService. An instance of FileSystemReplicationServiceCapabilities is associated with a ReplicationService using ElementCapabilities.
UMLPackagePathstringCIM::Device::StorageServices
Versionstring2.45.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
SupportedAsynchronousActionsuint16[]
DescriptionstringEnumeration indicating what operations will be executed as asynchronous jobs. If an operation is included in both this and SupportedSynchronousActions properties then the underlying implementation is indicating that it may or may not create a job. Note: the following methods are not supported asynchronously, hence the gap between 11 and 19: - CreateGroup - DeleteGroup - AddMembers - RemoveMembers - AddReplicationEntity - AddServiceAccessPoint - AddSharedSecret.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedSynchronousActions
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 19, 20, 21, 22, 23, 24, 25, .., 0x8000..
ValuesstringCreateElementReplica, CreateGroupReplica, CreateSynchronizationAspect, ModifyReplicaSynchronization, ModifyListSynchronization, ModifySettingsDefineState, GetAvailableTargetElements, GetPeerSystems, GetReplicationRelationships, GetServiceAccessPoints, CreateListReplica, CreateGroupReplicaFromElements, GetReplicationRelationshipInstances, ModifyListSettingsDefineState, CreateRemoteReplicationCollection, AddToRemoteReplicationCollection, RemoveFromRemoteReplicationCollection, DMTF Reserved, Vendor Specific
SupportedReplicationTypesuint16[]
DescriptionstringEnumeration indicating the supported SyncType/Mode/Local-or-Remote combinations.
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, .., 0x8000..
ValuesstringSynchronous Mirror Local, Asynchronous Mirror Local, Synchronous Mirror Remote, Asynchronous Mirror Remote, Synchronous Snapshot Local, Asynchronous Snapshot Local, Synchronous Snapshot Remote, Asynchronous Snapshot Remote, Synchronous Clone Local, Asynchronous Clone Local, Synchronous Clone Remote, Asynchronous Clone Remote, DMTF Reserved, Vendor Specific
SupportedStorageObjectsuint16[]
DescriptionstringEnumeration indicating the supported storage objects.
ValueMapstring2, 3, .., 0x8000..
ValuesstringFileSystem, ReplicationEntity, DMTF Reserved, Vendor Specific
SupportedSynchronousActionsuint16[]
DescriptionstringEnumeration indicating what operations will be executed synchronously -- without the creation of a job. If an operation is included in both this property and SupportedAsynchronousActions then the underlying implementation is indicating that it may or may not create a job.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedAsynchronousActions
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, .., 0x8000..
ValuesstringCreateElementReplica, CreateGroupReplica, CreateSynchronizationAspect, ModifyReplicaSynchronization, ModifyListSynchronization, ModifySettingsDefineState, GetAvailableTargetElements, GetPeerSystems, GetReplicationRelationships, GetServiceAccessPoints, CreateGroup, DeleteGroup, AddMembers, RemoveMembers, AddReplicationEntity, AddServiceAccessPoint, AddSharedSecret, CreateListReplica, CreateGroupReplicaFromElements, GetReplicationRelationshipInstances, ModifyListSettingsDefineState, CreateRemoteReplicationCollection, AddToRemoteReplicationCollection, RemoveFromRemoteReplicationCollection, DMTF Reserved, Vendor Specific

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
DescriptionstringCIM_ManagedElement
ElementNamestringCIM_Capabilities
Generationuint64CIM_ManagedElement
InstanceIDstringCIM_Capabilities

Class Methods

Local Class Methods

ConvertSyncTypeToReplicationType (uint32)

Method Qualifiers (ConvertSyncTypeToReplicationType)

NameData TypeValue
DescriptionstringThe majority of the methods in this class accept ReplicationType which represents a combination of SyncType, Mode, Local/Remote. This method accepts the supplied information and returns the corresponding ReplicationType, which can be passed to other methods to get the additional capabilities.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (ConvertSyncTypeToReplicationType)

NameTypeQualifiers
NameData TypeValue
LocalOrRemoteuint16
DescriptionstringCopy to local or remote replica.
ValueMapstring2, 3, .., 0x8000..
ValuesstringLocal, Remote, DMTF Reserved, Vendor Specific
Modeuint16
DescriptionstringMode describes whether the target elements will be updated synchronously or asynchronously.
ModelCorrespondencestringCIM_Synchronized.Mode
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
SupportedReplicationTypesuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
Outbooleantrue
SyncTypeuint16
DescriptionstringSyncType describes the type of copy. Mirror: create and maintain a copy of the source. Snapshot: create a PIT, virtual copy of the source. Clone: create an unsynchronized copy of the source.
ModelCorrespondencestringCIM_Synchronized.SyncType
ValueMapstring6, 7, 8, .., 0x8000..
ValuesstringMirror, Snapshot, Clone, DMTF Reserved, Vendor Specific

ConvertReplicationTypeToSyncType (uint32)

Method Qualifiers (ConvertReplicationTypeToSyncType)

NameData TypeValue
DescriptionstringThis method does the opposite of the method ConvertSyncTypeToReplicationType. This method translates ReplicationType to the corresponding SyncType, Mode, Local/Remote.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (ConvertReplicationTypeToSyncType)

NameTypeQualifiers
NameData TypeValue
LocalOrRemoteuint16
DescriptionstringCopy to local or remote replica.
Outbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringLocal, Remote, DMTF Reserved, Vendor Specific
Modeuint16
DescriptionstringMode describes whether the target elements will be updated synchronously or asynchronously.
ModelCorrespondencestringCIM_Synchronized.Mode
Outbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SyncTypeuint16
DescriptionstringSyncType describes the type of copy. Mirror: create and maintain a copy of the source. Snapshot: create a PIT, virtual copy of the source. Clone: create an unsynchronized copy of the source.
ModelCorrespondencestringCIM_Synchronized.SyncType
Outbooleantrue
ValueMapstring6, 7, 8, .., 0x8000..
ValuesstringMirror, Snapshot, Clone, DMTF Reserved, Vendor Specific

GetSupportedCopyStates (uint32)

Method Qualifiers (GetSupportedCopyStates)

NameData TypeValue
DescriptionstringThis method for a given ReplicationType returns the supported CopyStates and a parallel array to indicate for a given CopyState the target element is host accessible or not.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedCopyStates)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
HostAccessibleboolean[]
DescriptionstringA parallel array to SupportedCopyStates[] to indicate whether in that CopyState the target element is host accessible or not (true or false)
Outbooleantrue
SupportedCopyStatesuint16[]
DescriptionstringSupported Copy States.
ModelCorrespondencestringCIM_Synchronized.CopyState
Outbooleantrue

GetSupportedGroupCopyStates (uint32)

Method Qualifiers (GetSupportedGroupCopyStates)

NameData TypeValue
DescriptionstringThis method, for a given ReplicationType, returns the supported replication group CopyStates.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedGroupCopyStates)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SupportedCopyStatesuint16[]
DescriptionstringSupported Copy States.
ModelCorrespondencestringCIM_Synchronized.CopyState
Outbooleantrue

GetSupportedWaitForCopyStates (uint32)

Method Qualifiers (GetSupportedWaitForCopyStates)

NameData TypeValue
DescriptionstringThis method, for a given ReplicationType and method, returns the supported CopyStates that can be specified in the method's WaitForCopyState parameter.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedWaitForCopyStates)

NameTypeQualifiers
NameData TypeValue
MethodNameuint16
DescriptionstringA value representing the desired method name.
ValueMapstring2, 3, 4, 5, 6, .., 0x8000..
ValuesstringCreateElementReplica, CreateGroupReplica, ModifyFileSystemSynchronization, ModifyListSynchronization, ModifySettingsDefineState, DMTF Reserved, Vendor Specific
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SupportedCopyStatesuint16[]
DescriptionstringSupported Copy States.
ModelCorrespondencestringCIM_Synchronized.CopyState
Outbooleantrue

GetSupportedFeatures (uint32)

Method Qualifiers (GetSupportedFeatures)

NameData TypeValue
DescriptionstringThis method, for a given ReplicationType, returns the supported features.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedFeatures)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
Featuresuint16[]
DescriptionstringAn array of Supported Features. Replication Groups: Element in a group are supported in a replication operation. Multi-hop element replication: Target of one copy operation can at the same time be the source of another copy operation. Multi-hop elements must have same SyncType: The SyncType of each hop must be the same as previous hop, e.g., mirror, snapshot, clone. Multi-hop requires advance notice: The service needs to know when multi-hoping is intended to allow the service to do the appropriate set up. The parameter ReplicationSettingData specified number of hops intended. Requires full discovery of target ComputerSystem: Target element's containing computer system must be known to the provider. Service suspends source I/O when necessary: Applies to a group of elements when a consistent point-in-time is created. Targets allocated from Any storage pool: No restriction as to what storage pool to use to allocate targets elements, as long as the pool is not reserved for special activities. Targets allocated from Shared storage pool: Targets areallocated from a shared pool for all targets of the same type. Targets allocated from Exclusive storage pool: Targets are allocated from a pool that is exclusive. Targets allocated from Multiple storage pools: Targets are allocated from multiple pools. Targets require reserved elements: Targets must have a specific Usage value. Target is associated to SynchronizationAspect: Target is associated via SettingsDefineState association to an instance of SynchronizationAspect. Source is associated to SynchronizationAspect: Source is associated via SettingsDefineState association to an instance of SynchronizationAspect. Error recovery from Broken state Automatic: Once the connection is repaired, the copy operation continues automatically. Target must remain associated to source: A dependent target element must remain associated to source element at all times. Remote resource requires remote CIMOM: Client is required to interact with two providers: the provider controlling the source element and the provider controlling the target element. Synchronized clone target detaches automatically: The clone target element detaches automatically when the target element becomes synchronized; otherwise, the client needs to explicitly request a detach operation. Reverse Roles operation requires Read Only source: The Reverse Roles operation requires the source element to be in the Read Only mode. Reverse Roles operation requires resync: After the Reverse Roles operation completed, it is required to resync the synchronization relationship between the source and the target elements. Restore operation requires fracture: The copy operation has completed; however, the synchronization relationship must be fractured. Resync operation requires activate: For the copy operation to continue, the synchronization relationship must be activated. Copy operation requires offline source: Instrumentation requires the source element to be offline (not-ready) to ensure data does not change before starting the copy operation. Adjustable CopyPriority: Priority of copy operation versus the host I/O can be adjusted. Source requires reserved element: Source element must have a Usage value that indicates the element may be a "Replica Source". Supports undiscovered resources: The service can perform copy operations to and from elements, e.g. a "ReplicationEntity", on a ComputerSystem not known to the service.
Outbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, .., 32768..
ValuesstringReplication groups, Multi-hop element replication, Multi-hop elements must have same SyncType, Multi-hop requires advance notice, Requires full discovery of target ComputerSystem, Service suspends source I/O when necessary, Targets allocated from Any storage pool, Targets allocated from Shared storage pool, Targets allocated from Exclusive storage pool, Targets allocated from Multiple storage pools, Targets require reserved elements, Target is associated to SynchronizationAspect, Source is associated to SynchronizationAspect, Error recovery from Broken state Automatic, Target must remain associated to source, Remote resource requires remote CIMOM, Synchronized clone target detaches automatically, Reverse Roles operation requires Read Only source, Reverse Roles operation requires resync, Restore operation requires fracture, Resync operation requires activate, Copy operation requires offline source, Adjustable CopyPriority, Source requires reserved element, Supports undiscovered resources, Restore operation requires detach, DMTF Reserved, Vendor Specific

GetSupportedGroupFeatures (uint32)

Method Qualifiers (GetSupportedGroupFeatures)

NameData TypeValue
DescriptionstringThis method, for a given ReplicationType, returns the supported group features.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedGroupFeatures)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
GroupFeaturesuint16[]
DescriptionstringAn array of Supported Features. One-to-many replication: One source element and multiple targets elements in a group. Many-to-many: One or more elements in the source group and one or more elements in the target group. Consistency enabled for all groups: All groups are considered consistent by default. Empty replication groups allowed: A replication group can have zero elements. Source group must have more than one element: A group with only one element is not allowed. Composite Groups: Elements of a group may be from different arrays. Multi-hop group replication: A group that is the target of a copy operation can be the source of another copy operation at the same time. Multi-hop elements must have same SyncType: The SyncType of each hop must be the same as previous hop, e.g., mirror, snapshot, clone. Group can only have one single relationship active: Only one FileSystemSynchronized association within a group can be active at a given time. Source element can be removed from group: A source element can be removed even when the group is associated with another replication group. Target element can be removed from group: A target element can be removed even when the group is associated with another replication group. Group can be temporary: Group can have a persistence of false, which means the group -- not its elements, may be deleted if it no longer participates in a replication operation. Group is nameable: In creating a group, it is possible to name the group. Supports target element count: It is possible to supply one source element and request more than one target element copies. Synchronized clone target detaches automatically: The clone target group detaches automatically when the target group becomes synchronized; otherwise, the client needs to explicitly request a detach operation. Reverse Roles operation requires Read Only source: The Reverse Roles operation requires the source element to be in the Read Only mode. Reverse Roles operation requires resync: For the copy operation to continue, resync of source and target elements is required. Restore operation requires fracture: The copy operation has completed; however, the synchronization relationship must be fractured. Resync operation requires activate: For the copy operation to continue, the synchronization relationship must be activated. Copy operation requires offline source: Instrumentation requires the source element to be offline (not-ready) to ensure data does not change before starting the copy operation.
Outbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, .., 0x8000..
ValuesstringOne-to-many replication, Many-to-many groups, Consistency enabled for all groups, Empty replication groups allowed, Source group must have more than one element, Composite Groups, Multihop element replication, Multi-hop elements must have same SyncType, Group can only have one single relationship active, Source element can be removed from group, Target element can be removed from group, Group can be temporary, Group is nameable, Supports target element count, Synchronized clone target detaches automatically, Reverse Roles operation requires Read Only source, Reverse Roles operation requires resync, Restore operation requires fracture, Resync operation requires activate, Copy operation requires offline source, Restore operation requires detach, Element can be member of multiple groups, Elements of group can be mix of thin and thick, DMTF Reserved, Vendor Specific

GetSupportedConsistency (uint32)

Method Qualifiers (GetSupportedConsistency)

NameData TypeValue
DescriptionstringThis method for a given ReplicationType returns the supported Consistency.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedConsistency)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SupportedConsistencyuint16[]
DescriptionstringAn array of Supported Features. Sequentially Consistent: Members of a target group are sequentially consistent - the order of the write operations is maintained.
Outbooleantrue
ValueMapstring2, .., 0x8000..
ValuesstringSequentially Consistent, DMTF Reserved, Vendor Specific

GetSupportedOperations (uint32)

Method Qualifiers (GetSupportedOperations)

NameData TypeValue
DescriptionstringThis method for a given ReplicationType returns the supported Operations on a FileSystemSynchronized association that can be supplied to the ModifyReplicaSynchronization method.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedOperations)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SupportedOperationsuint16[]
DescriptionstringAn array of Supported Operations. Abort: Abort the copy operation if it is possible. Activate Consistency: Ensure all target elements of a group are consistent. Activate: Activate an inactive or prepared source and target association. AddSyncPair: Add elements associated via FileSystemSynchronized to source and target groups. Deactivate Consistency: Disable consistency. Deactivate: Deactivate a source and target association. The writes to the target are deleted in the case of a snapshot. Detach: Remove the association between source and target. Dissolve: Dissolve the synchronization between two storage objects, however, the target element continues to exist. Failover: Switch to target element instead of source. Failback: Reverses the effects of failover. Fracture: Separate target element from source element. RemoveSyncPair: Remove pair of source and target elements from the source/target groups. Resync Replica: Synchronize a fractured/split source and target elements. Restore from Replica: Copy data from a fractured target back to source. Resume: Continue an association that was suspended. Reset To Sync: Change mode to synchronous. Reset To Async: Change mode to asynchronous. Reverse Roles: Make target the source and source the target. Return To ResourcePool: Applies to Snapshot -- delete the target element and its replication association. Split: Similar to Fracture, however, the provider needs to make sure whether there are pending I/O in transit before fracturing the connection. Suspend: Stop the copy operations to the target element. Continue when the operations is resumed. Unprepare: Causes the synchronization to be reinitialized and stop in Prepared state.
Outbooleantrue
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

GetSupportedGroupOperations (uint32)

Method Qualifiers (GetSupportedGroupOperations)

NameData TypeValue
DescriptionstringThis method for a given ReplicationType returns the supported Operations on a FileSystemGroupSynchronized association that can be supplied to the ModifyReplicaSynchronization method.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedGroupOperations)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SupportedGroupOperationsuint16[]
DescriptionstringAn array of Supported group Operations. Abort: Abort the copy operation if it is possible. Activate Consistency: Ensure all target elements of a group are consistent. Activate: Activate an inactive or prepared source and target association. AddSyncPair: Add elements associated via FileSystemSynchronized to source and target groups. Deactivate Consistency: Disable consistency. Deactivate: Deactives a source and target association. The writes to the target are deleted in the case of a snapshot. Detach: Remove the association between source and target. Dissolve: Dissolve the synchronization between two storage objects, however, the target element continues to exist. Failover: Switch to target element instead of source. Failback: Reverses the effects of failover. Fracture: Separate target element from source element. RemoveSyncPair: Remove pair of source and target elements from the source/target groups. Resync Replica: Synchronize a fractured/split source and target elements. Restore from Replica: Copy data from a fractured target back to source. Resume: Continue an association that was suspended. Reset To Sync: Change mode to synchronous. Reset To Async: Change mode to asynchronous. Reverse Roles: Make target the source and source the target. Return To ResourcePool: Applies to Snapshot -- delete the target element and its replication association. Split: Similar to Fracture, however, the provider needs to make sure wether there are pending I/O in transit before fracturing the connection. Suspend: Stop the copy operations to the target element. Continue when the operations is resumed. Unprepare: Causes the synchronization to be reinitialized and stop in Prepared state.
Outbooleantrue
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

GetSupportedListOperations (uint32)

Method Qualifiers (GetSupportedListOperations)

NameData TypeValue
DescriptionstringThis method for a given ReplicationType returns the supported Operations on a list of FileSystemSynchronized or FileSystemGroupSynchronized associations that can be supplied to the ModifyListSynchronization method.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedListOperations)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SynchronizationTypeuint16
DescriptionstringSpecifies the supported operations as they apply to a list of FileSystemSynchronized or GroupSynchronized. If this parameter is not specified, FileSystemSynchronized is assumed.
ValueMapstring2, 3, 4, 5, .., 0x8000..
ValuesstringFileSystemSynchronized, FileSystemGroupSynchronized, ReplicationEntitySynchronized, ReplicationEntityGroupSynchronized, DMTF Reserved, Vendor Specific
SupportedListOperationsuint16[]
DescriptionstringAn array of Supported group Operations. Abort: Abort the copy operation if it is possible. Activate: Activate an inactive or prepared source and target association. Deactivate: Deactivate a source and target association. The writes to the target are deleted in the case of a snapshot. Detach: Remove the association between source and target. Dissolve: Dissolve the synchronization between two storage objects, however, the target element continues to exist. Failover: Switch to target element instead of source. Failback: Reverses the effects of failover. Fracture: Separate target element from source element. Resync Replica: Synchronize a fractured/split source and target elements. Restore from Replica: Copy data from a fractured target back to source. Resume: Continue an association that was suspended. Reset To Sync: Change mode to synchronous. Reset To Async: Change mode to asynchronous. Reverse Roles: Make target the source and source the target. Return To ResourcePool: Applies to Snapshot -- delete the target element and its replication association. Split: Similar to Fracture, however, the provider needs to make sure wether there are pending I/O in transit before fracturing the connection. Suspend: Stop the copy operations to the target element. Continue when the operations is resumed. Unprepare: Causes the synchronization to be reinitialized and stop in Prepared state.
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

GetSupportedSettingsDefineStateOperations (uint32)

Method Qualifiers (GetSupportedSettingsDefineStateOperations)

NameData TypeValue
DescriptionstringThis method for a given ReplicationType returns the supported Operations on a SettingsDefineState association that can be supplied to the ModifySettingsDefineState method.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedSettingsDefineStateOperations)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SupportedOperationsuint16[]
DescriptionstringAn array of supported Operations. /nActivate Consistency: Enable consistency Deactivate Consistency: Disable consistency Delete: Remove the SettingsDefineState association. Instance of SynchronizationAspect may also be deleted if it is not shared with other elements. Copy To Target: Introduces the target elements and forms the necessary associations between the source and the target elements i.e. FileSystemSynchronized and GroupSynchronized.
Outbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, .., 0x8000..0xFFFF
ValuesstringActivate Consistency, Deactivate Consistency, Delete, Copy To Target, Detach, Restore, DMTF Reserved, Vendor Specific

GetSupportedThinProvisioningFeatures (uint32)

Method Qualifiers (GetSupportedThinProvisioningFeatures)

NameData TypeValue
DescriptionstringThis method for a given ReplicationType returns the supported features related to thin provisioning.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedThinProvisioningFeatures)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SupportedThinProvisioningFeaturesuint16[]
DescriptionstringAn array of Supported Thin Provisioning Features. Thin provisioning is not supported: Feature is unavailable. Zeros written in unused allocated blocks of target: In copying thin to full, the unused blocks of target will be written with zeros. Unused allocated blocks of target are not initialized: In copying thin to full, the unused blocks of target will remain uninitialized. See the property ReplicationSettingData.ThinProvisioningPolicy for a list of possible options for a copy operation.
ModelCorrespondencestringCIM_ReplicationSettingData.ThinProvisioningPolicy
Outbooleantrue
ValueMapstring1, 2, 3, .., 0x8000..
ValuesstringThin provisioning is not supported, Zeros written in unused allocated blocks of target, Unused allocated blocks of target are not initialized, DMTF Reserved, Vendor Specific

GetSupportedMaximum (uint32)

Method Qualifiers (GetSupportedMaximum)

NameData TypeValue
DescriptionstringThis method accepts a ReplicationType and a component, it then returns a static numeric value representing the maximum number of the specified component that the service supports. A value of 0 indicates unlimited components of the given type. In all cases the maximum value is bound by the availability of resources on the computer system. Effectively, the method informs clients of the edge conditions.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, Information is not available, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedMaximum)

NameTypeQualifiers
NameData TypeValue
Componentuint16
DescriptionstringFor the given Mirror, Snapshot, Clone and their mode and locality variations as specified by ReplicationType, this parameter represents one of the following components: Number of groups: Maximum number of groups supported by the replication service.Number of elements per source group: Maximum number of elements in a group that can be used as a source group. Number of elements per target group: Maximum number of elements in a group that can be used as a target group. Number of target elements per source element: Maximum number of target elements per source element. Number of total source elements: Maximum number of total source elements supported by the service. Number of total target elements: Maximum number of total target elements supported by the source. Number of peer systems: Maximum number of peer systems that replication service can communicate with. Number of hops in multi-hop replication: Maximum number of hops in multi-hop replication the service can manage.
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, .., 0x8000..
ValuesstringNumber of groups, Number of elements per source group, Number of elements per target group, Number of target elements per source element, Number of total source elements, Number of total target elements, Number of peer systems, Number of hops in multi-hop copy, DMTF Reserved, Vendor Specific
MaxValueuint16
DescriptionstringThe maximum value, or 0 if the maximum is unlimited.
Outbooleantrue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes

GetDefaultConsistency (uint32)

Method Qualifiers (GetDefaultConsistency)

NameData TypeValue
Descriptionstringod for a given ReplicationType, returns the default consistency value.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetDefaultConsistency)

NameTypeQualifiers
NameData TypeValue
DefaultConsistencyuint16
DescriptionstringDefault consistency value, or 0 if there is no default value.
Outbooleantrue
ValueMapstring0, 1, 2, .., 0x8000..
ValuesstringNo default consistency, DMTF Reserved, Sequentially Consistent, DMTF Reserved, Vendor Specific
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes

GetDefaultGroupPersistency (uint32)

Method Qualifiers (GetDefaultGroupPersistency)

NameData TypeValue
DescriptionstringThis method returns the default persistency for a newly created group.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetDefaultGroupPersistency)

NameTypeQualifiers
NameData TypeValue
DefaultGroupPersistencyuint16
DescriptionstringDefault group persistency value.
Outbooleantrue
ValueMapstring0, 1, 2, 3, .., 0x8000..
ValuesstringNo default persistency, DMTF Reserved, Persistent, Not Persistent, DMTF Reserved, Vendor Specific

GetSupportedReplicationSettingData (uint32)

Method Qualifiers (GetSupportedReplicationSettingData)

NameData TypeValue
DescriptionstringThis method, for a given ReplicationType and a supplied property, returns an array of supported settings that can be utilized in an instance of the ReplicationSettingData class.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedReplicationSettingData)

NameTypeQualifiers
NameData TypeValue
PropertyNameuint16
DescriptionstringA value representing the property name.
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, .., 0x8000..
ValuesstringConsistentPointInTime, DesiredCopyMethodology, Multihop, OnGroupOrListError, UnequalGroupsAction, TargetElementSupplier, ThinProvisioningPolicy, Pairing, FailedCopyStopsHostIO, CopyRecoveryMode, UnequalListsAction, DeltaUpdateInterval, DeltaUpdateBlocks, ReadOnly, StorageCompressionPolicy, TargetElementResourcePool, TargetElementGoal, RRCSoftwareCompressionEnabled, RRCHardwareCompressionEnabled, DMTF Reserved, Vendor Specific
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SupportedValuesuint64[]
DescriptionstringAn array containing the supported values that can be supplied in an instance of a ReplicationSettingData. Refer to the class ReplicationSettingData for the possible values for each property. For boolean data, use the following data mapping: 2="false", 3="true". For datetime data, use the following data mapping: 0="property is supported", 1="property is not supported".
Inbooleanfalse
ModelCorrespondencestringCIM_ReplicationSettingData.ConsistentPointInTime, CIM_ReplicationSettingData.DesiredCopyMethodology, CIM_ReplicationSettingData.Multihop, CIM_ReplicationSettingData.OnGroupOrListError, CIM_ReplicationSettingData.Pairing, CIM_ReplicationSettingData.UnequalGroupsAction, CIM_ReplicationSettingData.TargetElementSupplier, CIM_ReplicationSettingData.ThinProvisioningPolicy, CIM_ReplicationSettingData.FailedCopyStopsHostIO, CIM_ReplicationSettingData.CopyRecoveryMode, CIM_ReplicationSettingData.UnequalListsAction, CIM_ReplicationSettingData.DeltaUpdateInterval, CIM_ReplicationSettingData.DeltaUpdateBlocks, CIM_ReplicationSettingData.ReadOnly, CIM_ReplicationSettingData.StorageCompressionPolicy, CIM_ReplicationSettingData.TargetElementResourcePool, CIM_ReplicationSettingData.TargetElementGoal, CIM_ReplicationSettingData.RRCSoftwareCompressionEnabled, CIM_ReplicationSettingData.RRCHardwareCompressionEnabled, CIM_ReplicationSettingData.AutoDelete, CIM_ReplicationSettingData.TimeBeforeRemoval
Outbooleantrue

GetDefaultReplicationSettingData (uint32)

Method Qualifiers (GetDefaultReplicationSettingData)

NameData TypeValue
DescriptionstringThis method for a given ReplicationType returns the default ReplicationSettingData as an instance.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, No default ReplicationSettingData, DMTF Reserved, Vendor Specific

Method Parameters (GetDefaultReplicationSettingData)

NameTypeQualifiers
NameData TypeValue
DefaultInstancestring
DescriptionstringA copy of the instance this populated with default values for the given ReplicationType.
EmbeddedInstancestringCIM_ReplicationSettingData
Outbooleantrue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes

GetSupportedConnectionFeatures (uint32)

Method Qualifiers (GetSupportedConnectionFeatures)

NameData TypeValue
DescriptionstringThis method accepts a connection reference and returns specific features of that connection.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedConnectionFeatures)

NameTypeQualifiers
NameData TypeValue
SupportedConnectionFeaturesuint16[]
DescriptionstringAn array supported connection features. Unidirectional to ServiceAccessPoint: Data flow is unidirectional to ServiceAccessPoint such as a protocol end point. Unidirectional from ServiceAccessPoint: Data flow is unidirectional from ServiceAccessPoint such as a protocol end point.
Outbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringUnidirectional to ServiceAccessPoint, Unidirectional from ServiceAccessPoint, DMTF Reserved, Vendor Specific
connection REF CIM_ServiceAccessPoint
DescriptionstringA value representing the connection.

GetSynchronizationSupported (uint32)

Method Qualifiers (GetSynchronizationSupported)

NameData TypeValue
DescriptionstringFor the supplied element, this method returns the supported synchronization operations in a series of parallel output arrays.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSynchronizationSupported)

NameTypeQualifiers
NameData TypeValue
MethodNameuint16
DescriptionstringA value representing the desired method name.
ValueMapstring2, 3, 4, .., 0x8000..
ValuesstringCreateElementReplica, CreateGroupReplica, CreateSynchronizationAspect, DMTF Reserved, Vendor Specific
ReplicationSettingDatastring
DescriptionstringIf provided, it overrides the default replication setting data for the given SyncType. For example, the intended CopyMethodology can be specified to determine if the copy operation is supported for the given source and target elements.
EmbeddedInstancestringCIM_ReplicationSettingData
LocalElementRoleuint16[]
DescriptionstringAn array that specifies whether the local element can be the source or the target element of the copy operations. Possible values are: SystemElement: the source element. SyncedElement: the target element. These designations correspond to the keys of the Synchronized association.
Outbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringSystemElement, SyncedElement, DMTF Reserved, Vendor Specific
Modesuint16[]
DescriptionstringAn array of supported Modes for the copy operations using the supplied element.
ModelCorrespondencestringCIM_Synchronized.Mode
Outbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringSynchronous, Asynchronous, DMTF Reserved, Vendor Specific
SyncTypesuint16[]
DescriptionstringAn array of supported SyncTypes for the copy operations using the supplied element.
ModelCorrespondencestringCIM_Synchronized.SyncType
Outbooleantrue
ValueMapstring6, 7, 8, .., 0x8000..
ValuesstringMirror, Snapshot, Clone, DMTF Reserved, Vendor Specific
LocalElement REF CIM_ManagedElement
DescriptionstringA reference to the supplied element. For example, the source element.
OtherElement REF CIM_ManagedElement
DescriptionstringA reference to the other end of the synchronization association. For example, the target element. OtherElement can be a local or a remote element.
OtherElementAccessPoint REF CIM_ServiceAccessPoint
Descriptionstringerence to the access point instance to allow the service to access the OtherElement. If NULL, it is assumed the service does not need any access information or the element is local.

GetSupportedStorageCompressionFeatures (uint32)

Method Qualifiers (GetSupportedStorageCompressionFeatures)

NameData TypeValue
DescriptionstringThis method for a given ReplicationType returns the supported features related to storage compression.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (GetSupportedStorageCompressionFeatures)

NameTypeQualifiers
NameData TypeValue
ReplicationTypeuint16
DescriptionstringA value representing the ReplicationType.
ModelCorrespondencestringCIM_FileSystemReplicationServiceCapabilities.SupportedReplicationTypes
SupportedStorageCompressionFeaturesuint16[]
DescriptionstringAn array of supported Storage Compression Features.
ModelCorrespondencestringCIM_ReplicationSettingData.StorageCompressionPolicy
Outbooleantrue
ValueMapstring1, 2, 3, 4, 5, 6, 7, .., 0x8000..
ValuesstringStorage compression is not supported, Compressed source to compressed target, Compressed source to uncompressed target, Uncompressed source to compressed target, Compression of target same as source, Target pool decides compression of target element, Implementation decides compression of target, DMTF Reserved, Vendor specific

Inherited Class Methods

NameReturn TypeClass Origin
CreateGoalSettingsuint16CIM_Capabilities