Set-HyperVReplicationConfig

Hyper-V: Configures Hyper-V Replica settings on a host

Script

#Requires -Version 5.1
#Requires -Modules Hyper-V

[CmdletBinding()]
Param (
    [string]$ComputerName = "localhost",

    [PSCredential]$Credential,

    [Parameter(Mandatory = $true)]
    [bool]$Enabled,

    [ValidateSet('Kerberos', 'Certificate', 'Integrated')]
    [string]$AuthenticationType,

    [int]$KerberosPort,

    [int]$CertificatePort,

    [string]$CertificateThumbprint,

    [string]$DefaultStorageLocation,

    [bool]$AllowAnyServer
)

Process {
    try {
        $params = @{
            'ComputerName'       = $ComputerName
            'ReplicationEnabled' = $Enabled
            'Confirm'            = $false
            'ErrorAction'        = 'Stop'
        }
        if ($Credential) { $params.Add('Credential', $Credential) }
        
        if ($Enabled) {
            if ($AuthenticationType) { $params.Add('AllowedAuthenticationType', $AuthenticationType) }
            if ($PSBoundParameters.ContainsKey('KerberosPort')) { $params.Add('KerberosAuthenticationPort', $KerberosPort) }
            if ($PSBoundParameters.ContainsKey('CertificatePort')) { $params.Add('CertificateAuthenticationPort', $CertificatePort) }
            if ($CertificateThumbprint) { $params.Add('CertificateThumbprint', $CertificateThumbprint) }
            if ($DefaultStorageLocation) { $params.Add('DefaultStorageLocation', $DefaultStorageLocation) }
            if ($PSBoundParameters.ContainsKey('AllowAnyServer')) { $params.Add('ReplicationAllowedFromAnyServer', $AllowAnyServer) }
        }

        Set-VMReplicationServer @params

        $serverInfo = Get-VMReplicationServer -ComputerName $ComputerName -ErrorAction Stop
        
        $result = [PSCustomObject]@{
            ComputerName              = $serverInfo.ComputerName
            ReplicationEnabled        = $serverInfo.ReplicationEnabled
            AllowedAuthenticationType = $serverInfo.AllowedAuthenticationType
            DefaultStorageLocation    = $serverInfo.DefaultStorageLocation
            Action                    = "ReplicationConfigUpdated"
            Status                    = "Success"
            Timestamp                 = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
        }

        Write-Output $result
    }
    catch {
        throw
    }
}

Customize

ComputerName string

Specifies the name of the Hyper-V host. Defaults to the local machine.

Credential PSCredential

Specifies the credentials to use for the remote connection.

Enabled bool

Specifies whether the host is enabled as a Replica server ($true) or disabled ($false).

AuthenticationType string

Optional. Specifies the allowed authentication type (Kerberos, Certificate, or Integrated).

KerberosPort int

Optional. Specifies the port for Kerberos (HTTP) authentication. Defaults to 80.

CertificatePort int

Optional. Specifies the port for Certificate (HTTPS) authentication. Defaults to 443.

CertificateThumbprint string

Optional. Specifies the thumbprint of the certificate for mutual authentication.

DefaultStorageLocation string

Optional. Specifies the default folder for storing replicated virtual machines.

AllowAnyServer bool

Optional. If set to $true, allows replication from any authenticated server.