Start-AzVpnGatewayPacketCapture
Starts Packet Capture Operation on a Vpn Gateway.
Syntax
Start-AzVpnGatewayPacketCapture
-ResourceGroupName <String>
-Name <String>
[-FilterData <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzVpnGatewayPacketCapture
-InputObject <PSVpnGateway>
[-FilterData <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzVpnGatewayPacketCapture
-ResourceId <String>
[-FilterData <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Starts Packet Capture Operation on a Vpn Gateway.
Examples
Example 1
Start-AzVpnGatewayPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2VNG"
Code : Succeeded
EndTime : 10/1/2019 12:57:27 AM
StartTime : 10/1/2019 12:57:16 AM
ResultsText :
ResourceGroupName : PktCaptureTestSite2RG
Location : centraluseuap
ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975
Type :
Tag :
TagsTable :
Name : PktCaptureTestSite2VNG
Etag :
Id :Example 2
$a="{`"TracingFlags`":11,`"MaxPacketBufferSize`":120,`"MaxFileSize`":500,`"Filters`":[{`"SourceSubnets`":[`"10.19.0.4/32`",`"10.20.0.4/32`"],`"DestinationSubnets`":[`"10.20.0.4/32`",`"10.19.0.4/32`"],`"TcpFlags`":-1,`"Protocol`":[6],`"CaptureSingleDirectionTrafficOnly`":true}]}"
Start-AzVpnGatewayPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2VNG" -FilterData $a
Code : Succeeded
EndTime : 10/1/2019 12:57:27 AM
StartTime : 10/1/2019 12:57:16 AM
ResultsText :
ResourceGroupName : PktCaptureTestSite2RG
Location : centraluseuap
ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975
Type :
Tag :
TagsTable :
Name : PktCaptureTestSite2VNG
Etag :
Id :Parameters
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterData
Filter options for start packet capture on Vpn Gateway.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
The Vpn Gateway object where packet capture to be started.
| Type: | PSVpnGateway |
| Aliases: | VpnGateway |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The Vpn Gateway name where packet capture is to be started.
| Type: | String |
| Aliases: | ResourceName, VpnGatewayName, GatewayName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource group name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceId
The Azure resource ID of the VpnGateway where packet capture to be started.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Microsoft.Azure.Commands.Network.Models.PSVpnGatewayPacketCaptureResult