MSISCSITARGET_StorageReplicationCapabilities class

Defines the replication capabilities of an associated instance of the MSISCSITARGET_StorageConfigurationService class.

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

Syntax

[Static, Version("1.0.0")]
class MSISCSITARGET_StorageReplicationCapabilities : CIM_StorageReplicationCapabilities
{
  string  Caption;
  string  Description;
  string  InstanceID;
  string  ElementName;
  uint16  SupportedSynchronizationType;
  uint16  SupportedAsynchronousActions[];
  uint16  SupportedSynchronousActions[];
  uint16  InitialReplicationState;
  uint16  SupportedSpecializedElements[];
  uint16  SupportedModifyOperations[];
  uint16  ReplicaHostAccessibility;
  uint16  HostAccessibleState[];
  boolean SpaceLimitSupported;
  boolean SpaceReservationSupported;
  boolean LocalMirrorSnapshotSupported;
  boolean RemoteMirrorSnapshotSupported;
  boolean IncrementalDeltasSupported;
  boolean PersistentReplicasSupported;
  boolean BidirectionalConnectionsSupported;
  uint16  MaximumReplicasPerSource;
  uint16  MaximumPortsPerConnection;
  uint16  MaximumConnectionsPerPort;
  uint16  MaximumPeerConnections;
  uint16  MaximumLocalReplicationDepth = 1;
  uint16  MaximumRemoteReplicationDepth = 1;
  uint16  InitialSynchronizationDefault;
  uint16  ReplicationPriorityDefault;
  uint8   LowSpaceWarningThresholdDefault;
  uint8   SpaceLimitWarningThresholdDefault;
  uint16  RemoteReplicationServicePointAccess;
  uint16  AlternateReplicationServicePointAccess;
  uint16  DeltaReplicaPoolAccess;
  uint16  RemoteBufferElementType;
  uint16  RemoteBufferHost;
  uint16  RemoteBufferLocation;
  uint16  RemoteBufferSupported;
  uint16  UseReplicationBufferDefault;
  string  PeerConnectionProtocol;
};

Members

The MSISCSITARGET_StorageReplicationCapabilities class has these types of members:

Properties

The MSISCSITARGET_StorageReplicationCapabilities class has these properties.

AlternateReplicationServicePointAccess

Data type: uint16

Access type: Read-only

Remote replication provides StorageConfigurationService instances for source systems and target systems. A client determines that extrinsic methods of the service should be invoked to one instance or the other based on the value of this property. If the primary instance is unavailable, the provider may indicate an alternate instance. Values: None: no alternate exists. Source: invoke to source element service instance. Target: invoke to target element service instance. Proxy: find and invoke alternate proxy service instance.

This property is inherited from CIM_StorageReplicationCapabilities.

None (2)

Source (3)

Target (4)

Proxy (5)

DMTF Reserved

6 32767

Vendor Specific

32768 65535

BidirectionalConnectionsSupported

Data type: boolean

Access type: Read-only

True indicates peer-to-peer connections are bi-directional. False indicates connections are uni-directional.

This property is inherited from CIM_StorageReplicationCapabilities.

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.

DeltaReplicaPoolAccess

Data type: uint16

Access type: Read-only

DeltaReplicaPool indicates that a specialized pool is required as a container for delta replica elements. Values: Any: delta replicas can be created in any pool. Exclusive: one specialized, exclusive pool must be created for each source element that has associated delta replicas. Shared: one specialized, shared pool must be created to be shared by all source elements with associated delta replicas.

This property is inherited from CIM_StorageReplicationCapabilities.

Any (2)

Exclusive (3)

Shared (4)

DMTF Reserved

5 32767

Vendor Specific

32768 65535

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.

HostAccessibleState

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSynchronized.SyncState")

Lists the replica synchronization states in which the provider allows host access to replicas. Accessibility does not guarantee replica contents are valid or consistent.

This property is inherited from CIM_StorageReplicationCapabilities.

Initialized (2)

Prepare In Progress (3)

Prepared (4)

Resync In Progress (5)

Synchronized (6)

Fracture In Progress (7)

Quiesce In Progress (8)

Quiesced (9)

Restore In Progress (10)

Idle (11)

Broken (12)

Fractured (13)

Frozen (14)

Copy In Progress (15)

