New-VMReplicationAuthorizationEntry

New-VMReplicationAuthorizationEntry

Creates a new authorization entry that allows one or more primary servers to replicate data to a specified Replica server.

Syntax

Parameter Set: Default
New-VMReplicationAuthorizationEntry [-AllowedPrimaryServer] <String> [-ReplicaStorageLocation] <String> [-TrustGroup] <String> [-ComputerName <String[]> ] [ <CommonParameters>]

Detailed Description

The New-VMReplicationAuthorizationEntry cmdlet creates a new authorization entry that allows one or more primary servers to replicate data. To use this cmdlet, the value of the ReplicationAllowedFromAnyServer property of the Replica server must be false. You can use the Get-VMReplicationServer cmdlet to check the value of this property.

Parameters

-AllowedPrimaryServer<String>

Specifies the server that is allowed to send replication data to the Replica server. Only fully-qualified domain names and fully qualified international domain names are supported. You can use a wildcard (for example, “*”) in the first octect to specify a fully qualified domain name, such as *.contoso.com.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which the authorization entry is to be created. 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.

Aliases

none

Required?

false

Position?

named

Default Value

.

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReplicaStorageLocation<String>

Specifies the location to store the Replica virtual hard disk files sent from the allowed server when a new Replica virtual machine is created.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TrustGroup<String>

Identifies a group of primary servers within which a given primary virtual machine can move so replications of the primary virtual machine are accepted by the Replica server only from primary servers that belong to the trust group. You can use any string to create a new trust group. Ensure all primary servers within a specific trust group use the same string as the value you specify for this parameter.

Use of a trust group can help you keep virtual machines isolated by maintaining control over which primary servers are trusted to provide replication, while also allowing the virtual machines to move from one primary server to another (such as through live migration or failover from a cluster node).

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • VMReplicationAuthorizationEntry

Examples

Example 1

This example creates a replication authorization entry on the local server for a primary server named server01.domain01.contoso.com and a trust group named DEFAULT. It also specifies D:\ReplicaVMStorage as the location to create replica virtual hard disks for virtual machines replicated from server01.domain01.contoso.com.

PS C:\> New-VMReplicationAuthorizationEntry server01.domain01.contoso.com D:\ReplicaVMStorage DEFAULT

Example 2

This example creates a replication authorization entry on server server02.domain01.contoso.com that allows replication from all primary servers in the domain domain01.contoso.com that also belong to the trust group MyDomain01. It also specifies D:\ReplicaVMStorage as the location to create replica virtual hard disks for virtual machines replicated from these allowed primary servers.

PS C:\> New-VMReplicationAuthorizationEntry *.domain01.contoso.com D:\ReplicaVMStorage MyDomain01 –ComputerName server02.domain01.contoso.com