Remove-VMReplicationAuthorizationEntry
Remove-VMReplicationAuthorizationEntry
Removes an authorization entry from a Replica server.
Syntax
Parameter Set: PrimaryServerName
Remove-VMReplicationAuthorizationEntry [-AllowedPrimaryServer] <String> [-ComputerName <String[]> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Object
Remove-VMReplicationAuthorizationEntry [-VMReplicationAuthorizationEntry] <VMReplicationAuthorizationEntry[]> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: TrustGroup
Remove-VMReplicationAuthorizationEntry [-TrustGroup] <String> [-ComputerName <String[]> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-AllowedPrimaryServer<String>
Specifies the allowed primary server for which the authorization entry is to be removed.
Aliases |
AllowedPS |
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 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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TrustGroup<String>
Specifies the trust group for which the authorization entries are to be removed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMReplicationAuthorizationEntry<VMReplicationAuthorizationEntry[]>
Specifies the authorization entry to be removed.
Aliases |
VMRepAuthEntry |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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 removes an authorization entry on the local Replica server for allowed primary server server01.domain01.contoso.com.
PS C:\> Remove-VMReplicationAuthorizationEntry –AllowedPrimaryServer server01.domain01.contoso.com
Example 2
This example removes all authorization entries on the local Replica server.
PS C:\> Get-VMReplicationAuthorizationEntry | Remove-VMReplicationAuthorizationEntry