Skip to content

Latest commit

 

History

History
175 lines (130 loc) · 4.26 KB

Remove-VpnSstpProxyRule.md

File metadata and controls

175 lines (130 loc) · 4.26 KB
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
PS_VpnSstpProxyRule_v1.0.cdxml-help.xml
RemoteAccess
12/20/2016
2.0.0
Remove-VpnSstpProxyRule

Remove-VpnSstpProxyRule

SYNOPSIS

Removes one or more tenant IDs to gateway mappings for SSTP proxy.

SYNTAX

Remove-VpnSstpProxyRule [-TenantID] <String[]> [-PassThru] [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-VpnSstpProxyRule cmdlet removes one or more tenant IDs to gateway mappings for Secure Socket Tunneling Protocol (SSTP) proxy.

EXAMPLES

Example 1: Remove one or more VPN SSTP proxy rules from the server

PS C:\>Remove-VpnSstpProxyRule -TenantID "Contoso", "Woodgrove" -Force

This command removes VPN SSTP proxy rules named Contoso and Woodgrove from the server.

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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: (All)
Aliases: Session

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-TenantID

Specifies a string array of tenant IDs or group IDs to configure the SSTP proxy mapping.

Type: String[]
Parameter Sets: (All)
Aliases: GroupID

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ThrottleLimit

Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used.

The throttle limit applies only to the current command, not to the session or to the computer.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
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
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

System.String[]

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance[]

Microsoft.Management.Infrastructure.CimInstance#VpnSstpProxyRule

NOTES

RELATED LINKS

Add-VpnSstpProxyRule

Get-VpnSstpProxyRule

New-VpnSstpProxyRule

Set-VpnSstpProxyRule

Remote Access Cmdlets