DMTF Reserved

16 32767

Vendor Specific

32768 65535

IncrementalDeltasSupported

Data type: boolean

Access type: Read-only

True indicates all delta replicas associated with the same source element can be incrementally dependent. Only the oldest replica in the set may be deleted or resynced.

This property is inherited from CIM_StorageReplicationCapabilities.

InitialReplicationState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageConfigurationService.AttachReplica", "CIM_StorageConfigurationService.AttachOrModifyReplica", "CIM_StorageConfigurationService.CreateReplica")

InitialReplicationState specifies which initial ReplicationState is supported by a particular provider. Values are:

Initialized: The replication relationship is known and unsynchronized, but time required to synchronize may be long.

Prepared: The replication relationship is known and unsynchronized and the time required to synchronize will be short.

Synchronized: The replicas are synchronized.Idle: an UnSyncAssoc replica is ready to manage.

This property is inherited from CIM_StorageReplicationCapabilities.

Initialized (2)

Prepared (3)

Synchronized (4)

Idle (5)

DMTF Reserved

6 32767

Vendor Specific

32768 65535

InitialSynchronizationDefault

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.InitialSynchronization")

Start or do not start background copy when replica is created.

This property is inherited from CIM_StorageReplicationCapabilities.

Not Managed (0)

Start (1)

Do Not Start (2)

DMTF Reserved

3 32767

Vendor Specific

32768 65535

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.

LocalMirrorSnapshotSupported

Data type: boolean

Access type: Read-only

True indicates local mirror can be snapshot source.

This property is inherited from CIM_StorageReplicationCapabilities.

LowSpaceWarningThresholdDefault

Data type: uint8

Access type: Read-only

Qualifiers: Units ("Percentage"), MinValue (0), MaxValue (100), ModelCorrespondence ("CIM_StoragePool.LowSpaceWarningThreshold"), PUnit ("percent")

Warning threshold for generating an indication for RemainingManagedSpace. Value of zero means no warning generated.Triggered when RemainingManagedSpace <= (TotalManagedSpace*LowSpaceWarningThreshold)/100.

This property is inherited from CIM_StorageReplicationCapabilities.

MaximumConnectionsPerPort

Data type: uint16

Access type: Read-only

Maximum number of peer-to-peer connections to which a port maybe assigned.

This property is inherited from CIM_StorageReplicationCapabilities.

MaximumLocalReplicationDepth

Data type: uint16

Access type: Read-only

Maximum local mirror replication depth allowed by this instance of StorageConfigurationService. Value 1 indicates multi-level replication not supported.

This property is inherited from CIM_StorageReplicationCapabilities.

MaximumPeerConnections

Data type: uint16

Access type: Read-only

Maximum number of peer connections supported by this instance of StorageConfigurationService.

This property is inherited from CIM_StorageReplicationCapabilities.

MaximumPortsPerConnection

Data type: uint16

Access type: Read-only

Maximum number of port pairs assigned to a peer-to-peer connection.

This property is inherited from CIM_StorageReplicationCapabilities.

MaximumRemoteReplicationDepth

Data type: uint16

Access type: Read-only

Maximum remote mirror replication depth allowed by this instance of StorageConfigurationService. Value N means that remote replicas can span N linked peer-to-peer connections. Value 1 indicates multi-level replication not supported.

This property is inherited from CIM_StorageReplicationCapabilities.

MaximumReplicasPerSource

Data type: uint16

Access type: Read-only

Maximum number of replicas that can be associated with one source element.

This property is inherited from CIM_StorageReplicationCapabilities.

PeerConnectionProtocol

Data type: string

Access type: Read-only

Peer connection protocol is a private, vendor-specific protocol for replication data transport. A client verifies that two peers support the same protocol before establishing a peer-to-peer connection.

This property is inherited from CIM_StorageReplicationCapabilities.

PersistentReplicasSupported

Data type: boolean

Access type: Read-only

True indicates replicas can persist during power off or system reset. False indicates replicas lost during these events.

This property is inherited from CIM_StorageReplicationCapabilities.

RemoteBufferElementType

Data type: uint16

Access type: Read-only

Remote replication buffer elements are instances of CIM_Memory. A buffer element may be created from a component extent with a BasedOn association or in a storage pool with an AllocatedFromStoragePool association. The provider can also make the size and element type opaque to a client. Values:

