Remove-VMReplication Authorization Entry

Module:: hyper-v

Removes an authorization entry from a Replica server.

Syntax

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

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

Remove-VMReplicationAuthorizationEntry
      [-VMReplicationAuthorizationEntry] <VMReplicationAuthorizationEntry[]>
      [-Passthru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-VMReplicationAuthorizationEntry cmdlet removes an authorization entry from a Replica server, which cancels authorization for the primary server associated with the entry. After the authorization entry is removed, the Replica server does not accept replication data from the corresponding primary server.

Examples

Example 1

PS C:\> Remove-VMReplicationAuthorizationEntry -AllowedPrimaryServer server01.domain01.contoso.com

This example removes an authorization entry on the local Replica server for allowed primary server server01.domain01.contoso.com.

Example 2

PS C:\> Get-VMReplicationAuthorizationEntry | Remove-VMReplicationAuthorizationEntry

This example removes all authorization entries on the local Replica server.

Required Parameters

-AllowedPrimaryServer

Specifies the allowed primary server for which the authorization entry is to be removed.

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

-TrustGroup

Specifies the trust group for which the authorization entries are to be removed.

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-VMReplicationAuthorizationEntry

Specifies the authorization entry to be removed.

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

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

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

-ComputerName

Specifies one or more Hyper-V hosts on which the authorization entry is to be removed. 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
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
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
Accept pipeline input:	False
Accept wildcard characters:	False

-Passthru

Specifies that a VMReplicationAuthorizationEntry object is to be passed through to the pipeline representing the authorization entry to be removed.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
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
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

None by default; VMReplicationAuthorizationEntry if PassThru is specified.