Gets the replication settings for a virtual machine.
Windows Server · Risk: Low · Documentation Verified
Last verified: 2026-10-26
Microsoft Hyper-V reference: Gets the replication settings for a virtual machine. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Get-VMReplication. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / Hyper-V · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
-ComputerName
Specifies one or more Hyper-V hosts from which virtual machine replication settings are to be retrieved. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.
-Credential
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
-PrimaryServerName
Specifies the primary server of the virtual machines whose replication settings are to be retrieved.
-ReplicaServerName
Specifies the replica server name of the virtual machines whose replication settings are to be retrieved.
-ReplicationHealth
Gets replication settings for virtual machines with the specified replication health state. Valid values are Normal, Warning, and Critical.
-ReplicationMode
Gets the replication settings for virtual machines with the specified replication mode. Valid values are None, Primary, Replica, and TestReplica.
-ReplicationRelationshipType
Specifies the replication relationship type of the virtual machine. Specify whether the replication relationship is a simple primary to replica or is an extended replication chain. The cmdlet gets the replication settings for the virtual machines that have the replication type that you specify.
Specifies the trust group of the virtual machines whose replication settings you want to retrieve.
-VM (required)
Specifies the virtual machine whose replication settings are to be retrieved.
-VMName
Specifies the name of the virtual machine whose replication settings are to be retrieved.
Prerequisites
Windows with the Hyper-V module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This is a read-oriented cmdlet; protect any sensitive results and check the documented effects of your selected parameters.
Examples
Example 1
Get-VMReplication
This example gets the replication settings of all replication-enabled virtual machines on the local Hyper-V host. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.