Set-VMReplicationAuthorizationEntry

Set-VMReplicationAuthorizationEntry

Modifies an authorization entry on a Replica server.

Syntax

Parameter Set: Name
Set-VMReplicationAuthorizationEntry [-AllowedPrimaryServer] <String> [[-ReplicaStorageLocation] <String> ] [[-TrustGroup] <String> ] [-ComputerName <String[]> ] [-PassThru] [ <CommonParameters>]

Parameter Set: Object
Set-VMReplicationAuthorizationEntry [-VMReplicationAuthorizationEntry] <VMReplicationAuthorizationEntry[]> [[-ReplicaStorageLocation] <String> ] [[-TrustGroup] <String> ] [-PassThru] [ <CommonParameters>]

Detailed Description

The Set-VMReplicationAuthorizationEntry cmdlet modifies an authorization entry on Replica server.

Parameters

-AllowedPrimaryServer<String>

Specifies the allowed primary server of the authorization entry to be modified.

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 set. 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

-PassThru

Specifies that an object is to be passed through to the pipeline representing the replication authorization entry to be set.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ReplicaStorageLocation<String>

Specifies the location to store the Replica virtual hard disk files from the allowed server when a new Replica virtual machine is created. Modifying this location does not affect any existing virtual hard disk files on the Replica server.

Aliases	none
Required?	false
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?	false
Position?	3
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMReplicationAuthorizationEntry<VMReplicationAuthorizationEntry[]>

Specifies the authorization entry to be set.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
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.

• None by default; VMReplicationAuthorizationEntry if –PassThru is specified.

Examples

Example 1

This example sets the location of the replication authorization entry for allowed primary server server01.domain01.contoso.com to location D:\NewStorageLocation.

PS C:\> Set-VMReplicationAuthorizationEntry server01.domain01.contoso.com –ReplicaStorageLocation “D:\NewStorageLocation”

Example 2

This example sets the trust group of the replication authorization entry for allowed primary server server01.domain01.contoso.com to TrustGroup01.

PS C:\> Set-VMReplicationAuthorizationEntry server01.domain01.contoso.com –TrustGroup TrustGroup01