Get CPU Profiler - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get CPU Profiler","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 CPU Profiling data of Snort modules from the specified profiler file.**","operationId":"getCPUProfiler","parameters":[{"description":"The name of the file containing the CPU Profiling data.","in":"path","name":"profilerFileName","required":true,"schema":{"type":"string"}},{"description":"The container id under which this specific resource is contained.","in":"path","name":"containerUUID","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /api/fmc_troubleshoot/v1/domain/{domainUUID}/cpuprofiler/{containerUUID}/modules/{profilerFileName} ( GET CPUProfiler by file name )":{"value":{"accessPolicyExported":"10:47:35 04-19-2023","accessPolicyName":"ACP1","endTime":"18:07:45 05-09-2023","links":{"self":"https://u45c01p14-vrouter.cisco.com:32826/api/fmc_troubleshoot/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/cpuprofiler/b1f91ce0-a158-11ed-9bf8-a640b790b57e/modules/cpu_profiling.1778474701.json"},"lsp":"lsp-rel-20230417-1250","modules":[{"avgCheckUs":800779,"callerPercentage":96.49,"checks":20,"layer":1,"name":"daq","number":1,"timeUs":16015584,"totalPercentage":96.49},{"avgCheckUs":3,"callerPercentage":0,"checks":16,"layer":1,"name":"firewall","number":3,"timeUs":51,"totalPercentage":0}],"snortVersion":"3.1.53.0-15","startTime":"17:07:45 05-09-2023","status":"DISABLED","swBuild":"1129","swVersion":"7.5.0","type":"CPUProfiler","vdb":"361"}}},"schema":{"type":"object","description":"Represents the CPU Profiler of the Snort modules.","properties":{"accessPolicyExported":{"description":"Access Control Policy revision time.","type":"string"},"accessPolicyName":{"description":"Access Control Policy name deployed to the device.","type":"string"},"description":{"type":"string"},"duration":{"description":"Duration set for the profiler to run in minutes (optional), the default is 120 minutes, range \u003c15-120\u003e minutes.","format":"int32","type":"integer"},"endTime":{"description":"The profiling session end time timestamp contained in the profiler generated file.","type":"string"},"id":{"type":"string"},"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"},"lsp":{"description":"Device Lightweight Security Package (LSP) version.","type":"string"},"message":{"description":"Contains the last command return message, or an error message if any.","type":"string"},"metadata":{"type":"object","properties":{"domain":{"type":"object","description":"The details about the domain.","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":{"type":"object","description":"This object defines details about the user.","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":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","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"},"task":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"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"},"message":{"type":"string"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"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"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"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"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"showDetailedDeviceStatus":{"type":"string"},"status":{"type":"string"},"subTasks":{"items":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"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"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"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"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"status":{"type":"string"},"target":{"type":"object","description":"This is the target device.","properties":{"description":{"type":"string"},"id":{"description":"Unique ID of the device.","type":"string"},"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","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"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"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"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"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"description":"Name of the device.","type":"string"},"type":{"description":"Device","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ITarget"}},"$$ref":"#/components/schemas/ISubTask"},"type":"array"},"taskType":{"enum":["DEVICE_REGISTRATION","SMART_LICENSE","DEVICE_DEPLOYMENT","DEVICE_ROLLBACK","NGFWHA_OPERATIONS","COPY_CONFIG_REQUEST","HIT_COUNT_REFRESH","FTD_CLUSTER_BOOTSTRAP","FTD_CLUSTER_CREATE","FTD_CLUSTER_BREAK","FTD_CLUSTER_ADD_NODES","FTD_CLUSTER_REMOVE_NODES","DEVICE_BACKUP","FTD_CLUSTER_UPDATE_BOOTSTRAP","FTD_CLUSTER_COMMAND","SSP_EPM_OIR","SSP_EPM_BREAKOUT_DEPLOY","DEVICE_EXPORT","DEVICE_IMPORT","POLICY_EXPORT","CHASSIS_REGISTRATION","CHANGE_MANAGER","CONFIGURE_DEVICE_VALIDATE","CONFIGURE_DEVICE","CONFIGURE_MANAGER","CONFIGURE_MANAGER_ADD","CONFIGURE_MANAGER_DELETE","INITIATE_MIGRATION","DISCARD_MIGRATION","SWITCH_TO_ANALYTICS","DELETE_DEVICE","GENERATE_REPORTS","FLEXCONFIG_MIGRATION","DEVICE_UNREGISTRATION","PENDING_CHANGES_REQUEST","DEVICE_TROUBLESHOOT","DEVICE_MODEL_MIGRATION","DEVICE_TEMPLATE_CREATION","CHASSIS_CONVERSION_REQUEST","SNORT_PROFILER","CPU_PROFILER","POLICY_REPORT_GENERATION","DEVICE_TEMPLATE_APPLY","LTP_ONBOARDING","POLICY_CLONE_OPERATION","DEVICE_CERTIFICATE_MANAGEMENT","OOB_CHANGES_REQUEST","UPLOAD_TROUBLESHOOT","EXECUTE_BULK_COMMANDS","FA_TELEMETRY_DATA_GENERATION"],"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/TaskStatus"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/SnortProfilerMetadata"},"modules":{"description":"Array of the Snort Modules for which the profiling was run.","items":{"type":"object","description":"Object representing a Snort module returned by the CPU Profiler.","properties":{"avgCheckUs":{"description":"Average time spent by module on each check","format":"int32","type":"integer"},"callerPercentage":{"description":"Percentage of time taken by module with respect to parent module (if module is of layer 1, then this will be same as totalPercentage).","type":"number"},"checks":{"description":"Number of times this module is called.","format":"int32","type":"integer"},"layer":{"description":"Layer of Snort module. If submodule is registered then layer increases.","format":"int32","type":"integer"},"name":{"description":"Name of the Snort module.","type":"string"},"number":{"description":"The order number of each module.","format":"int32","type":"integer"},"timeUs":{"description":"Total time spent by module for all checks.","format":"int32","type":"integer"},"totalPercentage":{"description":"Percentage of time taken by module with respect to total.","type":"number"}},"$$ref":"#/components/schemas/CPUProfilerModule"},"type":"array"},"name":{"type":"string"},"profilerFileName":{"description":"Name of the file containing the profiling data.","type":"string"},"snortVersion":{"description":"Device Snort version.","type":"string"},"startTime":{"description":"The profiling session start time timestamp contained in the profiler generated file.","type":"string"},"status":{"description":"Indicates whether the CPU Profiler is running. It can be ENABLED or DISABLED.","enum":["ENABLED","DISABLED"],"type":"string"},"swBuild":{"description":"Device Software build number.","type":"string"},"swVersion":{"description":"Device Software version.","type":"string"},"type":{"type":"string"},"vdb":{"description":"Device Vulnerability And Fingerprint Database (VDB) version.","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/CPUProfiler"}}},"description":"OK"},"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":"getCPUProfiler","method":"get","path":"/v1/cdfmc/api/fmc_troubleshoot/v1/domain/{domainUUID}/cpuprofiler/{containerUUID}/modules/{profilerFileName}"}}