Initiate Live Packet Capture

1. Log in to the REST API server using valid management user credentials.
   

   Note

   You must forward the auth_token as a cookie with each API call.
2. Use the POST method to access the /act/live-pktcap/ URI and initiate the live packet capture.

   Sample Requests with Different Possible Input Parameters

   

   curl -X POST --cookie auth_token=$cookie http://172.16.0.24/rest/v1/act/live-pktcap 
   -d
      '{"hosts":["ap7632-9AECDC"],"url":"ftp://username:password@172.16.0.60/ge1.pcap","count":1000,
         "interface":{"direction":"inbound","interface_type":"ge1"},"session_name":"debug1"}'

   

   curl -X POST --cookie auth_token=$cookie http://172.16.0.24/rest/v1/act/live-pktcap 
   -d
      '{"hosts":["ap7632-9AECDC"],"url":"ftp://username:password@172.16.0.60/myclient.pcap","bridge":"{}","filter":"(ether
           dst D0-04-01-3B-01-70 or ether src D0-04-01-3B-01-70)"}'

   

   Request Body Parameters

   Parameter	Description	Required/Optional	Data Type
   hosts	Name of the hosts separated by comma, for which live packet capture needs to be initiated	Optional	String Array
   rf-domain	Name of the rf_domain for which the live packet capture needs to be initiated	Optional	String
   Floor	Name of the floor belonging to the rf_domain	Optional	String
   Area	Name of the area belonging to the rf_domain	Optional	String
   url	URL	Required	String
   count	Capture packet count	Optional	Integer (1-1000000)
   rate	Capture rate	Optional	Integer (1-100)
   snap	Captured data length	Optional	Integer (1-2048)
   filter	Capture filter	Optional	String
   bridge	Capture location bridge	Optional	String dictionary
   deny	Capture packets being denied	Optional	String dictonary with direction*
   direction*	Packet direction with respect to device	Optional	Enumeration ['any', 'inbound', 'outbound']
   drop	Capture location drop	Optional	String dictionary
   ext_vlan	Capture location extendend VLAN	Optional	String dictionary with direction*
   interface	Capture location interface	Optional	String dictionary with interface_type** direction*,vlan_ID***
   interface_type**	Interface Type	Required	Enumeration ['ge1', 'ge2', 'ge3', 'ge4', 'ge5', 'ge6', 'ge7', 'ge8', 'ge9', 'ge10', 'ge11', 'ge12', 'ge13', 'ge14', 'ge15', 'ge16', 'ge17', 'ge18', 'ge19', 'ge20', 'ge21', 'ge22', 'ge23', 'ge24', 'port-channel1', 'port-channel2', 'pppoe1', 'vlan', 'vmif1', 'vmif2', 'vmif3', 'vmif4', 'vmif5', 'vmif6', 'vmif7', 'vmif8', 'vmif9', 'vmif10', 'vmif11', 'vmif12', 'up1', 'up2', 'wwan1', 'xge1', 'xge2', 'xge3', 'xge4']
   vlan_id***	VLAN identifier	Optional	Integer (1-4094)
   radio	Capture location radio	Optional	String dictionary with radio_index**** direction*
   radio_index****	Radio index	Required	Enumeration ['1','2','3','all']
   vpn	Capture location vpn	Optional	String dictionary with direction*
   wireless	Capture location wireless	Optional	String dictionary with direction*
   session_name	Name to identify this session	Optional	String

   Sample Response (200 OK)

   

   {    
   "data": {        
     "status": true,        
     "message": "success"    
     },    
   "return_code": 0
   }

   

   Response Definitions

   Response Item	Description	Data Type
   return_code	A flag indicating success or failure of the operation	Boolean
   data	Data returned by the API server	String
   errors	List of errors, if any	String