Create Packet Tracer PCAP - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Packet Tracer PCAP","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get the Packet Tracer using a PCAP file command output for Firewall Threat Defense. _Check the response section for applicable examples (if any)._**","operationId":"createPacketTracerPCAP","parameters":[{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_troubleshoot/v1/domain/{domainUUID}/packettracer/pcaptrace ( Packet Tracer PCAP request )":{"value":{"device":{"id":"005056B1-FFEF-0ed3-0000-004294968641","name":"Device_A","type":"Device"},"interface":{"id":"005056B1-FFEF-0ed3-0000-004294968640","name":"Management","type":"PhysicalInterface"},"pcapFileName":"UDP.pcap"}}},"schema":{"type":"object","description":"Represents the Trace operation using a PCAP file on the Packet Tracer feature.","properties":{"description":{"type":"string"},"device":{"description":"Object representing the device where the PCAP Trace is run.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"id":{"type":"string"},"interface":{"description":"Object representing an enabled physical, redundant, etherchannel or sub interface.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"type":"string"},"packets":{"description":"List of packet objects containing the output from the Device CLI.","items":{"type":"object","description":"Represents the object structure of the packets after the Trace operation using a PCAP file on the Packet Tracer feature is run.","properties":{"deviceDetails":{"description":"Referenced object representing the name, type and ID of the Device where the CLI command is run.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"packetDetails":{"description":"Represents some details of the packet such as interface, protocol, IPs etc.","type":"object","properties":{"details":{"description":"String representing the summary of the packet tracer command for each packet.","type":"string"},"sourceIP":{"description":"String representing the value of the Source IP.","type":"string"}},"$$ref":"#/components/schemas/IPacketTracerPCAPDetails"},"packetID":{"description":"Represents the ID of each packet returned by device CLI.","format":"int32","type":"integer"},"phases":{"description":"Represents the Packet Tracer Phase section of the CLI output.","items":{"type":"object","description":"Represents the Packet Tracer Phase section of the CLI output.","properties":{"additionalInformation":{"description":"String representing additional information.","type":"string"},"config":{"description":"String representing the phase config.","type":"string"},"elapsedTime":{"description":"String representing the phase elapsed time.","type":"string"},"id":{"description":"String representing the phase id.","format":"int32","type":"integer"},"result":{"description":"String representing the phase result.","type":"string"},"subType":{"description":"String representing the phase subtype.","type":"string"},"type":{"description":"String representing the phase type.","type":"string"}},"$$ref":"#/components/schemas/IPacketTracerPhase"},"type":"array"},"result":{"description":"Represents the Packet Tracer Result section of the CLI output.","type":"object","properties":{"action":{"description":"String representing the action taken.","type":"string"},"dropDetail":{"description":"String representing the packet drop details.","type":"string"},"dropReason":{"description":"String representing the packet drop reason.","type":"string"},"inputInterface":{"description":"String representing the input interface.","type":"string"},"inputLineStatus":{"description":"String representing the input line status.","type":"string"},"inputStatus":{"description":"String representing the input status.","type":"string"},"outputInterface":{"description":"String representing the output interface.","type":"string"},"outputLineStatus":{"description":"String representing the output line status.","type":"string"},"outputStatus":{"description":"String representing the output status.","type":"string"},"timeTaken":{"description":"String representing the execution time.","type":"string"}},"$$ref":"#/components/schemas/IPacketTracerResult"}},"$$ref":"#/components/schemas/IPacketTracerPCAPPackets"},"type":"array"},"pcapErrorMessage":{"description":"Represents the error message string coming from the device.","type":"string"},"pcapFileName":{"description":"Represents the name of a previously uploaded PCAP file on FMC.","type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/PacketTracerPCAP"}}},"description":"Input for Packet Tracer PCAP configuration request.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_troubleshoot/v1/domain/{domainUUID}/packettracer/pcaptrace ( Packet Tracer PCAP request )":{"value":{"packets":[{"deviceDetails":{"id":"3d18ea40-9c32-11eb-964d-dcad50548675","name":"192.168.0.155","type":"Device"},"packetDetails":{"details":"17:10:07.123456 input WAN tcp 1.1.1.1 1111 2.2.2.2 ssh","sourceIP":"1.1.1.1"},"packetID":1,"phases":[{"additionalInformation":"Found next-hop 203.0.113.129 using egress ifc management(vrfid:0)","config":"","elapsedTime":"9000 ns","id":1,"result":"ALLOW","subtype":"Resolve Egress Interface","type":"ROUTE-LOOKUP"},{"additionalInformation":"","config":"","elapsedTime":"9000 ns","id":2,"result":"DROP","subtype":"mgmt-deny-all","type":"ACCESS-LIST"}],"result":{"action":"drop","dropDetail:":"Drop-location: frame snp_classify_table_lookup:5046 flow (NA)/N","dropReason":"(acl-drop) Flow is denied by configured rule","inputInterface":"management(vrfid:0)","inputLineStatus":"up","inputStatus":"up","outputInterface":"management(vrfid:0)","outputLineStatus":"up","outputStatus":"up","time-taken":"30381 ns"}},{"deviceDetails":{"id":"3d18ea40-9c32-11eb-964d-dcad50548675","name":"192.168.0.155","type":"Device"},"packetDetails":{"details":"17:10:07.123456 input WAN tcp 3.3.3.3 1111 4.4.4.4 ssh","sourceIP":"3.3.3.3"},"packetID":2,"phases":[{"additionalInformation":"Found next-hop 203.0.113.129 using egress ifc management(vrfid:0)","config":"","elapsedTime":"9000 ns","id":1,"result":"ALLOW","subtype":"Resolve Egress Interface","type":"ROUTE-LOOKUP"},{"additionalInformation":"","config":"","elapsedTime":"9000 ns","id":2,"result":"DROP","subtype":"mgmt-deny-all","type":"ACCESS-LIST"}],"result":{"action":"drop","dropDetail:":"Drop-location: frame snp_classify_table_lookup:5046 flow (NA)/N","dropReason":"(acl-drop) Flow is denied by configured rule","inputInterface":"management(vrfid:0)","inputLineStatus":"up","inputStatus":"up","outputInterface":"management(vrfid:0)","outputLineStatus":"up","outputStatus":"up","time-taken":"30381 ns"}}],"pcapErrorMessage":""}}},"schema":{"type":"object","description":"Represents the Trace operation using a PCAP file on the Packet Tracer feature.","properties":{"description":{"type":"string"},"device":{"description":"Object representing the device where the PCAP Trace is run.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"id":{"type":"string"},"interface":{"description":"Object representing an enabled physical, redundant, etherchannel or sub interface.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"type":"string"},"packets":{"description":"List of packet objects containing the output from the Device CLI.","items":{"type":"object","description":"Represents the object structure of the packets after the Trace operation using a PCAP file on the Packet Tracer feature is run.","properties":{"deviceDetails":{"description":"Referenced object representing the name, type and ID of the Device where the CLI command is run.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"packetDetails":{"description":"Represents some details of the packet such as interface, protocol, IPs etc.","type":"object","properties":{"details":{"description":"String representing the summary of the packet tracer command for each packet.","type":"string"},"sourceIP":{"description":"String representing the value of the Source IP.","type":"string"}},"$$ref":"#/components/schemas/IPacketTracerPCAPDetails"},"packetID":{"description":"Represents the ID of each packet returned by device CLI.","format":"int32","type":"integer"},"phases":{"description":"Represents the Packet Tracer Phase section of the CLI output.","items":{"type":"object","description":"Represents the Packet Tracer Phase section of the CLI output.","properties":{"additionalInformation":{"description":"String representing additional information.","type":"string"},"config":{"description":"String representing the phase config.","type":"string"},"elapsedTime":{"description":"String representing the phase elapsed time.","type":"string"},"id":{"description":"String representing the phase id.","format":"int32","type":"integer"},"result":{"description":"String representing the phase result.","type":"string"},"subType":{"description":"String representing the phase subtype.","type":"string"},"type":{"description":"String representing the phase type.","type":"string"}},"$$ref":"#/components/schemas/IPacketTracerPhase"},"type":"array"},"result":{"description":"Represents the Packet Tracer Result section of the CLI output.","type":"object","properties":{"action":{"description":"String representing the action taken.","type":"string"},"dropDetail":{"description":"String representing the packet drop details.","type":"string"},"dropReason":{"description":"String representing the packet drop reason.","type":"string"},"inputInterface":{"description":"String representing the input interface.","type":"string"},"inputLineStatus":{"description":"String representing the input line status.","type":"string"},"inputStatus":{"description":"String representing the input status.","type":"string"},"outputInterface":{"description":"String representing the output interface.","type":"string"},"outputLineStatus":{"description":"String representing the output line status.","type":"string"},"outputStatus":{"description":"String representing the output status.","type":"string"},"timeTaken":{"description":"String representing the execution time.","type":"string"}},"$$ref":"#/components/schemas/IPacketTracerResult"}},"$$ref":"#/components/schemas/IPacketTracerPCAPPackets"},"type":"array"},"pcapErrorMessage":{"description":"Represents the error message string coming from the device.","type":"string"},"pcapFileName":{"description":"Represents the name of a previously uploaded PCAP file on FMC.","type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/PacketTracerPCAP"}}},"description":"Created"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Troubleshoot"],"__originalOperationId":"createPacketTracerPCAP","method":"post","path":"/v1/cdfmc/api/fmc_troubleshoot/v1/domain/{domainUUID}/packettracer/pcaptraces"}}