You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

REST API Method: POST /rest/packetcapture?action=startcapture

This action starts a packet capture.

This action must include the packet capture options desired.

URL:

https://192.168.0.111/rest/packetcapture?action=startcapture

HTTP Method

POST

Requires Authentication:

true

packetcapture - REST API Methods

The root page @parent could not be found in space SBC 1000/2000 API.



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
CaptureInterfaceYesNostringnone20 - Max Length Is the name of the logical IP interface on which to perform the packet capture. Not configurable if performing a capture including media (RTP/RTCP) or DSP/CSME packets.
CaptureIPVersionNoNoEnum2Possible values:
  • 0 - IPV4_ADDR_MODE
  • 1 - IPV6_ADDR_MODE
  • 2 - IPV4_AND_IPV6
Specifies which IP version (IPv4 and/or IPv6) to capture.
CaptureMediaYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Specifies whether to capture media (RTP/RTCP) packets.
CaptureCSMEYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Specifies whether to capture DSP/CSME packets.
CaptureHttpHttpsYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Specifies whether to capture HTTP and HTTPS packets.
CaptureActiveDirectoryYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Specifies whether to capture AD packets.
CaptureOtherYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Specifies whether to capture other packets not specifically specified via another filter.
CapturePortsNoNostringnone24 - Max Length Specifies which ports to capture. This can include a list of up to 4 ports separated by a comma. Both TCP and UDP ports are included.
CaptureHost1NoNostringnone255 - Max Length IP address or FQDN of first host to capture.
CaptureHost1DirectionNoNoEnum2Possible values:
  • 0 - CaptureSource
  • 1 - CaptureDestination
  • 2 - CaptureBoth
Specifies which direction to capture for the first host.
CaptureHost2NoNostringnone255 - Max Length IP address or FQDN of second host to capture.
CaptureHost2DirectionNoNoEnum2Possible values:
  • 0 - CaptureSource
  • 1 - CaptureDestination
  • 2 - CaptureBoth
Specifies which direction to capture for the second host.
CaptureMaxPacketSizeNoNo1600 Specifies whether to limit size (in bytes) for each packet captured. If this is not specified then 1600 bytes will be used.
CaptureOverwriteYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Specifies whether to overwrite capture files in round robin fashion when maximum size has been reached.
CaptureDurationYesNo10 Specifies the time limit for the capture in minutes.
CaptureStatusNoNoEnum0Possible values:
  • 0 - CapIdle
  • 1 - CapStopped
  • 2 - CapInProgress
Current status of capture.
CaptureResultsNoNostringnone128 - Max Length Results of last packet capture.
CaptureTimeRemainingNoNostringnone64 - Max Length Estimated time remaining if packet capture is in progress.

  • No labels