Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Remove-VMReplicationAuthorizationEntry

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Removes an authorization entry from a Replica server.

SYNTAX

PrimaryServerName (Default)

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

TrustGroup

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

Object

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.

PARAMETERS

-AllowedPrimaryServer

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

Type: String
Parameter Sets: PrimaryServerName
Aliases: AllowedPS

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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[]
Parameter Sets: PrimaryServerName, TrustGroup
Aliases: 

Required: False
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[]
Parameter Sets: PrimaryServerName, TrustGroup
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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[]
Parameter Sets: PrimaryServerName, TrustGroup
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

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

-TrustGroup

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

Type: String
Parameter Sets: TrustGroup
Aliases: 

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

-VMReplicationAuthorizationEntry

Specifies the authorization entry to be removed.

Type: VMReplicationAuthorizationEntry[]
Parameter Sets: Object
Aliases: VMRepAuthEntry

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

None by default; VMReplicationAuthorizationEntry if PassThru is specified.

NOTES

© 2017 Microsoft