Defines packet capture managed object.
REST API Methods for this Resource
- GET packetcapture
- POST packetcapture - action enablecapture
- POST packetcapture - action startcapture
- POST packetcapture - action stopcapture
Resource Schema
Configuration
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| CaptureInterface | Yes | No | string | none | 20 - Max Length | Is the name of the primary logical IP interface on which to perform the packet capture. |
| CaptureInterface2 | Yes | No | string | none | 20 - Max Length | Is the name of the secondary logical IP interface on which to perform the packet capture. This option is only available when performing media captures. |
| CaptureIPVersion | No | No | Enum | 2 | Possible values:
| Specifies which IP version (IPv4 and/or IPv6) to capture. |
| CaptureMedia | Yes | No | Enum | 0 | Possible values:
| Specifies whether to capture media (RTP/RTCP) packets. |
| CaptureCSME | Yes | No | Enum | 0 | Possible values:
| Specifies whether to capture DSP/CSME packets. |
| CaptureHttpHttps | Yes | No | Enum | 0 | Possible values:
| Specifies whether to capture HTTP and HTTPS packets. |
| CaptureActiveDirectory | Yes | No | Enum | 0 | Possible values:
| Specifies whether to capture AD packets. |
| CaptureOther | Yes | No | Enum | 0 | Possible values:
| Specifies whether to capture other packets not specifically specified via another filter. |
| CapturePorts | No | No | string | none | 24 - 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. |
| CaptureHost1 | No | No | string | none | 255 - Max Length | IP address or FQDN of first host to capture. |
| CaptureHost1Direction | No | No | Enum | 2 | Possible values:
| Specifies which direction to capture for the first host. |
| CaptureHost2 | No | No | string | none | 255 - Max Length | IP address or FQDN of second host to capture. |
| CaptureHost2Direction | No | No | Enum | 2 | Possible values:
| Specifies which direction to capture for the second host. |
| CaptureMaxPacketSize | No | No | 1600 | Specifies whether to limit size (in bytes) for each packet captured. If this is not specified then 1600 bytes will be used. | ||
| CaptureOverwrite | Yes | No | Enum | 0 | Possible values:
| Specifies whether to overwrite capture files in round robin fashion when maximum size has been reached. |
| CaptureDuration | Yes | No | 10 | Specifies the time limit for the capture in minutes. | ||
| CaptureStatus | No | No | Enum | 0 | Possible values:
| Current status of capture. |
| CaptureResults | No | No | string | none | 128 - Max Length | Results of last packet capture. |
| CaptureTimeRemaining | No | No | string | none | 64 - Max Length | Estimated time remaining if packet capture is in progress. |
Overview
Content Tools