MSISCSITARGET_ReplicationService, ROOT\CIMV2\storage\iscsitarget

Class | Methods (27) | Properties (21) | Qualifiers (4) | Instances (1) | Namespaces (1)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

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.

MSISCSITARGET_ReplicationService methods

MSISCSITARGET_ReplicationService has 27 methods (27 Derived)

NameOriginReturn
AddMembersCIM_ReplicationServiceuint32 {'out':True}
AddReplicationEntityCIM_ReplicationServiceuint32 {'out':True}
AddServiceAccessPointCIM_ReplicationServiceuint32 {'out':True}
AddSharedSecretCIM_ReplicationServiceuint32 {'out':True}
AddToRemoteReplicationCollectionCIM_ReplicationServiceuint32 {'out':True}
CreateElementReplicaCIM_ReplicationServiceuint32 {'out':True}
CreateGroupCIM_ReplicationServiceuint32 {'out':True}
CreateGroupReplicaCIM_ReplicationServiceuint32 {'out':True}
CreateGroupReplicaFromElementsCIM_ReplicationServiceuint32 {'out':True}
CreateListReplicaCIM_ReplicationServiceuint32 {'out':True}
CreateRemoteReplicationCollectionCIM_ReplicationServiceuint32 {'out':True}
CreateSynchronizationAspectCIM_ReplicationServiceuint32 {'out':True}
DeleteGroupCIM_ReplicationServiceuint32 {'out':True}
GetAvailableTargetElementsCIM_ReplicationServiceuint32 {'out':True}
GetPeerSystemsCIM_ReplicationServiceuint32 {'out':True}
GetReplicationRelationshipInstancesCIM_ReplicationServiceuint32 {'out':True}
GetReplicationRelationshipsCIM_ReplicationServiceuint32 {'out':True}
GetServiceAccessPointsCIM_ReplicationServiceuint32 {'out':True}
ModifyListSettingsDefineStateCIM_ReplicationServiceuint32 {'out':True}
ModifyListSynchronizationCIM_ReplicationServiceuint32 {'out':True}
ModifyReplicaSynchronizationCIM_ReplicationServiceuint32 {'out':True}
ModifySettingsDefineStateCIM_ReplicationServiceuint32 {'out':True}
RemoveFromRemoteReplicationCollectionCIM_ReplicationServiceuint32 {'out':True}
RemoveMembersCIM_ReplicationServiceuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
StartServiceCIM_Serviceuint32 {'out':True}
StopServiceCIM_Serviceuint32 {'out':True}

MSISCSITARGET_ReplicationService properties

MSISCSITARGET_ReplicationService has 21 properties (21 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
key
CreationClassName
CIM_Service8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
key
Name
CIM_ManagedSystemElement8 [string]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
PrimaryOwnerContactCIM_Service8 [string]
PrimaryOwnerNameCIM_Service8 [string]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StartedCIM_Service11 [boolean]
StartModeCIM_Service8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
key
SystemCreationClassName
CIM_Service8 [string]
key
SystemName
CIM_Service8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]

Detailed description of MSISCSITARGET_ReplicationService methods

Derived methods (27) of MSISCSITARGET_ReplicationService class

