CIM_ReplicationServiceCapabilities class

  • Article

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

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Experimental, Version("2.29.0"), UMLPackagePath("CIM::Device::StorageServices")]
class CIM_ReplicationServiceCapabilities : CIM_Capabilities
{
  string Caption;
  string Description;
  string InstanceID;
  string ElementName;
  uint16 SupportedReplicationTypes[];
  uint16 SupportedStorageObjects[];
  uint16 SupportedAsynchronousActions[];
  uint16 SupportedSynchronousActions[];
};

Members

The CIM_ReplicationServiceCapabilities class has these types of members:

Methods

The CIM_ReplicationServiceCapabilities class has these methods.

Method Description
ConvertReplicationTypeToSyncType This method does the opposite of the method ConvertSyncTypeToReplicationType. This method translates ReplicationType to the corresponding SyncType, Mode, Local/Remote.
ConvertSyncTypeToReplicationType The 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.
GetDefaultConsistency This method for a given ReplicationType, returns the default consistency value.
GetDefaultGroupPersistency This method returns the default persistency for a newly created group.
GetDefaultReplicationSettingData This method for a given ReplicationType returns the default ReplicationSettingData as an instance.
GetSupportedConnectionFeatures This method accepts a connection reference and returns specific features of that connection.
GetSupportedConsistency This method for a given ReplicationType returns the supported Consistency.
GetSupportedCopyStates This 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.
GetSupportedFeatures This method, for a given ReplicationType, returns the supported features.
GetSupportedGroupCopyStates This method, for a given ReplicationType, returns the supported replication group CopyStates.
GetSupportedGroupFeatures This method, for a given ReplicationType, returns the supported group features.
GetSupportedGroupOperations This method for a given ReplicationType returns the supported Operations on a GroupSynchronized association that can be supplied to the ModifyReplicaSynchronization method.
GetSupportedListOperations This method for a given ReplicationType returns the supported Operations on a list of StorageSynchronized or GroupSynchronized associations that can be supplied to the ModifyListSynchronization method.
GetSupportedMaximum This 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.
GetSupportedOperations This method for a given ReplicationType returns the supported Operations on a StorageSynchronized association that can be supplied to the ModifyReplicaSynchronization method.
GetSupportedReplicationSettingData This 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.
GetSupportedSettingsDefineStateOperations This method for a given ReplicationType returns the supported Operations on a SettingsDefineState association that can be supplied to the ModifySettingsDefineState method.
GetSupportedThinProvisioningFeatures This method for a given ReplicationType returns the supported features related to thin provisioning.
GetSupportedWaitForCopyStates This method, for a given ReplicationType and method, returns the supported CopyStates that can be specified in the method's WaitForCopyState parameter.
GetSynchronizationSupported For the supplied element, this method returns the supported synchronization operations in a series of parallel output arrays.

Properties

The CIM_ReplicationServiceCapabilities class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

Description

Data type: string

Access type: Read-only

Contains a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

Qualifiers: Required

The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.)

This property is inherited from CIM_Capabilities.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace. For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.

This property is inherited from CIM_Capabilities.

SupportedAsynchronousActions

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_ReplicationServiceCapabilities.SupportedSynchronousActions")

Enumeration 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: \t - CreateGroup \t - DeleteGroup \t - AddMembers \t - RemoveMembers \t - AddReplicationEntity \t - AddServiceAccessPoint \t - AddSharedSecret.

CreateElementReplica (2)

CreateGroupReplica (3)

CreateSynchronizationAspect (4)

ModifyReplicaSynchronization (5)

ModifyListSynchronization (6)

ModifySettingsDefineState (7)

GetAvailableTargetElements (8)

GetPeerSystems (9)

GetReplicationRelationships (10)

GetServiceAccessPoints (11)

CreateListReplica (19)

CreateGroupReplicaFromElements (20)

GetReplicationRelationshipInstances (21)

ModifyListSettingsDefineState (22)

CreateRemoteReplicationCollection (23)

AddToRemoteReplicationCollection (24)

RemoveFromRemoteReplicationCollection (25)

DMTF Reserved

26 32767

Vendor Specific

32768 65535

SupportedReplicationTypes

Data type: uint16 array

Access type: Read-only

Enumeration indicating the supported SyncType/Mode/Local-or-Remote combinations.

Synchronous Mirror Local (2)

Asynchronous Mirror Local (3)

Synchronous Mirror Remote (4)

Asynchronous Mirror Remote (5)

Synchronous Snapshot Local (6)

Asynchronous Snapshot Local (7)

Synchronous Snapshot Remote (8)

Asynchronous Snapshot Remote (9)

Synchronous Clone Local (10)

Asynchronous Clone Local (11)

Synchronous Clone Remote (12)

Asynchronous Clone Remote (13)

DMTF Reserved

14 32767

Vendor Specific

32768 65535

SupportedStorageObjects

Data type: uint16 array

Access type: Read-only

Enumeration indicating the supported storage objects.

StorageVolume (2)

LogicalDisk (3)

ReplicationEntity (4)

DMTF Reserved

5 32767

Vendor Specific

32768 65535

SupportedSynchronousActions

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_ReplicationServiceCapabilities.SupportedAsynchronousActions")

Enumeration 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.Note: the following methods are not supported asynchronously: \t - CreateGroup \t - DeleteGroup \t - AddMembers \t - RemoveMembers \t - AddReplicationEntity \t - AddServiceAccessPoint \t - AddSharedSecret.

CreateElementReplica (2)

CreateGroupReplica (3)

CreateSynchronizationAspect (4)

ModifyReplicaSynchronization (5)

ModifyListSynchronization (6)

ModifySettingsDefineState (7)

GetAvailableTargetElements (8)

GetPeerSystems (9)

GetReplicationRelationships (10)

GetServiceAccessPoints (11)

CreateGroup (12)

DeleteGroup (13)

AddMembers (14)

RemoveMembers (15)

AddReplicationEntity (16)

AddServiceAccessPoint (17)

AddSharedSecret (18)

CreateListReplica (19)

CreateGroupReplicaFromElements (20)

GetReplicationRelationshipInstances (21)

ModifyListSettingsDefineState (22)

CreateRemoteReplicationCollection (23)

AddToRemoteReplicationCollection (24)

RemoveFromRemoteReplicationCollection (25)

DMTF Reserved

26 32767

Vendor Specific

32768 65535

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012 R2
Namespace
 Root\CIMv2\Storage\iScsiTarget
MOF
SmIscsiTarget.mof
DLL
SMiSCSITargetProv.dll