Not specified: client allows provider to determine size and container element type.

InExtent: buffer must be created from passed component extent.

InPool: buffer must be created in passed pool.

This property is inherited from CIM_StorageReplicationCapabilities.

Not specified (0)

InExtent (2)

InPool (3)

DMTF Reserved

4 32767

Vendor Specific

32768 65535

RemoteBufferHost

Data type: uint16

Access type: Read-only

Array provider may require multiple buffer elements per array instance as indicated by this property. Values:

Array: one buffer element for the entire array.

ComponentCS: one buffer element per ComputerSystem element in a clustered array.

Pipe: one or two buffer elements per replication pipe.

This property is inherited from CIM_StorageReplicationCapabilities.

Array (2)

ComponentCS (3)

Pipe (4)

DMTF Reserved

5 32767

Vendor Specific

32768 65535

RemoteBufferLocation

Data type: uint16

Access type: Read-only

This property allows the provider to indicate the required location for remote buffer elements. Values:

Source: buffer needed only on platforms hosting source elements.

Target: buffer needed only on platforms hosting target elements.

Both: buffers needed for both source and target platforms.

This property is inherited from CIM_StorageReplicationCapabilities.

Source (2)

Target (3)

Both (4)

DMTF Reserved

5 32767

Vendor Specific

32768 65535

RemoteBufferSupported

Data type: uint16

Access type: Read-only

Peer may require a write buffer for remote replica elements with async I/O buffering. Typically used to increase remote mirror replication engine performance while maintaining high availability. Values:

Required: must have buffer if any Async remote replicas are created.

Optional: may have buffer if any Async remote replicas are created.

This property is inherited from CIM_StorageReplicationCapabilities.

Not Supported (0)

Required (2)

Optional (3)

DMTF Reserved

4 32767

Vendor Specific

32768 65535

RemoteMirrorSnapshotSupported

Data type: boolean

Access type: Read-only

True indicates remote mirror can be snapshot source.

This property is inherited from CIM_StorageReplicationCapabilities.

RemoteReplicationServicePointAccess

Data type: uint16

Access type: Read-only

Remote replication provides StorageConfigurationService instances for source systems and target systems. A client determines that extrinsic methods of the service should be invoked to one instance or the other based on the value of this property. Values: Not Specified: invoke a method to either system instance. Source: invoke to source element service instance. Target: invoke to target element service instance. Proxy: find and invoke to proxy service instance.

This property is inherited from CIM_StorageReplicationCapabilities.

Not Specified (2)

Source (3)

Target (4)

Proxy (5)

DMTF Reserved

6 32767

Vendor Specific

32768 65535

ReplicaHostAccessibility

Data type: uint16

Access type: Read-only

Indicates host access restrictions for replicas with thesecapabilities. Values: 2 = not accessible.

3 = no restrictions. Any host may access. 4 = only accessible by associated source element hosts. 5 = not accessible by source element hosts. Other hosts OK.

This property is inherited from CIM_StorageReplicationCapabilities.

Not Accessible (2)

No Restrictions (3)

Source Hosts Only (4)

Source Hosts Excluded (5)

DMTF Reserved

6 65535

ReplicationPriorityDefault

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.ReplicationPriority")

ReplicationPriority allows the priority of background Replication I/O to be managed relative to host I/O. Default applies to initial or deferred background Replication operations. Value can be modified while in Replication-in-progress state. Values: Low: Replication engine I/O lower priority than host I/O.

Same: Replication engine I/O has the same priority as host I/O.

High: Replication engine I/O has higher priority than host I/O.

This property is inherited from CIM_StorageReplicationCapabilities.

Not Managed (0)

Low (1)

Same (2)

High (3)

DMTF Reserved

4 32767

Vendor Specific

32768 65535

SpaceLimitSupported

Data type: boolean

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_AllocatedFromStoragePool.SpaceLimit")

True indicates space limits on allocation from StoragePools may be enforced.

This property is inherited from CIM_StorageReplicationCapabilities.

SpaceLimitWarningThresholdDefault

Data type: uint8

Access type: Read-only

Qualifiers: Units ("Percentage"), MinValue (0), MaxValue (100), ModelCorrespondence ("CIM_AllocatedFromStoragePool.SpaceLimitWarningThreshold"), PUnit ("percent")

