{'Description':'A reference to the job (can be null if the task has completed).','Out':True}
Description
'This method add an authorization entry to the server. This entry is used for authorizing the connections to the recovery server.'
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\ms_409 and in 2 namespaces
{'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}
ReplicationRelationship
string
1
✓
-
{'Description':'The replication relationship to be changed as primary relationship.','In':True}
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
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.'
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\ms_409 and in 2 namespaces
{'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}
Description
'Commits the recovery snapshot that InitiateFailover has used for failover.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'Creates new replication relationship for virtual machine.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the Hyper-V replica enabled virtual computer system.','In':True}
ReplicationStatistics
string
1
-
✓
{'Description':'If successful, this object contains the array of replication statistics for the requested virtual machine. This is an embedded instance of Msvm_ReplicationStatistics.','Out':True}
ReplicationHealthIssues
string
2
-
✓
{'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.','Out':True}
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'Retrieves replication statistics associated with virtual machine.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the Hyper-V replica enabled virtual computer system.','In':True}
ReplicationRelationship
string
1
✓
-
{'Description':'The replication relationship to get statistics for.','In':True}
ReplicationStatistics
string
2
-
✓
{'Description':'If successful, this object contains the array of replication statistics for the requested virtual machine. This is an embedded instance of Msvm_ReplicationStatistics.','Out':True}
ReplicationHealthIssues
string
3
-
✓
{'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.','Out':True}
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'Retrieves replication statistics associated with specified replication relationship of virtual machine.'
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\ms_409 and in 2 namespaces
{'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}
Description
'This method returns the system certificates on a host system.'
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\ms_409 and in 2 namespaces
{'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}
Description
'Imports the virtual machine initial replication. Specify InitialReplicationImportLocation where primary server exported the replication.'
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\ms_409 and in 2 namespaces
{'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}
Description
'Sets the failover for virtual machine to application or crash consistent image.'
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\ms_409 and in 2 namespaces
{'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}
{'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}
Description
'Sets the failover for virtual machine to application or crash consistent image.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the job (can be null if the task has completed).','Out':True}
Description
'This method modifies an authorization entry in the server.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'Modifies the setting data for the virtual machine replication relationship.'
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\ms_409 and in 2 namespaces
{'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}
Description
'Modifies the setting data for the Hyper-V Replica service.'
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']
{'Description':'A reference to the job (can be null if the task has completed).','Out':True}
Description
'This method removes an authorization entry from the server.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'Removes the virtual machine replication relationship. This does not clean up the recovery server virtual machine.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'Removes the virtual machine specified replication relationship. This does not clean up the recovery server virtual machine.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'Resets replication statistics associated with virtual machine.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'Resets replication statistics associated with specified replication relationship of virtual machine.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the CIM_ComputerSystem instance for which Resynchronize needs to be performed.','In':True}
StartTime
datetime
1
✓
-
{'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}
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'This method performs Resynchronize operation on the given Virtual Machine.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'On recovery using this API a failed over VM can be replicated back to primary server'
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\ms_409 and in 2 namespaces
{'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}
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.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'This method associates the authorization setting data for virtual machine'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the CIM_ComputerSystem instance whose network adapters are to be configured.','In':True}
NetworkSettings
string
1
✓
-
{'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.','In':True}
{'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}
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.'
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\ms_409 and in 2 namespaces
{'Description':'A reference to the CIM_ComputerSystem instance for which the replication should be started.','In':True}
InitialReplicationType
uint16
1
✓
-
{'Description':'The type of transfer to used for performing the initial replication.','In':True}
InitialReplicationExportLocation
string
2
✓
-
{'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}
StartTime
datetime
3
✓
-
{'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}
{'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}
Description
'Starts the virtual machine replication. Specify InitialReplicationType to determine the type of transfer to be used for initial replication.'
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\ms_409 and in 2 namespaces
{'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}
{'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}
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
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.'
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']
{'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}
RecoveryServerPortNumber
uint16
1
✓
-
{'Description':'The recovery connection point port.','In':True}
AuthenticationType
uint16
2
✓
-
{'Description':'The recovery authentication scheme.','In':True,'Values':['Integrated authentication', 'Certificate based authentication']}
CertificateThumbPrint
string
3
✓
-
{'Description':'Certificate thumbprint to use when AuthenticationType is certificate based authentication.','In':True}
BypassProxyServer
boolean
4
✓
-
{'Description':'Bypass proxy server while connectng it to replica server.','In':True}
{'Description':'A reference to the job (can be null if the task is completed).','Out':True}
Description
'Verifies if the replication can be enabled from the currenthost system to the specified recovery system.'
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\ms_409 and in 2 namespaces