Create Packet Tracer - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Packet Tracer","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 command output for a Firewall Threat Defense or Cluster. _Check the response section for applicable examples (if any)._**","operationId":"createPacketTracer","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/trace ( Packet Tracer request )":{"value":{"destinationIPType":"IPv4","destinationIPValue":"192.168.0.136","destinationPort":"22","device":{"id":"005056B1-FFEF-0ed3-0000-004294968641","name":"Device_A","type":"Device"},"icmpType":123,"inlineTag":23,"interface":{"id":"005056B1-FFEF-0ed3-0000-004294968640","name":"Management","type":"PhysicalInterface"},"protocol":"TCP","sourceIPType":"IPv4","sourceIPValue":"192.168.0.138","sourcePort":"22"}}},"schema":{"type":"object","description":"Represents the Trace operation on the Packet Tracer feature.","properties":{"bypassChecks":{"description":"Boolean to bypass all security checks for simulated packet.","type":"boolean"},"cluster":{"description":"Boolean indicating to run the packet tracer for Cluster rather than FTD.","type":"boolean"},"decryptedPacket":{"description":"Boolean to treat simulated packet IPsec/SSL VPN decrypted.","type":"boolean"},"destinationIPType":{"description":"String representing the type of the Destination IP.","enum":["IPv4","ipv4","IPv6","ipv6","FQDN","fqdn","SecurityGroup","securitygroup"],"type":"string"},"destinationIPValue":{"description":"String representing the value of the Destination IP.","type":"string"},"destinationMacAddress":{"description":"String representing the destination MAC address.","type":"string"},"destinationPort":{"description":"String representing the destination port.","type":"string"},"device":{"description":"Object representing the device where the 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"},"deviceResponse":{"description":"List of objects representing the list of the packet tracer command output.","items":{"type":"object","description":"Represents the device response for both FTD and Cluster.","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"},"phases":{"description":"List of packet tracer phase objects containing the output from CLI.","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":"Object representing part of the response from CLI.","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"},"unitDetails":{"description":"String representing the cluster unit details.","type":"object","properties":{"ip":{"description":"String representing the value of the Cluster Node IP.","type":"string"},"name":{"description":"String representing the value of the Cluster Node Name.","type":"string"},"state":{"description":"String representing the value of the Cluster Node State.","type":"string"}},"$$ref":"#/components/schemas/IPacketTracerUnitDetails"}},"$$ref":"#/components/schemas/IPacketTracerDeviceResponse"},"type":"array"},"greEthertype":{"description":"String representing the type of the GRE Ethertype protocol.","enum":["IPv4","ipv4","IPv6","ipv6","Custom","custom"],"type":"string"},"greEthertypeCustom":{"description":"String representing the value of the GRE Ethertype Custom protocol.","type":"string"},"icmpCode":{"description":"Integer specifying the ICMP Code.","format":"int32","type":"integer"},"icmpID":{"description":"Integer representing the ICMP ID.","format":"int32","type":"integer"},"icmpType":{"description":"Integer specifying the ICMP Type.","format":"int32","type":"integer"},"inlineTag":{"description":"Integer representing the value of the inline tag.","format":"int32","type":"integer"},"innerDestinationIPType":{"description":"String representing the type of the Inner Destination IP.","enum":["ipv4","IPv4","ipv6","IPv6"],"type":"string"},"innerDestinationIPValue":{"description":"String representing the value of the Inner Destination IP.","type":"string"},"innerProtocol":{"description":"String specifying the selected Inner Protocol.","enum":["ICMP","icmp","RAWIP","rawip","SCTP","sctp","TCP","tcp","UDP","udp"],"type":"string"},"innerSourceIPType":{"description":"String representing the type of the Inner Source IP.","enum":["ipv4","IPv4","ipv6","IPv6"],"type":"string"},"innerSourceIPValue":{"description":"String representing the value of the Inner Source IP.","type":"string"},"interface":{"description":"Object representing an enabled physical 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"},"protocol":{"description":"String specifying the selected Protocol.","enum":["ESP","esp","GRE","gre","ICMP","icmp","IPIP","ipip","RAWIP","rawip","SCTP","sctp","TCP","tcp","UDP","udp"],"type":"string"},"rawIPProtocol":{"description":"Integer specifying the RAWIP protocol number.","format":"int32","type":"integer"},"sourceIPType":{"description":"String representing the type of the Source IP.","enum":["IPv4","ipv4","IPv6","ipv6","FQDN","fqdn","User","user","SecurityGroup","securitygroup"],"type":"string"},"sourceIPValue":{"description":"String representing the value of the Source IP.","type":"string"},"sourcePort":{"description":"String representing the source port.","type":"string"},"sourceSPI":{"description":"Integer specifying the SPI value for Source.","format":"int32","type":"integer"},"transmit":{"description":"Boolean to allow simulated packet to transmit from device.","type":"boolean"},"vlanId":{"description":"Integer representing the value of the VLan ID.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PacketTracer"}}},"description":"Input for Packet Tracer configuration request.","required":true},"responses":{"202":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_troubleshoot/v1/domain/{domainUUID}/packettracer/trace ( Packet Tracer request )":{"value":{"deviceResponse":[{"deviceDetails":{"id":"aec38f8e-8584-11eb-95b0-dfd8ca9743cd","name":"Cluster_Control","type":"Device"},"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"},"unitDetails":{"ip":"10.2.1.181","name":"unit-1-2","status":"Control"}}]}}},"schema":{"type":"object","description":"Represents the Trace operation on the Packet Tracer feature.","properties":{"bypassChecks":{"description":"Boolean to bypass all security checks for simulated packet.","type":"boolean"},"cluster":{"description":"Boolean indicating to run the packet tracer for Cluster rather than FTD.","type":"boolean"},"decryptedPacket":{"description":"Boolean to treat simulated packet IPsec/SSL VPN decrypted.","type":"boolean"},"destinationIPType":{"description":"String representing the type of the Destination IP.","enum":["IPv4","ipv4","IPv6","ipv6","FQDN","fqdn","SecurityGroup","securitygroup"],"type":"string"},"destinationIPValue":{"description":"String representing the value of the Destination IP.","type":"string"},"destinationMacAddress":{"description":"String representing the destination MAC address.","type":"string"},"destinationPort":{"description":"String representing the destination port.","type":"string"},"device":{"description":"Object representing the device where the 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"},"deviceResponse":{"description":"List of objects representing the list of the packet tracer command output.","items":{"type":"object","description":"Represents the device response for both FTD and Cluster.","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"},"phases":{"description":"List of packet tracer phase objects containing the output from CLI.","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":"Object representing part of the response from CLI.","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"},"unitDetails":{"description":"String representing the cluster unit details.","type":"object","properties":{"ip":{"description":"String representing the value of the Cluster Node IP.","type":"string"},"name":{"description":"String representing the value of the Cluster Node Name.","type":"string"},"state":{"description":"String representing the value of the Cluster Node State.","type":"string"}},"$$ref":"#/components/schemas/IPacketTracerUnitDetails"}},"$$ref":"#/components/schemas/IPacketTracerDeviceResponse"},"type":"array"},"greEthertype":{"description":"String representing the type of the GRE Ethertype protocol.","enum":["IPv4","ipv4","IPv6","ipv6","Custom","custom"],"type":"string"},"greEthertypeCustom":{"description":"String representing the value of the GRE Ethertype Custom protocol.","type":"string"},"icmpCode":{"description":"Integer specifying the ICMP Code.","format":"int32","type":"integer"},"icmpID":{"description":"Integer representing the ICMP ID.","format":"int32","type":"integer"},"icmpType":{"description":"Integer specifying the ICMP Type.","format":"int32","type":"integer"},"inlineTag":{"description":"Integer representing the value of the inline tag.","format":"int32","type":"integer"},"innerDestinationIPType":{"description":"String representing the type of the Inner Destination IP.","enum":["ipv4","IPv4","ipv6","IPv6"],"type":"string"},"innerDestinationIPValue":{"description":"String representing the value of the Inner Destination IP.","type":"string"},"innerProtocol":{"description":"String specifying the selected Inner Protocol.","enum":["ICMP","icmp","RAWIP","rawip","SCTP","sctp","TCP","tcp","UDP","udp"],"type":"string"},"innerSourceIPType":{"description":"String representing the type of the Inner Source IP.","enum":["ipv4","IPv4","ipv6","IPv6"],"type":"string"},"innerSourceIPValue":{"description":"String representing the value of the Inner Source IP.","type":"string"},"interface":{"description":"Object representing an enabled physical 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"},"protocol":{"description":"String specifying the selected Protocol.","enum":["ESP","esp","GRE","gre","ICMP","icmp","IPIP","ipip","RAWIP","rawip","SCTP","sctp","TCP","tcp","UDP","udp"],"type":"string"},"rawIPProtocol":{"description":"Integer specifying the RAWIP protocol number.","format":"int32","type":"integer"},"sourceIPType":{"description":"String representing the type of the Source IP.","enum":["IPv4","ipv4","IPv6","ipv6","FQDN","fqdn","User","user","SecurityGroup","securitygroup"],"type":"string"},"sourceIPValue":{"description":"String representing the value of the Source IP.","type":"string"},"sourcePort":{"description":"String representing the source port.","type":"string"},"sourceSPI":{"description":"Integer specifying the SPI value for Source.","format":"int32","type":"integer"},"transmit":{"description":"Boolean to allow simulated packet to transmit from device.","type":"boolean"},"vlanId":{"description":"Integer representing the value of the VLan ID.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PacketTracer"}}},"description":"Accepted"},"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":"createPacketTracer","method":"post","path":"/v1/cdfmc/api/fmc_troubleshoot/v1/domain/{domainUUID}/packettracer/traces"}}