Edit

Share via


Remove-VMReplicationAuthorizationEntry

Removes an authorization entry from a Replica server.

Syntax

PrimaryServerName (Default)

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

TrustGroup

Remove-VMReplicationAuthorizationEntry
    [-TrustGroup] <String>
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential[]>]
    [-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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AllowedPS

Parameter sets

PrimaryServerName
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

PrimaryServerName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
TrustGroup
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

PrimaryServerName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
TrustGroup
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

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

Parameter properties

Type:

PSCredential[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

PrimaryServerName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
TrustGroup
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Passthru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TrustGroup

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TrustGroup
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMReplicationAuthorizationEntry

Specifies the authorization entry to be removed.

Parameter properties

Type:

VMReplicationAuthorizationEntry[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:VMRepAuthEntry

Parameter sets

Object
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Outputs

None

Default

VMReplicationAuthorizationEntry

If -PassThru is specified.