UniversalStopPacketCapture

Trigger this action to stop a packet capture session.

Use the HTTP POST method with the resource /mgmt/actionqueue/default, specifying a request payload with the following format:

{
  "UniversalStopPacketCapture": {
    "Filename":"filepath"
    "InterfaceType": "interface_type",
    "EthernetInterface": "Eth_interface_name",
    "VLANInterface": "VLAN_interface_name",
    "LinkAggregation": "linkagg_interface_name",
    "StandaloneStandbyControlInterface": "standalone_interface_name"
    }
}

Filename

String

Specifies the file name for the packet capture that you want to stop.

InterfaceType

String

Specifies the type of interface the packet capture is for. The following types are available:

Ethernet - Indicates that the capture is on the base Ethernet MAC interface. Traffic over any VLAN sub-interface configured on the Ethernet interface is included in the capture.
VLAN - Indicates that the capture is on an IEEE 802.1Q VLAN on top of the base Ethernet MAC interface.
Loopback - Indicates that the capture is for localhost traffic. This traffic is on the software loopback interface for Internet Protocol traffic (CIDR 127/8 in IPv4 or ::1/128 in IPv6).
Aggregate - Indicates that the capture is on an IEEE 802.3ad link aggregation interface, which is composed of one of the base Ethernet MAC interface.
Standalone - Indicates that the capture is on standalone interfaces which are configured by the underlying operating system.
All - Indicates that the capture is on all Ethernet MAC interfaces. Packets that arrive on any Ethernet MAC interfaces are captured.

EthernetInterface

String

If you have specified an InterfaceType of Ethernet, specify the name of the Ethernet interface you are stopping the packet capture for.

VLANInterface

String

If you have specified an InterfaceType of VLAN, specify the name of the VLAN interface you are stopping the packet capture for.

LinkAggregation

String

If you have specified an InterfaceType of Aggregate, specify the name of the Link Aggregation interface you are stopping the packet capture for.

StandaloneStandbyControlInterface

String

If you have specified an InterfaceType of Standalone, specify the name of the stand alone interface you are stopping the packet capture for.

Example

The following example stops the packet-capture session that writes data to the temporary:///capture-2 file on the VLAN interface named VLAN203.

To stop the packet capture session, post the following payload to https://yourhost:5554/mgmt/actionqueue/default:

{
  "UniversalStopPacketCapture": {
    "Filename": "temporary:///capture-2", 
    "InterfaceType": "VLAN",
    "Interface": "VLAN203"
  }
}