Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Defines packet capture managed object.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
CaptureInterfaceYesNostringnone20 - Max LengthIs the name of the primary logical IP interface on which to perform the packet capture. Not configurable if performing a capture including media (RTP/RTCP) or DSP/CSME packets
CaptureInterface2YesNostringnone20 - Max LengthIs the name of the secondary logical IP interface on which to perform the packet capture. This option is only available when performing media captures.
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 LengthIP 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 LengthIP 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.
CaptureMaxPacketSizeNoNo1600Specifies 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.
CaptureDurationYesNo10Specifies the time limit for the capture in minutes.
CaptureStatusNoNoEnum0Possible values:
  • 0 - CapIdle
  • 1 - CapStopped
  • 2 - CapInProgress
Current status of capture.
CaptureResultsNoNostringnone128 - Max LengthResults of last packet capture.
CaptureTimeRemainingNoNostringnone64 - Max LengthEstimated time remaining if packet capture is in progress.