Warning threshold for instance modification indication for SpaceConsumed by a replica element. Value of zero means no warning generated. Triggered when SpaceConsumed >= (SpaceLimit*SpaceLimitWarningThreshold)/100.

This property is inherited from CIM_StorageReplicationCapabilities.

SpaceReservationSupported

Data type: boolean

Access type: Read-only

True indicates space reserved for replicas can be from a specialized pool.

This property is inherited from CIM_StorageReplicationCapabilities.

SupportedAsynchronousActions

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageReplicationCapabilities.SupportedSynchronousActions")

Enumeration indicating what operations will be executed as asynchronous jobs. If an operation is included in both this and SupportedSynchronousActions then the underlying implementation is indicating that it may or may not create a job.

This property is inherited from CIM_StorageReplicationCapabilities.

Local Replica Creation (2)

Remote Replica Creation (3)

Local Replica Modification (4)

Remote Replica Modification (5)

Local Replica Attachment (6)

Remote Replica Attachment (7)

Buffer Creation (8)

DMTF Reserved

9 65535

SupportedModifyOperations

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageConfigurationService.ModifySynchronization")

Enumeration indicating which ModifySynchronization operations are supported by this instance of StorageReplicationCapabilities.

This property is inherited from CIM_StorageReplicationCapabilities.

Detach (2)

Fracture (3)

Resync (4)

Restore (5)

Prepare (6)

Unprepare (7)

Quiesce (8)

Unquiesce (9)

Reset To Sync (10)

Reset To Async (11)

Start Copy (12)

Stop Copy (13)

DMTF Reserved

14 32767

Vendor Specific

32768 65535

SupportedSpecializedElements

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.IntendedUsage")

Enumeration indicating which specialized storage element types are supported by this instance of StorageReplicationCapabilities. Specialized types are indicated by the value of the IntendedUsage in StorageSetting.

This property is inherited from CIM_StorageReplicationCapabilities.

Delta Pool (2)

Delta Pool Component (3)

Remote Mirror (4)

Local Mirror (5)

Full Snapshot (6)

Delta Snapshot (7)

Replication Buffer (8)

DMTF Reserved

9 32767

Vendor Specific

32768 65535

SupportedSynchronizationType

Data type: uint16

Access type: Read-only

SupportedSynchronizationType describes the type of Synchronization that is characterized by this instance of StorageReplicationCapabilities. Values are:

Async: create a mirror that is nearly always synchronized. Sync: create a mirror that is always synchronized.

UnSyncAssocFull: create a full size snapshot (Point In Time image).

UnSyncAssocDelta: create a delta snapshot (Point In Time image).

UnSyncUnAssoc: create a full size, independent replica.

This property is inherited from CIM_StorageReplicationCapabilities.

Async (2)

Sync (3)

UnSyncAssoc-Full (4)

UnSyncAssoc-Delta (5)

UnSyncUnAssoc (6)

DMTF Reserved

7 32767

Vendor Specific

32768 65535

SupportedSynchronousActions

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageReplicationCapabilities.SupportedAsynchronousActions")

Enumeration indicating what operations will be executed without the creation of a job. If an operation is included in both this and SupportedAsynchronousActions then the underlying instrumentation is indicating that it may or may not create a job.

This property is inherited from CIM_StorageReplicationCapabilities.

Local Replica Creation (2)

Remote Replica Creation (3)

Local Replica Modification (4)

Remote Replica Modification (5)

Local Replica Attachment (6)

Remote Replica Attachment (7)

Buffer Creation (8)

NetworkPipe Creation (9)

DMTF Reserved

10 65535

UseReplicationBufferDefault

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.UseReplicationBuffer")

Indicate if an async remote replica pair is allowed to use a write buffer for asynchronous write buffering. - Not Managed: use or not of the buffer is up to the implementation. - Use Buffer: use of a buffer is required. - Do Not Use Buffer: a buffer shall not be used.

This property is inherited from CIM_StorageReplicationCapabilities.

Not Managed (0)

Use Buffer (1)

Do Not Use Buffer (2)

DMTF Reserved

3 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

See also

CIM_StorageReplicationCapabilities

iSCSI Target Server Reference