Msvm_ReplicationService, ROOT\virtualization\v2

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

Description

Manages the failover replication for a virtual machine.

Msvm_ReplicationService methods

Msvm_ReplicationService has 29 methods (26 Local, 3 Derived)

NameOriginReturn
AddAuthorizationEntryMsvm_ReplicationServiceuint32 {'out':True}
ChangeReplicationModeToPrimaryMsvm_ReplicationServiceuint32 {'out':True}
CommitFailoverMsvm_ReplicationServiceuint32 {'out':True}
CreateReplicationRelationshipMsvm_ReplicationServiceuint32 {'out':True}
GetReplicationStatisticsMsvm_ReplicationServiceuint32 {'out':True}
GetReplicationStatisticsExMsvm_ReplicationServiceuint32 {'out':True}
GetSystemCertificatesMsvm_ReplicationServiceuint32 {'out':True}
ImportInitialReplicaMsvm_ReplicationServiceuint32 {'out':True}
InitiateFailbackMsvm_ReplicationServiceuint32 {'out':True}
InitiateFailoverMsvm_ReplicationServiceuint32 {'out':True}
ModifyAuthorizationEntryMsvm_ReplicationServiceuint32 {'out':True}
ModifyReplicationSettingsMsvm_ReplicationServiceuint32 {'out':True}
ModifyServiceSettingsMsvm_ReplicationServiceuint32 {'out':True}
RemoveAuthorizationEntryMsvm_ReplicationServiceuint32 {'out':True}
RemoveReplicationRelationshipMsvm_ReplicationServiceuint32 {'out':True}
RemoveReplicationRelationshipExMsvm_ReplicationServiceuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
ResetReplicationStatisticsMsvm_ReplicationServiceuint32 {'out':True}
ResetReplicationStatisticsExMsvm_ReplicationServiceuint32 {'out':True}
ResynchronizeMsvm_ReplicationServiceuint32 {'out':True}
ReverseReplicationRelationshipMsvm_ReplicationServiceuint32 {'out':True}
RevertFailoverMsvm_ReplicationServiceuint32 {'out':True}
SetAuthorizationEntryMsvm_ReplicationServiceuint32 {'out':True}
SetFailoverNetworkAdapterSettingsMsvm_ReplicationServiceuint32 {'out':True}
StartReplicationMsvm_ReplicationServiceuint32 {'out':True}
StartServiceCIM_Serviceuint32 {'out':True}
StopServiceCIM_Serviceuint32 {'out':True}
TestReplicaSystemMsvm_ReplicationServiceuint32 {'out':True}
TestReplicationConnectionMsvm_ReplicationServiceuint32 {'out':True}

Msvm_ReplicationService properties

Msvm_ReplicationService has 28 properties (28 Derived)

NameOriginCIMType
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_Service8 [string]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
key
Name
CIM_ManagedSystemElement8 [string]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
PrimaryOwnerContactCIM_Service8 [string]
PrimaryOwnerNameCIM_Service8 [string]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
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]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]

Detailed description of Msvm_ReplicationService methods

Local methods (26) of Msvm_ReplicationService class