AddMembers method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Membersref:CIM_LogicalElement0-{'Description':'List 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.'}
ReplicationGroupref:CIM_ReplicationGroup1-{'Description':'Reference to an existing replication group.','Required':True}
ServiceAccessPointref:CIM_ServiceAccessPoint2-{'Description':'Reference to access point information to allow the service to access the group on a remote system.','ModelCorrespondence':['CIM_ReplicationService.AddMembers.ReplicationGroup']}
ReplicationSettingDatastring3-{'Description':'If supplied, it provides additional replication settings for the method. For example, what should happen OnGroupOrListError.','EmbeddedInstance':'CIM_ReplicationSettingData'}
AddMembers method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
AddReplicationEntity method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ReplicationEntitystring0-{'EmbeddedInstance':'CIM_ReplicationEntity','Required':True}
Persistentboolean1-{'Description':'If 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.'}
InstanceNamespacestring2-{'Description':'Namespace of created instance. If null, created instance will be in the same namespace as the service.'}
ReplicationEntityPathref:CIM_ReplicationEntity3-{'Description':'Reference to the created instance.'}
AddReplicationEntity method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
AddServiceAccessPoint method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ServiceAccessPointstring0-{'EmbeddedInstance':'CIM_ServiceAccessPoint','Required':True}
InstanceNamespacestring1-{'Description':'Namespace of created instance. If null, created instance will be in the same namespace as the service.'}
ServiceAccessPointPathref:CIM_ServiceAccessPoint2-{'Description':'Reference to the created instance.'}
AddServiceAccessPoint method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
AddSharedSecret method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
SharedSecretstring0-{'EmbeddedInstance':'CIM_SharedSecret','Required':True}
ServiceAccessPointref:CIM_ServiceAccessPoint1-{'Description':'Associate created instance to this ServiceAccessPoint. If null, no such association is established.'}
InstanceNamespacestring2-{'Description':'Namespace of created instance. If null, created instance will be in the same namespace as the the service.'}
SharedSecretPathref:CIM_SharedSecret3-{'Description':'Reference to the created instance.'}
AddSharedSecret method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
AddToRemoteReplicationCollection method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
LocalAccessPointsref:CIM_ServiceAccessPoint0-{'Description':'An array of references to local ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.','ModelCorrespondence':['RemoteComputerSystem']}
RemoteAccessPointsref:CIM_ServiceAccessPoint1-{'Description':'An array of references to remote ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.','ModelCorrespondence':['RemoteComputerSystem']}
RemoteComputerSystemref:CIM_ComputerSystem2-{'Description':'A reference to the remote system.'}
Jobref:CIM_ConcreteJob3-{'Description':'Reference to the job (may be NULL if job is completed).'}
ConnectivityCollectionref:CIM_ConnectivityCollection4-{'Description':'The reference to the RemoteReplicationCollection to be expanded.','Required':True}
AddToRemoteReplicationCollection method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
CreateElementReplica method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ElementNamestring0-{'Description':'A 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.'}
SyncTypeuint161-{'Description':'SyncType describes the type of copy that will be made.','ModelCorrespondence':['CIM_Synchronized.SyncType'],'Required':True,'ValueMap':['..', '6', '7', '8', '..', '0x8000..'],'Values':['DMTF Reserved', 'Mirror', 'Snapshot', 'Clone', 'DMTF Reserved', 'Vendor Specific']}
Modeuint162-{'Description':'Mode describes whether the target elements will be updated synchronously or asynchronously. If NULL, implementaton decides the mode.','ModelCorrespondence':['CIM_Synchronized.Mode'],'ValueMap':['2', '3', '..', '0x8000..'],'Values':['Synchronous', 'Asynchronous', 'DMTF Reserved', 'Vendor Specific']}
SourceElementref:CIM_LogicalElement3-{'Description':'The source storage object which may be a StorageVolume or storage object.','Required':True}
SourceAccessPointref:CIM_ServiceAccessPoint4-{'Description':'Reference to source access point information. If NULL, service does not need access information to access the source element.','ModelCorrespondence':['CIM_ReplicationService.CreateElementReplica.SourceElement']}
TargetElementref:CIM_LogicalElement5-{'Description':'Optionally, 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.'}
TargetAccessPointref:CIM_ServiceAccessPoint6-{'Description':'Reference to target access point information. If NULL, service does not need access information to access the target elements.','ModelCorrespondence':['CIM_ReplicationService.CreateElementReplica.TargetElement', 'CIM_ReplicationService.CreateElementReplica.TargetPool']}
ReplicationSettingDatastring7-{'Description':'If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.','EmbeddedInstance':'CIM_ReplicationSettingData'}
Jobref:CIM_ConcreteJob8-{'Description':'Reference to the job (may be NULL if job is completed).'}
Synchronizationref:CIM_Synchronized9-{'Description':'Reference 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.'}
TargetSettingGoalref:CIM_SettingData10-{'Description':'The 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.'}
TargetPoolref:CIM_ResourcePool11-{'Description':'The 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.'}
WaitForCopyStateuint1612-{'Description':'Method 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.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
Description'Create (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.'
ImplementedTrue
Override'CreateElementReplica'
ValueMap['0', '1', '2', '3', '4', '5', '6', '..', '4096', '4097..32767', '0x8000..']
Values['Completed with No Error', 'Not Supported', 'Unknown', 'Timeout', 'Failed', 'Invalid Parameter', 'In Use', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Method Reserved', 'Vendor Specific']
CreateElementReplica method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
CreateGroup method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
GroupNamestring0-{'Description':'If nameable, an end user relevant name for the group being created. If NULL or not nameable, then system assigns a name.'}
Membersref:CIM_LogicalElement1-{'Description':'List of elements to add to the group -- order is maintained. If NULL, the group will be empty -- if empty groups are supported.'}
Persistentboolean2-{'Description':'If 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.'}
DeleteOnEmptyElementboolean3-{'Description':'If 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.'}
DeleteOnUnassociatedboolean4-{'Description':'If 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.'}
ServiceAccessPointref:CIM_ServiceAccessPoint5-{'Description':'Reference 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.','ModelCorrespondence':['CIM_ReplicationService.CreateGroup.GroupName']}
ReplicationGroupref:CIM_ReplicationGroup6-{'Description':'Reference to the created group.'}
ReplicationSettingDatastring7-{'Description':'If supplied, it provides additional replication settings for the method. For example, to supply the "Description" for the created group.','EmbeddedInstance':'CIM_ReplicationSettingData'}
CreateGroup method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
CreateGroupReplica method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RelationshipNamestring0-{'Description':'A 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.'}
SyncTypeuint161-{'Description':'SyncType describes the type of copy that will be made.','ModelCorrespondence':['CIM_Synchronized.SyncType'],'Required':True,'ValueMap':['..', '6', '7', '8', '..', '0x8000..'],'Values':['DMTF Reserved', 'Mirror', 'Snapshot', 'Clone', 'DMTF Reserved', 'Vendor Specific']}
Modeuint162-{'Description':'Mode describes whether the target elements will be updated synchronously or asynchronously. If NULL, implementaton decides the mode.','ModelCorrespondence':['CIM_Synchronized.Mode'],'ValueMap':['2', '3', '..', '0x8000..'],'Values':['Synchronous', 'Asynchronous', 'DMTF Reserved', 'Vendor Specific']}
SourceGroupref:CIM_ReplicationGroup3-{'Description':'A group of source storage objects which may be a StorageVolume or storage object. If this parameter is not supplied, SourceElement is required. Both SourceGroup and SourceElement shall not be supplied.'}
SourceElementref:CIM_LogicalElement4-{'Description':'The source storage object which may be a StorageVolume or storage object. If this parameter is not supplied, SourceGroup is required. Both SourceGroup and SourceElement shall not be supplied.'}
SourceAccessPointref:CIM_ServiceAccessPoint5-{'Description':'Reference to source access point information. If NULL, service does not need access information to access the source element.','ModelCorrespondence':['CIM_ReplicationService.CreateGroupReplica.SourceGroup', 'CIM_ReplicationService.CreateGroupReplica.SourceElement']}
TargetGroupref:CIM_ReplicationGroup6-{'Description':'Optionally, 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.'}
TargetElementCountuint647-{'Description':'This 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.'}
TargetAccessPointref:CIM_ServiceAccessPoint8-{'Description':'Reference to target access point information. If NULL, service does not need access information to access the target element/group.','ModelCorrespondence':['CIM_ReplicationService.CreateGroupReplica.TargetGroup', 'CIM_ReplicationService.CreateGroupReplica.TargetPool']}
Consistencyuint169-{'Description':'Overrides the default group consistency.','ValueMap':['2', '3', '..', '0x8000..'],'Values':['No Consistency', 'Sequential Consistency', 'DMTF Reserved', 'Vendor Specific']}
ReplicationSettingDatastring10-{'Description':'If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.','EmbeddedInstance':'CIM_ReplicationSettingData'}
Jobref:CIM_ConcreteJob11-{'Description':'Reference to the job (may be NULL if job is completed).'}
Synchronizationref:CIM_Synchronized12-{'Description':'Reference 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.'}
TargetSettingGoalref:CIM_SettingData13-{'Description':'The definition for the SettingData to be maintained by the target storage objects (the replicas). If target elements are supplied, this parameter shall be NULL.'}
TargetPoolref:CIM_ResourcePool14-{'Description':'The 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.'}
WaitForCopyStateuint1615-{'Description':'Method 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.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
CreateGroupReplica method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
CreateGroupReplicaFromElements method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RelationshipNamestring0-{'Description':'A 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.'}
SyncTypeuint161-{'Description':'SyncType describes the type of copy that will be made.','ModelCorrespondence':['CIM_Synchronized.SyncType'],'Required':True,'ValueMap':['..', '6', '7', '8', '..', '0x8000..'],'Values':['DMTF Reserved', 'Mirror', 'Snapshot', 'Clone', 'DMTF Reserved', 'Vendor Specific']}
Modeuint162-{'Description':'Mode describes whether the target elements will be updated synchronously or asynchronously. If NULL, implementaton decides the mode.','ModelCorrespondence':['CIM_Synchronized.Mode'],'ValueMap':['2', '3', '..', '0x8000..'],'Values':['Synchronous', 'Asynchronous', 'DMTF Reserved', 'Vendor Specific']}
SourceElementsref:CIM_LogicalElement3-{'Description':'A 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.','Required':True}
SourceGroupNamestring4-{'Description':'As 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.'}
SourceAccessPointref:CIM_ServiceAccessPoint5-{'Description':'Reference to source access point information. If NULL, service does not need access information to access the source elements.','ModelCorrespondence':['CreateGroupReplicaFromElements.SourceElements']}
TargetGroupref:CIM_ReplicationGroup6-{'Description':'Optionally, 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.'}
TargetAccessPointref:CIM_ServiceAccessPoint7-{'Description':'Reference to target access point information. If NULL, service does not need access information to access the target element/group.','ModelCorrespondence':['CreateGroupReplicaFromElements.TargetGroup', 'CreateGroupReplicaFromElements.TargetPool']}
Consistencyuint168-{'Description':'Overrides the default group consistency.','ValueMap':['2', '3', '..', '0x8000..'],'Values':['No Consistency', 'Sequential Consistency', 'DMTF Reserved', 'Vendor Specific']}
ReplicationSettingDatastring9-{'Description':'If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.','EmbeddedInstance':'CIM_ReplicationSettingData'}
Jobref:CIM_ConcreteJob10-{'Description':'Reference to the job (may be NULL if job is completed).'}
Synchronizationref:CIM_Synchronized11-{'Description':'Reference 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.'}
TargetSettingGoalref:CIM_SettingData12-{'Description':'The definition for the SettingData to be maintained by the target storage objects (the replicas). If target elements are supplied, this parameter shall be NULL.'}
TargetPoolref:CIM_ResourcePool13-{'Description':'The 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.'}
WaitForCopyStateuint1614-{'Description':'Method 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.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
CreateGroupReplicaFromElements method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
CreateListReplica method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ElementNamesstring0-{'Description':'An 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.'}
SyncTypeuint161-{'Description':'SyncType describes the type of copy that will be made. The same SyncType applies to all elements in the list.','ModelCorrespondence':['SNIA_Synchronized.SyncType'],'Required':True,'ValueMap':['..', '6', '7', '8', '..', '0x8000..'],'Values':['DMTF Reserved', 'Mirror', 'Snapshot', 'Clone', 'DMTF Reserved', 'Vendor Specific']}
Modeuint162-{'Description':'Mode 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.','ModelCorrespondence':['CIM_Synchronized.Mode'],'ValueMap':['2', '3', '..', '0x8000..'],'Values':['Synchronous', 'Asynchronous', 'DMTF Reserved', 'Vendor Specific']}
SourceElementsref:CIM_LogicalElement3-{'Description':'A 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.','Required':True}
SourceAccessPointref:CIM_ServiceAccessPoint4-{'Description':'Reference 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.','ModelCorrespondence':['CIM_ReplicationService.CreateListReplica.SourceElements']}
TargetElementsref:CIM_LogicalElement5-{'Description':'Optionally, 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.','ModelCorrespondence':['CIM_ReplicationService.CreateListReplica.SourceElements']}
TargetAccessPointref:CIM_ServiceAccessPoint6-{'Description':'Reference 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.','ModelCorrespondence':['CIM_ReplicationService.CreateListReplica.TargetElements', 'CIM_ReplicationService.CreateListReplica.TargetPool']}
ReplicationSettingDatastring7-{'Description':'If 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.','EmbeddedInstance':'CIM_ReplicationSettingData'}
Jobref:CIM_ConcreteJob8-{'Description':'Reference to the job (may be NULL if job is completed).'}
Synchronizationsref:CIM_Synchronized9-{'Description':'Reference 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.'}
TargetSettingGoalref:CIM_SettingData10-{'Description':'The 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.'}
TargetPoolref:CIM_ResourcePool11-{'Description':'The 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.'}
WaitForCopyStateuint1612-{'Description':'Method 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.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
CreateListReplica method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
CreateRemoteReplicationCollection method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ElementNamestring0-{'Description':'A 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.'}
LocalAccessPointsref:CIM_ServiceAccessPoint1-{'Description':'An array of references to local ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.','ModelCorrespondence':['RemoteComputerSystem']}
RemoteAccessPointsref:CIM_ServiceAccessPoint2-{'Description':'An array of references to remote ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.','ModelCorrespondence':['RemoteComputerSystem']}
RemoteComputerSystemref:CIM_ComputerSystem3-{'Description':'A reference to the remote system.'}
Activeboolean4-{'Description':'If 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.'}
DeleteOnUnassociatedboolean5-{'Description':'If 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.'}
Jobref:CIM_ConcreteJob6-{'Description':'Reference to the job (may be NULL if job is completed).'}
ConnectivityCollectionref:CIM_ConnectivityCollection7-{'Description':'Reference to the created instance ofRemoteReplicationCollection.'}
CreateRemoteReplicationCollection method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
CreateSynchronizationAspect method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Namestring0-{'Description':'A 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.'}
SyncTypeuint161-{'Description':'SyncType describes the type of copy that will be made.','ModelCorrespondence':['CIM_Synchronized.SyncType'],'Required':True,'ValueMap':['..', '6', '7', '8', '..', '0x8000..'],'Values':['DMTF Reserved', 'Mirror', 'Snapshot', 'Clone', 'DMTF Reserved', 'Vendor Specific']}
Modeuint162-{'Description':'Mode describes whether the target elements will be updated synchronously or asynchronously. If NULL, implementaton decides the mode.','ModelCorrespondence':['CIM_Synchronized.Mode'],'ValueMap':['2', '3', '..', '0x8000..'],'Values':['Synchronous', 'Asynchronous', 'DMTF Reserved', 'Vendor Specific']}
SourceGroupref:CIM_ReplicationGroup3-{'Description':'A group of source storage objects which may be a StorageVolume or storage object. If this parameter is not supplied, SourceElement is required. Both SourceGroup and SourceElement shall not be supplied.'}
SourceElementref:CIM_LogicalElement4-{'Description':'The source storage object which may be a StorageVolume or storage object. If this parameter is not supplied, SourceGroup is required. Both SourceGroup and SourceElement shall not be supplied.'}
SourceAccessPointref:CIM_ServiceAccessPoint5-{'Description':'Reference to source access point information. If NULL, service does not need access information to access the source element/group.','ModelCorrespondence':['CIM_ReplicationService.CreateSynchronizationAspect.SourceGroup', 'CIM_ReplicationService.CreateSynchronizationAspect.SourceElement']}
Consistencyuint166-{'Description':'Overrides the default group consistency.','ValueMap':['2', '3', '..', '0x8000..'],'Values':['No Consistency', 'Sequential Consistency', 'DMTF Reserved', 'Vendor Specific']}
ReplicationSettingDatastring7-{'Description':'If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.','EmbeddedInstance':'CIM_ReplicationSettingData'}
Jobref:CIM_ConcreteJob8-{'Description':'Reference to the job (may be NULL if job is completed).'}
SettingsStateref:CIM_SettingsDefineState9-{'Description':'Reference 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.'}
CreateSynchronizationAspect method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
DeleteGroup method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ReplicationGroupref:CIM_ReplicationGroup0-{'Description':'Reference to a replication group.','Required':True}
ServiceAccessPointref:CIM_ServiceAccessPoint1-{'Description':'Reference to access point information to allow the service to delete the group on a remote system.','ModelCorrespondence':['CIM_ReplicationService.DeleteGroup.ReplicationGroup']}
RemoveElementsboolean2-{'Description':'Delete 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.'}
ReplicationSettingDatastring3-{'Description':'If supplied, it provides additional replication settings for the method. For example, what should happen OnGroupOrListError.','EmbeddedInstance':'CIM_ReplicationSettingData'}
DeleteGroup method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
GetAvailableTargetElements method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
SourceElementref:CIM_LogicalElement0-{'Description':'The source storage object which may be a StorageVolume or storage object.','Required':True}
SyncTypeuint161-{'Description':'SyncType describes the type of copy.','ModelCorrespondence':['CIM_Synchronized.SyncType'],'Required':True,'ValueMap':['..', '6', '7', '8', '..', '0x8000..'],'Values':['DMTF Reserved', 'Mirror', 'Snapshot', 'Clone', 'DMTF Reserved', 'Vendor Specific']}
Modeuint162-{'Description':'Mode describes whether the target elements will be updated synchronously or asynchronously. If NULL, the implementation decides.','ModelCorrespondence':['CIM_Synchronized.Mode'],'ValueMap':['2', '3', '..', '0x8000..'],'Values':['Synchronous', 'Asynchronous', 'DMTF Reserved', 'Vendor Specific']}
ReplicationSettingDatastring3-{'Description':'If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.','EmbeddedInstance':'CIM_ReplicationSettingData'}
TargetAccessPointref:CIM_ServiceAccessPoint4-{'Description':'Reference to access point information. If NULL, only local system is examined.','ModelCorrespondence':['CIM_ReplicationService.GetAvailableTargetElements.TargetSettingGoal', 'CIM_ReplicationService.GetAvailableTargetElements.TargetPools']}
TargetSettingGoalref:CIM_SettingData5-{'Description':'Desired target SettingData. If NULL, settings of the source element will be used.'}
TargetPoolsref:CIM_ResourcePool6-{'Description':'The storage pools for the target elements. If NULL, all storage pools (on the given system) will be examined.'}
Jobref:CIM_ConcreteJob7-{'Description':'Reference to the job (may be NULL if the task completed).'}
Candidatesref:CIM_LogicalElement8-{'Description':'The list of the candidate target elements.'}
GetAvailableTargetElements method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
GetPeerSystems method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Optionsuint160-{'Description':'This parameter specifies which peer systems to return. If NULL, all known systems are returned, whether those systems are currently reachable or not.','ValueMap':['2', '..', '0x8000..'],'Values':['Only systems currently reachable', 'DMTF Reserved', 'Vendor Specific']}
Jobref:CIM_ConcreteJob1-{'Description':'Reference to the job (may be NULL if the task completed).'}
Systemsref:CIM_ComputerSystem2-{'Description':'List of peer ComputerSystems.'}
GetPeerSystems method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
GetReplicationRelationshipInstances method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Typeuint160-{'Description':'The type of synchronization relationships, for example, StorageSynchronized or GroupSynchronized. If this parameter is not supplied, all such relationships are retrieved.','ValueMap':['2', '3', '..', '0x8000..'],'Values':['StorageSynchronized', 'GroupSynchronized', 'DMTF Reserved', 'Vendor Specific']}
SyncTypeuint161-{'Description':'Describes the desired synchronization type. If this parameter is not specified, all SyncType are retrieved.','ModelCorrespondence':['CIM_Synchronized.SyncType'],'ValueMap':['..', '6', '7', '8', '..', '0x8000..'],'Values':['DMTF Reserved', 'Mirror', 'Snapshot', 'Clone', 'DMTF Reserved', 'Vendor Specific']}
Modeuint162-{'Description':'Describes the desired mode. If this parameter is not supplied, both synchronous and asynchronous modes are retrieved.','ModelCorrespondence':['CIM_Synchronized.Mode'],'ValueMap':['2', '3', '..', '0x8000..'],'Values':['Synchronous', 'Asynchronous', 'DMTF Reserved', 'Vendor Specific']}
Localityuint163-{'Description':'Describes 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.','ValueMap':['2', '3', '..', '0x8000..'],'Values':['Local only', 'Remote only', 'DMTF Reserved', 'Vendor Specific']}
CopyStateuint164-{'Description':'Only retrieve synchronization relationships that are currently in this CopyState. If this parameter is not supplied, relationships are retrieved regardless of their current CopyState.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
Jobref:CIM_ConcreteJob5-{'Description':'Reference to the job (may be NULL if the task completed).'}
Synchronizationsstring6-{'Description':'An array of instances found.','EmbeddedInstance':'CIM_Synchronized'}
GetReplicationRelationshipInstances method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
GetReplicationRelationships method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Typeuint160-{'Description':'The type of synchronization relationships, for example, StorageSynchronized or GroupSynchronized. If this parameter is not supplied, all such relationships are retrieved.','ValueMap':['2', '3', '..', '0x8000..'],'Values':['StorageSynchronized', 'GroupSynchronized', 'DMTF Reserved', 'Vendor Specific']}
SyncTypeuint161-{'Description':'Describes the desired synchronization type. If this parameter is not specified, all SyncType are retrieved.','ModelCorrespondence':['CIM_Synchronized.SyncType'],'ValueMap':['..', '6', '7', '8', '..', '0x8000..'],'Values':['DMTF Reserved', 'Mirror', 'Snapshot', 'Clone', 'DMTF Reserved', 'Vendor Specific']}
Modeuint162-{'Description':'Describes the desired mode. If this parameter is not supplied, both synchronous and asynchronous modes are retrieved.','ModelCorrespondence':['CIM_Synchronized.Mode'],'ValueMap':['2', '3', '..', '0x8000..'],'Values':['Synchronous', 'Asynchronous', 'DMTF Reserved', 'Vendor Specific']}
Localityuint163-{'Description':'Describes 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.','ValueMap':['2', '3', '..', '0x8000..'],'Values':['Local only', 'Remote only', 'DMTF Reserved', 'Vendor Specific']}
CopyStateuint164-{'Description':'Only retrieve synchronization relationships that are currently in this CopyState. If this parameter is not supplied, relationships are retrieved regardless of their current CopyState.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
Jobref:CIM_ConcreteJob5-{'Description':'Reference to the job (may be NULL if the task completed).'}
Synchronizationsref:CIM_Synchronized6-{'Description':'An array of elements found.'}
GetReplicationRelationships method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
GetServiceAccessPoints method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Systemref:CIM_ComputerSystem0-{'Description':'This parameter specifies the peer system.','Required':True}
Jobref:CIM_ConcreteJob1-{'Description':'Reference to the job (may be NULL if the task completed).'}
ServiceAccessPointsref:CIM_ServiceAccessPoint2-{'Description':'List of ServiceAccessPoints for the supplied System.'}
GetServiceAccessPoints method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
ModifyListSettingsDefineState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Operationuint160-{'Description':'Operation 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.','Required':True,'ValueMap':['2', '3', '4', '5', '..', '0x8000..0xFFFF'],'Values':['Activate Consistency', 'Deactivate Consistency', 'Delete', 'Copy To Target', 'DMTF Reserved', 'Vendor Specific']}
SettingsStatesref:CIM_SettingsDefineState1-{'Description':'An array of references to the associations between the source elements and instances of SynchronizationAspect.','Required':True}
TargetElementsref:CIM_LogicalElement2-{'Description':'Optionally, 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.'}
TargetGroupsref:CIM_ReplicationGroup3-{'Description':'Optionally, 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.'}
TargetElementCountuint644-{'Description':'This 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.'}
TargetAccessPointref:CIM_ServiceAccessPoint5-{'Description':'Reference to target access point information. If NULL, service does not need access information to access the target elements/group.','ModelCorrespondence':['CIM_ReplicationService.ModifySettingsDefineState.TargetElements', 'CIM_ReplicationService.ModifySettingsDefineState.TargetGroups', 'CIM_ReplicationService.ModifySettingsDefineState.TargetElementCount']}
Synchronizationsref:CIM_Synchronized6-{'Description':'The reference to the created replication associations describing the elements/groups relationship.'}
ReplicationSettingDatastring7-{'Description':'If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.','EmbeddedInstance':'CIM_ReplicationSettingData'}
Jobref:CIM_ConcreteJob8-{'Description':'Reference to the job (may be NULL if the task completed).'}
TargetSettingGoalref:CIM_SettingData9-{'Description':'The 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.'}
TargetPoolref:CIM_ResourcePool10-{'Description':'The 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.'}
WaitForCopyStateuint1611-{'Description':'Method 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.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
ModifyListSettingsDefineState method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
ModifyListSynchronization method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Operationuint160-{'Description':'Operation 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.','Required':True,'ValueMap':['2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '..', '0x8000..0xFFFF'],'Values':['Abort', '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']}
Synchronizationref:CIM_Synchronized1-{'Description':'Array 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.','Required':True}
ReplicationSettingDatastring2-{'Description':'If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.','EmbeddedInstance':'CIM_ReplicationSettingData'}
Jobref:CIM_ConcreteJob3-{'Description':'Reference to the job (may be NULL if the task completed).'}
SettingsStateref:CIM_SettingsDefineState4-{'Description':'References 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..'}
Forceboolean5-{'Description':'Some operations may cause an inconsistency among the target elements. If true, the client is not warned and the operation is performed.'}
WaitForCopyStateuint166-{'Description':'Method 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.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
ModifyListSynchronization method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
ModifyReplicaSynchronization method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Operationuint160-{'Description':'Operation 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.','Required':True,'ValueMap':['2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '..', '0x8000..0xFFFF'],'Values':['Abort', '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']}
Synchronizationref:CIM_Synchronized1-{'Description':'The reference to the replication association describing the elements/groups relationship.','Required':True}
ReplicationSettingDatastring2-{'Description':'If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.','EmbeddedInstance':'CIM_ReplicationSettingData'}
SyncPairref:CIM_StorageSynchronized3-{'Description':'This parameter applies to AddSyncPair/RemoveSyncPair Operations.'}
Jobref:CIM_ConcreteJob4-{'Description':'Reference to the job (may be NULL if the task completed).'}
SettingsStateref:CIM_SettingsDefineState5-{'Description':'Reference 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.'}
Forceboolean6-{'Description':'Some operations may cause an inconsistency among the target elements. If true, the client is not warned and the operation is performed.'}
WaitForCopyStateuint167-{'Description':'Method 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.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
Description'Modify (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.'
ImplementedTrue
Override'ModifyReplicaSynchronization'
ValueMap['0', '1', '2', '3', '4', '5', '6', '..', '4096', '4097..32767', '0x8000..']
Values['Completed with No Error', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'In Use', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Method Reserved', 'Vendor Specific']
ModifyReplicaSynchronization method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
ModifySettingsDefineState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Operationuint160-{'Description':'Operation 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.','Required':True,'ValueMap':['2', '3', '4', '5', '..', '0x8000..0xFFFF'],'Values':['Activate Consistency', 'Deactivate Consistency', 'Delete', 'Copy To Target', 'DMTF Reserved', 'Vendor Specific']}
SettingsStateref:CIM_SettingsDefineState1-{'Description':'Reference to the association between the source element and an instance of SynchronizationAspect.','Required':True}
TargetElementref:CIM_LogicalElement2-{'Description':'Optionally, 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.'}
TargetGroupref:CIM_ReplicationGroup3-{'Description':'Optionally, 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.'}
TargetElementCountuint644-{'Description':'This 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.'}
TargetAccessPointref:CIM_ServiceAccessPoint5-{'Description':'Reference to target access point information. If NULL, service does not need access information to access the target elements/group.','ModelCorrespondence':['CIM_ReplicationService.ModifySettingsDefineState.TargetElement', 'CIM_ReplicationService.ModifySettingsDefineState.TargetGroup', 'CIM_ReplicationService.ModifySettingsDefineState.TargetElementCount']}
Synchronizationref:CIM_Synchronized6-{'Description':'The reference to the created replication association describing the elements/groups relationship.'}
ReplicationSettingDatastring7-{'Description':'If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.','EmbeddedInstance':'CIM_ReplicationSettingData'}
Jobref:CIM_ConcreteJob8-{'Description':'Reference to the job (may be NULL if the task completed).'}
TargetSettingGoalref:CIM_SettingData9-{'Description':'The 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.'}
TargetPoolref:CIM_ResourcePool10-{'Description':'The 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.'}
WaitForCopyStateuint1611-{'Description':'Method 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.','ModelCorrespondence':['CIM_Synchronized.CopyState']}
ModifySettingsDefineState method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
RemoveFromRemoteReplicationCollection method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
LocalAccessPointsref:CIM_ServiceAccessPoint0-{'Description':'An array of references to local ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.','ModelCorrespondence':['RemoteComputerSystem']}
RemoteAccessPointsref:CIM_ServiceAccessPoint1-{'Description':'An array of references to remote ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.','ModelCorrespondence':['RemoteComputerSystem']}
RemoteComputerSystemref:CIM_ComputerSystem2-{'Description':'A reference to the remote system to remove.'}
Jobref:CIM_ConcreteJob3-{'Description':'Reference to the job (may be NULL if job is completed).'}
ConnectivityCollectionref:CIM_ConnectivityCollection4-{'Description':'The reference to the RemoteReplicationCollection to affect.','Required':True}
RemoveFromRemoteReplicationCollection method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
RemoveMembers method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Membersref:CIM_LogicalElement0-{'Description':'List 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.'}
DeleteOnEmptyElementboolean1-{'Description':'If 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.'}
ReplicationGroupref:CIM_ReplicationGroup2-{'Description':'Reference to an existing replication group.','Required':True}
ServiceAccessPointref:CIM_ServiceAccessPoint3-{'Description':'Reference to access point information to allow the service to access the group on a remote system.','ModelCorrespondence':['CIM_ReplicationService.RemoveMembers.ReplicationGroup']}
ReplicationSettingDatastring4-{'Description':'If supplied, it provides additional replication settings for the method. For example, what should happen OnGroupOrListError.','EmbeddedInstance':'CIM_ReplicationSettingData'}
RemoveMembers method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'Reference to the job (can be null if the task is completed).'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.'}
RequestStateChange method is in 51 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
StartService method
Returnuint32 {'out':True}
StartService method is in 17 classes of ROOT\CIMV2\storage\iscsitarget and in 11 namespaces
StopService method
Returnuint32 {'out':True}
StopService method is in 17 classes of ROOT\CIMV2\storage\iscsitarget and in 11 namespaces

Detailed description of MSISCSITARGET_ReplicationService properties

Derived properties (21) of MSISCSITARGET_ReplicationService class

Caption property
CIMTYPE'string'
Caption property is in 90 classes of ROOT\CIMV2\storage\iscsitarget and in 37 namespaces
CreationClassName property
CIMTYPE'string'
keyTrue
CreationClassName property is in 45 classes of ROOT\CIMV2\storage\iscsitarget and in 20 namespaces
Description property
CIMTYPE'string'
Description property is in 91 classes of ROOT\CIMV2\storage\iscsitarget and in 142 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 90 classes of ROOT\CIMV2\storage\iscsitarget and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
EnabledState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 13 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 23 namespaces
Name property
CIMTYPE'string'
keyTrue
Name property is in 67 classes of ROOT\CIMV2\storage\iscsitarget and in 142 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 11 namespaces
PrimaryOwnerContact property
CIMTYPE'string'
PrimaryOwnerContact property is in 21 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
PrimaryOwnerName property
CIMTYPE'string'
PrimaryOwnerName property is in 21 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
RequestedState property
CIMTYPE'uint16'
RequestedState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 12 namespaces
Started property
CIMTYPE'boolean'
Started property is in 17 classes of ROOT\CIMV2\storage\iscsitarget and in 11 namespaces
StartMode property
CIMTYPE'string'
StartMode property is in 17 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
Status property
CIMTYPE'string'
Status property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 18 namespaces
SystemCreationClassName property
CIMTYPE'string'
keyTrue
SystemCreationClassName property is in 41 classes of ROOT\CIMV2\storage\iscsitarget and in 20 namespaces
SystemName property
CIMTYPE'string'
keyTrue
SystemName property is in 45 classes of ROOT\CIMV2\storage\iscsitarget and in 22 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 51 classes of ROOT\CIMV2\storage\iscsitarget and in 17 namespaces

MSISCSITARGET_ReplicationService Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'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.'
dynamicTrue
provider'MSiSCSITargetProv'
Version'1.0.0'

MSISCSITARGET_ReplicationService System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\CIMV2\storage\iscsitarget:MSISCSITARGET_ReplicationService'___SYSTEM8
__NAMESPACE'ROOT\CIMV2\storage\iscsitarget'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_ReplicationService', 'CIM_Service', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT21___SYSTEM3
__RELPATH'MSISCSITARGET_ReplicationService'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_ReplicationService'___SYSTEM8
__CLASS'MSISCSITARGET_ReplicationService'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSISCSITARGET_ReplicationService

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_ReplicationService12127-1--
CIM_ReplicationServiceCapabilities1820-1--
MSISCSITARGET_ReplicationServiceCapabilities08201---
comments powered by Disqus
WUtils.com