Start-AzVirtualnetworkGatewayPacketCapture
Starts Packet Capture Operation on a Virtual Network Gateway.
Syntax
Start-AzVirtualnetworkGatewayPacketCapture
-ResourceGroupName <String>
-Name <String>
[-FilterData <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzVirtualnetworkGatewayPacketCapture
-InputObject <PSVirtualNetworkGateway>
[-FilterData <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzVirtualnetworkGatewayPacketCapture
-ResourceId <String>
[-FilterData <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Starts Packet Capture Operation on a Virtual Network Gateway.
Examples
Example 1
Start-AzVirtualnetworkGatewayPacketCapture -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-AzVirtualnetworkGatewayPacketCapture -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 :Example 3
Packet Capture example for capture all inner and outer packets
$a = "{`"TracingFlags`": 11,`"MaxPacketBufferSize`": 120,`"MaxFileSize`": 500,`"Filters`" :[{`"CaptureSingleDirectionTrafficOnly`": false}]}"
Start-AzVirtualnetworkGatewayPacketCapture -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 virtual network gateway.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
The virtual network gateway object where packet capture to be started.
| Type: | PSVirtualNetworkGateway |
| Aliases: | VirtualNetworkGateway |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The virtual network gateway name where packet capture is to be started.
| Type: | String |
| Aliases: | ResourceName, VirtualNetworkGatewayName, 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 VirtualNetworkGateway 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
PSVirtualNetworkGatewayPacketCaptureResult