NSX-T Data Center REST API

Create an new packet capture session

Create an new packet capture session on given node with specified options
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:

POST

URI Path(s):

/policy/api/v1/infra/pktcap/session

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

PktCaptureRequest+

PktCaptureRequest (schema)

Name	Description	Type	Notes
capamount	Packet capture amount Define the packet capture amount size.	int
capcore	The CPU core id on Edge node The CPU core id on Edge node.	int
capduration	Packet capture duration time in seconds Define the packet capture duration time. After the capture duration time, the capture process will stop working.	int
capfilesize	Packet capture file size limit Define the packet capture file size limit.	int
capmode	Packet Capture streaming mode Define the capture streaming mode. The STREAM mode will send the data to given stream address and port. And the STANDALONE mode will save the capture file in local folder.	string	Enum: STANDALONE, STREAM
cappoint	Packet capture point Define the point to capture data.	string	Required Enum: VNIC, VMKNIC, VMNIC, VDRPORT, DVFILTER, SEGMENTPORT, FCPORT, VIF, PNIC
caprate	Packet capture rate Define the rate of packet capture process.	int
capsnaplen	Packet capture snapshot length Limit the number of bytes captured from each packet.	int
capsource	Packet capture source type This type is used to differ the incoming request from CLI/UI.	string	Required Enum: CLI, UI
capvalue	Packet capture point value Define the capture value of given capture point.	string
direction	Packet capture direction type Define the capture direction. Support three types INPUT/OUTPUT/DUAL.	string	Enum: INPUT, OUTPUT, DUAL
filtertype	Packet capture dvfilter stage type Define the capture filter type. Support PRE/POST mode.	string	Enum: PRE, POST
node	Packet capture node id Define the transport node to capture data.	string
node_ip	Packet capture node ip Define the transport node to capture data.	IPAddress
options	Packet capture options Define the packet capture additional options to filter the capture data.	PktCaptureOptionList
streamaddress	Packet capture Streaming address Set the stream address to receive the capture packet.	string
streamport	Packet capture Streaming port Set the stream port to receive the capture packet. The STREAM mode is based on GRE-in-UDP Encapsulation(RFC8086). Packets are sent to UDP port 4754.	int

Example Request:

{ "node": "094f370c-d336-11e7-9776-3ba7f30fcb1f", "capsource": "CLI", "cappoint": "SEGMENTPORT", "capvalue": "502ca1f1-3958-7d8e-ffc1-48d99fa80192.001", "direction": "IN "capmode": "STANDALONE", "options": { "values":[ {"name":"IPPROTO", "value":"0x01"} ] } } }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PktCaptureSession+

PktCaptureSession (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
endtime	End time in epoch millisecond Timestamp when session was stopped in epoch millisecond.	EpochMsTimestamp
errormsg	Error messasge in capture Error messasge in capture.	string
filelocation	Packet capture file location Packet capture file location.	string
filesize	Packet capture file Size in bytes Packet capture file Size in bytes.	int
id	Unique identifier of this resource	string	Sortable
request	Packet capture request Packet capture request information.	PktCaptureRequest	Required
resource_type	Must be set to the value PktCaptureSession	string
sessionid	Packet capture session id Packet capture session id.	string	Required
sessionname	Packet capture session name Packet capture session name.	string
sessionstatus	Packet capture session status Packet capture session status.	string	Required Enum: CREATED, STARTED, STOPPED, FINISHED, ERROR
starttime	Start time in epoch millisecond Timestamp when session was created in epoch millisecond.	EpochMsTimestamp
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "request": { "node": "094f370c-d336-11e7-9776-3ba7f30fcb1f", "cappoint": "SEGMENTPORT", "capvlue": "502ca1f1-3958-7d8e-ffc1-48d99fa80192.001", "direction": "INPUT", "capmode": "STANDALONE", "options": { "values":[ {"name":"IPPROTO", "value":"0x01"} ] } }, "sessionid": "a257b981-1a1c-4b95-b16c-8646e85ce8f0", "sessionstatus": "started", "starttime": 1457048893748 }