az network vpn-gateway connection packet-capture

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az network vpn-gateway connection packet-capture command. Learn more about extensions.

Manage site-to-site VPN gateway connections packet capture.

Commands

Name	Description	Type	Status
az network vpn-gateway connection packet-capture start	Starts packet capture on Vpn connection in the specified resource group.	Extension	GA

az network vpn-gateway connection packet-capture start

Starts packet capture on Vpn connection in the specified resource group.

az network vpn-gateway connection packet-capture start [--connection-name --name]
                                                       [--filter-data]
                                                       [--gateway-name]
                                                       [--ids]
                                                       [--link-connection-names]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--resource-group]
                                                       [--subscription]

Examples

Starts packet capture on Vpn connection.

az network  vpn-gateway connection packet-capture start -g MyResourceGroup --gateway-name MyVpnGateway --connection-name MyVpnGatewayConnection --link-connection-names MyVpnGatewayConnection

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-name --name -n

The name of the vpn connection.

Property	Value
Parameter group:	Resource Id Arguments

--filter-data

Start Packet capture parameters on vpn connection.

Property	Value
Parameter group:	Parameters Arguments

--gateway-name

The name of the gateway.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--link-connection-names

List of site link connection names. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False