Msvm_ReplicationService class

Manages the replication for a virtual machine.

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

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_ReplicationService : CIM_Service
{
  string   InstanceID;
  string   Caption = "Hyper-V Replica Service";
  string   Description = "Replication Service";
  string   ElementName;
  datetime InstallDate;
  string   Name = "replicasvc";
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status = "OK";
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_ReplicationService";
  string   PrimaryOwnerName;
  string   PrimaryOwnerContact;
  string   StartMode;
  boolean  Started = True;
};

Members

The Msvm_ReplicationService class has these types of members:

Methods

The Msvm_ReplicationService class has these methods.

MethodDescription
AddAuthorizationEntry

Adds an authorization entry to a server.

ChangeReplicationModeToPrimary

Changes the extended replication relationship to the primary relationship for a replica virtual machine. The replica virtual machine must be in a failover committed state.

Windows 8.1:  This method is not supported until Windows 8.1 and Windows Server 2012 R2.

CommitFailover

Commits the recovery snapshot that the InitiateFailover method has used for a failover.

CreateReplicationRelationship

Creates a new replication relationship for a virtual machine.

GetReplicationStatistics

Retrieves replication statistics for a virtual machine.

GetReplicationStatisticsEx

Retrieves the replication statistics that are associated with specified replication relationship of the virtual machine.

Windows 8.1:  This method is not supported until Windows 8.1 and Windows Server 2012 R2.

GetSystemCertificates

Retrieves the system certificates on a host system.

ImportInitialReplica

Imports the initial replication for a virtual machine.

InitiateFailback

Initiates the failback for a recovery virtual machine. That is, sets the failover for the virtual machine to an app or crash consistent image.

Windows 8.1:  This method is not supported until Windows 8.1 and Windows Server 2012 R2.

InitiateFailover

Initiates a failover for a virtual machine to an application or standard replication point image.

ModifyAuthorizationEntry

Modifies an authorization entry on a server.

ModifyReplicationSettings

Modifies the replication settings for a virtual machine.

ModifyServiceSettings

Modifies the settings for the Hyper-V Replica service.

RemoveAuthorizationEntry

Removes the authorization entry from a server.

RemoveReplicationRelationship

Removes a virtual machine replication relationship.

RemoveReplicationRelationshipEx

Removes the specified virtual machine replication relationship. For a replica virtual machine, primary replication can't be removed if extended replication is enabled.

Windows 8.1:  This method is not supported until Windows 8.1 and Windows Server 2012 R2.

RequestStateChange

Requests a state change.

ResetReplicationStatistics

Resets the replication statistics for a virtual machine.

ResetReplicationStatisticsEx

Resets replication statistics that are associated with the specified replication relationship of a virtual machine.

Windows 8.1:  This method is not supported until Windows 8.1 and Windows Server 2012 R2.

Resynchronize

Performs a resynchronization operation on the specified virtual machine.

ReverseReplicationRelationship

Replicates a failed-over virtual machine back to the primary server.

RevertFailover

Reverts the current failover for a virtual machine by discarding the current failover disk.

SetAuthorizationEntry

Sets the replication authorization entry for a virtual machine.

SetFailoverNetworkAdapterSettings

Configures the network adapter's IP settings to be applied to a virtual machine after a failover.

StartReplication

Starts the replication of a virtual machine.

StartService

Starts the service.

StopService

Stops the service.

TestReplicaSystem

Creates a new replica of a virtual machine with the specified snapshot for testing purposes.

TestReplicationConnection

Verifies if the replication can be enabled from the current host system to the specified recovery system.

 

Properties

The Msvm_ReplicationService class has these properties.

AvailableRequestedStates
Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

Caption
Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Hyper-V Replica Service".

CommunicationStatus
Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Communication OK (2)
Lost Communication (3)
No Contact (4)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )
CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_Service, and it is always set to "Msvm_ReplicationService".

Description
Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Replication Service".

DetailedStatus
Data type: uint16
Access type: Read-only

Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Not Available (0)
No Additional Information (1)
Stressed (2)
Predictive Failure (3)
Non-Recoverable Error (4)
Supporting Entity in Error (5)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )
ElementName
Data type: string
Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement.

EnabledDefault
Data type: uint16
Access type: Read-only

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 2 (Enabled).

ValueMeaning
2

Enabled

 

EnabledState
Data type: uint16
Access type: Read-only

The enabled and disabled states of an element. It can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 2 (Enabled).

ValueMeaning
2

Enabled

 

HealthState
Data type: uint16
Access type: Read-only

The current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely nonfunctional. This property is inherited from CIM_ManagedSystemElement, and it is always set to 5 (OK).

ValueMeaning
5

The health status is normal.

 

InstallDate
Data type: datetime
Access type: Read-only

The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.

InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement, and it is always set to Null.

Name
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement, and it is always set to "replicasvc".

OperatingStatus
Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Servicing (2)
Starting (3)
Stopping (4)
Stopped (5)
Aborted (6)
Dormant (7)
Completed (8)
Migrating (9)
Emigrating (10)
Immigrating (11)
Snapshotting (12)
Shutting Down (13)
In Test (14)
Transitioning (15)
In Service (16)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )
OperationalStatus
Data type: uint16 array
Access type: Read-only

An array that contains the current statuses of the object. This property is inherited from CIM_ManagedSystemElement. The value at index zero will be one of the following values.

ValueMeaning
OK
2

The replication service is operating normally.

Error
6

One or more replication network listeners are not running. Verify that the replication service settings are valid.

 

OtherEnabledState
Data type: string
Access type: Read-only

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to Null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

PrimaryOwnerContact
Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 256 )

Any information about how the primary owner of the service can be reached (for example, phone number, email address, and so on). This property is inherited from CIM_Service, and it is always set to Null.

PrimaryOwnerName
Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 64 )

The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the service. This property is inherited from CIM_Service, and it is always set to Null.

PrimaryStatus
Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )
RequestedState
Data type: uint16
Access type: Read-only

The last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current states for an element. A particular instance of the CIM_EnabledLogicalElement class might not support the RequestedState property. If this occurs, the value 12 ("Not Applicable") is used. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 12 (Not Applicable).

ValueMeaning
12

Not applicable.

 

Started
Data type: boolean
Access type: Read-only

Indicates whether the service is currently running. This property is inherited from CIM_Service, and it is always set to True.

StartMode
Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 10 )

A string value that indicates whether the service is automatically started by a system, an operating system, or is started only upon request. This property is inherited from CIM_Service, and it is always set to Null.

Status
Data type: string
Access type: Read-only

Indicates the status of the element. This property is inherited from CIM_ManagedSystemElement, and it is always set to "OK".

StatusDescriptions
Data type: string array
Access type: Read-only

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

The scoping system's creation class name. This property is inherited from CIM_Service, and it is always set to "Msvm_ComputerSystem".

SystemName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

The NetBIOS name of the hosting computer system. This property is inherited from CIM_Service.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement.

TransitioningToState
Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Namespace

Root\Virtualization\V2

MOF

WindowsVirtualization.V2.mof

DLL

Vmms.exe

 

 

Show: