gns3-server/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
2015-06-10 14:35:53 +02:00

1.3 KiB

/v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/start_capture

POST /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/start_capture

Start a packet capture on a VirtualBox VM instance

Parameters

  • vm_id: UUID for the instance
  • project_id: UUID for the project
  • adapter_number: Adapter to start a packet capture
  • port_number: Port on the adapter (always 0)

Response status codes

  • 200: Capture started
  • 400: Invalid request
  • 404: Instance doesn't exist

Input

Name Mandatory Type Description
capture_file_name string Capture file name