AddAuthorizationEntry method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
AuthorizationEntrystring0-{'Description':'The authorization entry to be added to the server.','HyperVEmbeddedInstance':'Msvm_ReplicationAuthorizationSettingData','In':True}
Jobref:CIM_ConcreteJob1-{'Description':'A reference to the job (can be null if the task has completed).','Out':True}
Bypass_GetObjectTrue
Description'This method add an authorization entry to the server. This entry is used for authorizing the connections to the recovery server.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
AddAuthorizationEntry method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
ChangeReplicationModeToPrimary method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance that represents the virtual machine for which the extended replication relationship should be changed as primary relationship.','In':True}
ReplicationRelationshipstring1-{'Description':'The replication relationship to be changed as primary relationship.','HyperVEmbeddedInstance':'Msvm_ReplicationRelationship','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'Using this API, a replica VM having extended replication relationship can become new primary and continue its replication with the extended replica VM. This API requires the replica VM to be in a failover committed state.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
ChangeReplicationModeToPrimary method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
CommitFailover method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which to commit failover.','In':True}
Jobref:CIM_ConcreteJob1-{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
Bypass_GetObjectTrue
Description'Commits the recovery snapshot that InitiateFailover has used for failover.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
CommitFailover method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
CreateReplicationRelationship method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which the replication should be enabled.','In':True}
ReplicationSettingDatastring1-{'Description':'The setting data for replication.','HyperVEmbeddedInstance':'Msvm_ReplicationSettingData','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'Creates new replication relationship for virtual machine.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
CreateReplicationRelationship method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
GetReplicationStatistics method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the Hyper-V replica enabled virtual computer system.','In':True}
ReplicationStatisticsstring1-{'ArrayType':'Indexed','Description':'If successful, this object contains the array of replication statistics for the requested virtual machine. This is an embedded instance of Msvm_ReplicationStatistics.','HyperVEmbeddedInstance':'Msvm_ReplicationStatistics','Out':True}
ReplicationHealthIssuesstring2-{'ArrayType':'Indexed','Description':'If successful, this object contains the array of Msvm_Error objects that indicate reasons forthe current replication health period being in warning or error for the requested virtual machine. This is an embedded instance of Msvm_Error.','HyperVEmbeddedInstance':'Msvm_Error','Out':True}
Jobref:CIM_ConcreteJob3-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Deprecated['Msvm_ReplicationService.GetReplicationStatisticsEx()']
Description'Retrieves replication statistics associated with virtual machine.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
GetReplicationStatistics method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
GetReplicationStatisticsEx method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the Hyper-V replica enabled virtual computer system.','In':True}
ReplicationRelationshipstring1-{'Description':'The replication relationship to get statistics for.','HyperVEmbeddedInstance':'Msvm_ReplicationRelationship','In':True}
ReplicationStatisticsstring2-{'ArrayType':'Indexed','Description':'If successful, this object contains the array of replication statistics for the requested virtual machine. This is an embedded instance of Msvm_ReplicationStatistics.','EmbeddedInstance':'Msvm_ReplicationStatistics','Out':True}
ReplicationHealthIssuesstring3-{'ArrayType':'Indexed','Description':'If successful, this object contains the array of Msvm_Error objects that indicate reasons forthe current replication health period being in warning or error for the requested virtual machine. This is an embedded instance of Msvm_Error.','EmbeddedInstance':'Msvm_Error','Out':True}
Jobref:CIM_ConcreteJob4-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'Retrieves replication statistics associated with specified replication relationship of virtual machine.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
GetReplicationStatisticsEx method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
GetSystemCertificates method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
EncodedCertificatesstring0-{'ArrayType':'Indexed','Description':'If successful, this contains the certificates available from the Personal store for the local machine.Each entry is a base 64 encoded certificate string. This string can be converted to byte array for constructing X509Certificate2 object.','Out':True}
Bypass_GetObjectTrue
Description'This method returns the system certificates on a host system.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
GetSystemCertificates method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
ImportInitialReplica method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which the initial replication should be imported.','In':True}
InitialReplicationImportLocationstring1-{'Description':'The fully-qualified path of the directory from which the initial replication is to be imported. This can not be null.','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
Bypass_GetObjectTrue
Description'Imports the virtual machine initial replication.
Specify InitialReplicationImportLocation where primary server exported the replication.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
ImportInitialReplica method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
InitiateFailback method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which to initiate failback.','In':True}
ReplicationSettingDatastring1-{'Description':'The setting data for failback.','HyperVEmbeddedInstance':'Msvm_ReplicationSettingData','In':True}
RecoveryPointIdentifierstring2-{'Description':'Optional input which identifies the recovery point to which failback is requested.','In':True}
Jobref:CIM_ConcreteJob3-{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
Bypass_GetObjectTrue
Description'Sets the failover for virtual machine to application or crash consistent image.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
InitiateFailback method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
InitiateFailover method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which to prepare failover.','In':True}
SnapshotSettingDataref:CIM_VirtualSystemSettingData1-{'Description':'The CIM_VirtualSystemSettingData instance that represents the snapshot used for failover.Pass NULL if failover is to be performed to the latest point in time.','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
Bypass_GetObjectTrue
Description'Sets the failover for virtual machine to application or crash consistent image.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
InitiateFailover method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
ModifyAuthorizationEntry method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
AuthorizationEntrystring0-{'Description':'The authorization entry to be modified.','HyperVEmbeddedInstance':'Msvm_ReplicationAuthorizationSettingData','In':True}
Jobref:CIM_ConcreteJob1-{'Description':'A reference to the job (can be null if the task has completed).','Out':True}
Bypass_GetObjectTrue
Description'This method modifies an authorization entry in the server.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
ModifyAuthorizationEntry method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
ModifyReplicationSettings method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which the replication setting should be modified.','In':True}
ReplicationSettingDatastring1-{'Description':'The modified setting data for the replication.','HyperVEmbeddedInstance':'Msvm_ReplicationSettingData','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'Modifies the setting data for the virtual machine replication relationship.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
ModifyReplicationSettings method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
ModifyServiceSettings method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
SettingDatastring0-{'Description':'The modified setting data for the service.','HyperVEmbeddedInstance':'Msvm_ReplicationServiceSettingData','In':True}
Jobref:CIM_ConcreteJob1-{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Bypass_GetObjectTrue
Description'Modifies the setting data for the Hyper-V Replica service.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
ModifyServiceSettings method is in 6 classes of ROOT\virtualization\v2 and in 2 namespaces
RemoveAuthorizationEntry method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
AllowedPrimaryHostSystemstring0-{'Description':'The primary server for which the authorization entry will be removed from the server.','In':True}
Jobref:CIM_ConcreteJob1-{'Description':'A reference to the job (can be null if the task has completed).','Out':True}
Bypass_GetObjectTrue
Description'This method removes an authorization entry from the server.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
RemoveAuthorizationEntry method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
RemoveReplicationRelationship method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which the replication should be removed.','In':True}
Jobref:CIM_ConcreteJob1-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Deprecated['Msvm_ReplicationService.RemoveReplicationRelationshipEx()']
Description'Removes the virtual machine replication relationship.
This does not clean up the recovery server virtual machine.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
RemoveReplicationRelationship method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
RemoveReplicationRelationshipEx method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which the replication should be removed.','In':True}
ReplicationRelationshipstring1-{'Description':'The replication relationship to remove.','HyperVEmbeddedInstance':'Msvm_ReplicationRelationship','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'Removes the virtual machine specified replication relationship.
This does not clean up the recovery server virtual machine.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
RemoveReplicationRelationshipEx method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
ResetReplicationStatistics method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the Hyper-V replica enabled virtual computer system.','In':True}
Jobref:CIM_ConcreteJob1-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Deprecated['Msvm_ReplicationService.ResetReplicationStatisticsEx()']
Description'Resets replication statistics associated with virtual machine.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
ResetReplicationStatistics method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
ResetReplicationStatisticsEx method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the Hyper-V replica enabled virtual computer system.','In':True}
ReplicationRelationshipstring1-{'Description':'The replication relationship to reset statistics for.','HyperVEmbeddedInstance':'Msvm_ReplicationRelationship','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'Resets replication statistics associated with specified replication relationship of virtual machine.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
ResetReplicationStatisticsEx method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
Resynchronize method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which Resynchronize needs to be performed.','In':True}
StartTimedatetime1-{'Description':'Scheduled start time for resynchronize operation over the network connection to recovery server.When StartTime is not specified resynchronize operation starts immediately.','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'This method performs Resynchronize operation on the given Virtual Machine.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
Resynchronize method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
ReverseReplicationRelationship method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which the replication should be reversed.','In':True}
ReplicationSettingDatastring1-{'Description':'The setting data for replication.','HyperVEmbeddedInstance':'Msvm_ReplicationSettingData','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'On recovery using this API a failed over VM can be replicated back to primary server'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
ReverseReplicationRelationship method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
RevertFailover method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which to undo failover.','In':True}
Jobref:CIM_ConcreteJob1-{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
Bypass_GetObjectTrue
Description'Undo the current failover for the virtual machine. After this operation InitiateFailover can be called again.
This operation will work only for the virtual machine which is in failedover state after using PreapreFailover.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
RevertFailover method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
SetAuthorizationEntry method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which the setting data needs to be set.','In':True}
AuthorizationEntrystring1-{'Description':'The authorization entry to be referenced.','HyperVEmbeddedInstance':'Msvm_ReplicationAuthorizationSettingData','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'This method associates the authorization setting data for virtual machine'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
SetAuthorizationEntry method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
SetFailoverNetworkAdapterSettings method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance whose network adapters are to be configured.','In':True}
NetworkSettingsstring1-{'ArrayType':'Indexed','Description':'An array of embedded instances of Msvm_FailoverNetworkAdapterSettingData objects. Each instance describes the configuration parameters for one of the network adapters within the virtual machine. The MACAddress and DHCPEnabled properties must be specified on each instance.','HyperVEmbeddedInstance':'Msvm_FailoverNetworkAdapterSettingData','In':True}
Jobref:CIM_ConcreteJob2-{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
Bypass_GetObjectTrue
Description'Configures the network adapters within the guest operating system. These configuration parameters are applied after a failover operation, immediately upon establishing communication with the KVP Exchange integration component running within the guest operating system.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
SetFailoverNetworkAdapterSettings method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
StartReplication method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which the replication should be started.','In':True}
InitialReplicationTypeuint161-{'Description':'The type of transfer to used for performing the initial replication.','In':True,'ValueMap':['1', '2', '3'],'Values':['Network Transfer', 'Export', 'Seeded Network Transfer']}
InitialReplicationExportLocationstring2-{'Description':'If InitialReplicationType has been specified as Export, this contains the fully-qualified path of the directory to which the initial replication is to be exported. This is not used for other values of InitialReplicationType, and can be null.This directory can be reused for exporting multiple virtual machine replication. This method places each virtual machine replication in a separate subdirectory under this path.','In':True}
StartTimedatetime3-{'Description':'Scheduled start time for initial replication over the network connection to recovery server.This parameter is ignored when InitialReplicationType is Export.When StartTime is not specified initial replication starts immediately.','In':True}
Jobref:CIM_ConcreteJob4-{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
Bypass_GetObjectTrue
Description'Starts the virtual machine replication.
Specify InitialReplicationType to determine the type of transfer to be used for initial replication.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
StartReplication method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces
TestReplicaSystem method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerSystemref:CIM_ComputerSystem0-{'Description':'A reference to the CIM_ComputerSystem instance for which the replication should be reversed.','In':True}
SnapshotSettingDataref:CIM_VirtualSystemSettingData1-{'Description':'The CIM_VirtualSystemSettingData instance that represents the snapshot used for creating test failover system.Pass NULL if test failover system is to be created off the latest point in time.','In':True}
ResultingSystemref:CIM_ComputerSystem2-{'Description':'If a test virtual computer system is successfully defined, a reference to an instance of class CIM_ComputerSystem that represents the newly defined test virtual computer system is returned.','Out':True}
Jobref:CIM_ConcreteJob3-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'This API created the test system for the replicated virtual machine.
User can select the snapshot from which the test system should be created. Every successful TestReplicaSystem needs to be followed by DestroySystem.
Relationship between parent system and test system can be derived from association class Msvm_AssociatedTestFailoverSystem.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
TestReplicaSystem method is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces
TestReplicationConnection method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RecoveryConnectionPointstring0-{'Description':'Name of connection point, in case of recovery cluster this is the broker CAP name and in case of standalone recovery server this is the host system name.','In':True}
RecoveryServerPortNumberuint161-{'Description':'The recovery connection point port.','In':True}
AuthenticationTypeuint162-{'Description':'The recovery authentication scheme.','In':True,'ValueMap':['1', '2'],'Values':['Integrated authentication', 'Certificate based authentication']}
CertificateThumbPrintstring3-{'Description':'Certificate thumbprint to use when AuthenticationType is certificate based authentication.','In':True}
BypassProxyServerboolean4-{'Description':'Bypass proxy server while connectng it to replica server.','In':True}
Jobref:CIM_ConcreteJob5-{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Bypass_GetObjectTrue
Description'Verifies if the replication can be enabled from the currenthost system to the specified recovery system.'
ImplementedTrue
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
TestReplicationConnection method is in 1 class (Msvm_ReplicationService) of ROOT\virtualization\v2 and in 2 namespaces

Derived methods (3) of Msvm_ReplicationService class

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'), 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':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.'}
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' shall be returned.'}
Bypass_GetObjectTrue
ImplementedTrue
ModelCorrespondence['CIM_EnabledLogicalElement.RequestedState']
ValueMap['0', '1']
Values['Completed with No Error', 'Not supported']
RequestStateChange method is in 111 classes of ROOT\virtualization\v2 and in 15 namespaces
StartService method
Returnuint32 {'out':True}
Bypass_GetObjectTrue
ImplementedTrue
ValueMap['0', '1']
Values['Completed with No Error', 'Not supported']
StartService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
StopService method
Returnuint32 {'out':True}
Bypass_GetObjectTrue
ImplementedTrue
ValueMap['0', '1']
Values['Completed with No Error', 'Not supported']
StopService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces

Detailed description of Msvm_ReplicationService properties

Derived properties (28) of Msvm_ReplicationService class

AvailableRequestedStates property
CIMTYPE'uint16'
AvailableRequestedStates property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces
Caption property
CIMTYPE'string'
Caption property is in 222 classes of ROOT\virtualization\v2 and in 37 namespaces
CommunicationStatus property
CIMTYPE'uint16'
CommunicationStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
CreationClassName property
CIMTYPE'string'
keyTrue
CreationClassName property is in 113 classes of ROOT\virtualization\v2 and in 20 namespaces
Description property
CIMTYPE'string'
Description property is in 225 classes of ROOT\virtualization\v2 and in 142 namespaces
DetailedStatus property
CIMTYPE'uint16'
DetailedStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 106 classes of ROOT\virtualization\v2 and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
EnabledState property is in 116 classes of ROOT\virtualization\v2 and in 13 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 128 classes of ROOT\virtualization\v2 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 127 classes of ROOT\virtualization\v2 and in 23 namespaces
InstanceID property
CIMTYPE'string'
InstanceID property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
Name property
CIMTYPE'string'
keyTrue
Name property is in 152 classes of ROOT\virtualization\v2 and in 142 namespaces
OperatingStatus property
CIMTYPE'uint16'
OperatingStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 107 classes of ROOT\virtualization\v2 and in 11 namespaces
PrimaryOwnerContact property
CIMTYPE'string'
PrimaryOwnerContact property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
PrimaryOwnerName property
CIMTYPE'string'
PrimaryOwnerName property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
PrimaryStatus property
CIMTYPE'uint16'
PrimaryStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
RequestedState property
CIMTYPE'uint16'
RequestedState property is in 106 classes of ROOT\virtualization\v2 and in 12 namespaces
Started property
CIMTYPE'boolean'
Started property is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
StartMode property
CIMTYPE'string'
StartMode property is in 23 classes of ROOT\virtualization\v2 and in 15 namespaces
Status property
CIMTYPE'string'
Status property is in 127 classes of ROOT\virtualization\v2 and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
SystemCreationClassName property
CIMTYPE'string'
keyTrue
SystemCreationClassName property is in 109 classes of ROOT\virtualization\v2 and in 20 namespaces
SystemName property
CIMTYPE'string'
keyTrue
SystemName property is in 109 classes of ROOT\virtualization\v2 and in 22 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 111 classes of ROOT\virtualization\v2 and in 17 namespaces
TransitioningToState property
CIMTYPE'uint16'
TransitioningToState property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces

Msvm_ReplicationService Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'Manages the failover replication for a virtual machine.'
dynamicTrue
Locale1033
provider'VmmsWmiInstanceAndMethodProvider'

Msvm_ReplicationService System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:Msvm_ReplicationService'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_Service', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT28___SYSTEM3
__RELPATH'Msvm_ReplicationService'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_Service'___SYSTEM8
__CLASS'Msvm_ReplicationService'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to Msvm_ReplicationService

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
Msvm_ReplicationServiceSettingData01101---
comments powered by Disqus
WUtils.com