Set-VMReplicationAuthorizationEntry

  • Reference
Module:
Hyper-V

Modifies an authorization entry on a Replica server.

Syntax

Set-VMReplicationAuthorizationEntry
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-AllowedPrimaryServer] <String>
   [[-ReplicaStorageLocation] <String>]
   [[-TrustGroup] <String>]
   [-Passthru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-VMReplicationAuthorizationEntry
   [-VMReplicationAuthorizationEntry] <VMReplicationAuthorizationEntry[]>
   [[-ReplicaStorageLocation] <String>]
   [[-TrustGroup] <String>]
   [-Passthru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Examples

Example 1

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

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

Example 2

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

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

Parameters

-AllowedPrimaryServer

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

Type:String
Aliases:AllowedPS
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

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

Type:CimSession[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Required:False
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReplicaStorageLocation

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.

Type:String
Aliases:StorageLoc
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrustGroup

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

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMReplicationAuthorizationEntry

Specifies the authorization entry to be set.

Type:VMReplicationAuthorizationEntry[]
Aliases:VMRepAuthEntry
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

None

Default

VMReplicationAuthorizationEntry

If -PassThru is specified.