Get health metrics on devices managed by the FMC (cdFMC only) - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get health metrics on devices managed by the FMC (cdFMC only)","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"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":{"description":"Get metrics that indicate the current health of all devices managed by the cdFMC. Note: For specific health metrics to be available for a given device under management of the cdFMC, the health policy for that device should be configured to collect those metrics. For example, CPU metrics will be unavailable for a device if the health policy applied to that device has CPU metric collection turned off. Note: This endpoint can only be queried twice every minute.","operationId":"getFmcHealth","parameters":[{"description":"The unique identifier, represented as a UUID, of the FMC in Security Cloud Control.","in":"path","name":"fmcUid","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The time range for which results should be retrieved.","in":"query","name":"timeRange","required":false,"schema":{"enum":["5m","15m","30m","1h"],"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"properties":{"chassisStatsHealthMetrics":{"description":"The chassis health metrics for the device.","properties":{"fan1RpmAvg":{"description":"The average speed of fan 1, if present, crucial for assessing the effectiveness of the system’s cooling mechanism under operational load.","type":"number"},"fan2RpmAvg":{"description":"The average speed of fan 2, if present, crucial for assessing the effectiveness of the system’s cooling mechanism under operational load.","type":"number"},"fan3RpmAvg":{"description":"The average speed of fan 3, if present, crucial for assessing the effectiveness of the system’s cooling mechanism under operational load.","type":"number"},"fan4RpmAvg":{"description":"The average speed of fan 4, if present, crucial for assessing the effectiveness of the system’s cooling mechanism under operational load.","type":"number"},"psu1FanStatus":{"enum":["UP","DOWN"],"type":"string"},"psu1InputStatus":{"enum":["UP","DOWN"],"type":"string"},"psu1OutputStatus":{"enum":["UP","DOWN"],"type":"string"},"psu2FanStatus":{"enum":["UP","DOWN"],"type":"string"},"psu2InputStatus":{"enum":["UP","DOWN"],"type":"string"},"psu2OutputStatus":{"enum":["UP","DOWN"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/ChassisStatsHealthMetrics"},"cpuHealthMetrics":{"description":"The CPU health metrics for the device. This value will be available only if the health policy on the device has CPU monitoring enabled.","properties":{"linaUsageAvg":{"description":"Measures the average CPU utilisation by the LINA (Cisco's ASA software running natively). Expressed as a percentage value between 0 and 100.","type":"number"},"snortUsageAvg":{"description":"Indicates the average CPU usage by the Snort process, responsible for threat detection, including intrusion prevention and advanced malware protection. Expressed as a percentage value between 0 and 100.","type":"number"},"systemUsageAvg":{"description":"Represents the total average CPU load utilised by the FTD system, including both firewall and threat defense mechanisms. Expressed as a percentage value between 0 and 100.","type":"number"}},"type":"object","$$ref":"#/components/schemas/CpuHealthMetrics"},"deviceName":{"description":"The name of the device in Security Cloud Control.","example":"Burak's FTD device","type":"string"},"deviceUid":{"description":"The unique identifier, represented as a UUID, of the device in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"diskHealthMetrics":{"description":"The disk health metrics for the device.","properties":{"totalDiskUsageAvg":{"description":"The average utilisation of disk space, important for monitoring log storage, reporting, and archiving activities which are critical for audit and diagnostics. Expressed as a percentage value between 0 and 100.","type":"number"}},"type":"object","$$ref":"#/components/schemas/DiskHealthMetrics"},"endTime":{"description":"The end of the time period (inclusive) for which the health metrics were retrieved for this device.","format":"date-time","type":"string"},"haHealthMetrics":{"description":"The HA health metrics for the device. This value will be available only if the device is part of an HA pair.","properties":{"nodeStatus":{"description":"The status of the HA node.","enum":["NORMAL","ERROR","WARNING","DISABLED","UNKNOWN"],"example":"NORMAL","type":"string"},"nodeType":{"description":"Indicates whether the device is a primary or secondary node in an HA pair.","enum":["PRIMARY","SECONDARY"],"example":"PRIMARY","type":"string"}},"type":"object","$$ref":"#/components/schemas/HaHealthMetrics"},"interfaceHealthMetrics":{"description":"The interface health metrics for the device.","items":{"properties":{"bufferOverrunsAvg":{"description":"Monitors the average number of times where incoming data exceeded buffer capacity, potentially leading to data loss.","type":"number"},"bufferUnderrunsAvg":{"description":"Tracks the average number of times the data buffer was insufficient to handle outgoing traffic, possibly causing transmission delays.","type":"number"},"dropPacketsAvg":{"description":"Average number of packets dropped by the interface due to network congestion, buffer overflow, or errors.","type":"number"},"duplexMode":{"description":"Configuration of the interface regarding data transmission, indicating whether it is set to full, half, or auto-duplex.","type":"string"},"inputBytesAvg":{"description":"Total amount of data received through the interface, providing insights into the volume of inbound traffic.","type":"number"},"inputErrorsAvg":{"description":"The average rate of erroneous packets received, indicative of issues like corruption or transmission errors.","type":"number"},"inputPacketSizeAvg":{"description":"Average size of packets received, useful for analysing the nature of inbound traffic.","type":"number"},"interface":{"description":"Identifier for a specific network interface on the FTD device, used for network traffic management and monitoring.","type":"string"},"interfaceName":{"description":"The name assigned to the interface, facilitating easier identification and configuration.","type":"string"},"interfaceType":{"description":"The physical or logical type of the interface (e.g., Ethernet, virtual, management).","type":"string"},"l2DecodeDropsAvg":{"description":"The average number of packets that could not be processed due to issues at the Data Link layer, including protocol mismatches or corruption.","type":"number"},"linkStatus":{"description":"Indicates whether the physical link of the network interface is active (UP) or inactive (DOWN). The interface will be marked as DOWN if there is no traffic through the interface.","type":"string"},"operationalStatus":{"description":"Current state of the interface from a functional standpoint, influenced by both administrative settings and physical connectivity.","type":"string"},"outputBytesAvg":{"description":"Total data sent out through the interface, useful for tracking outbound traffic levels.","type":"number"},"outputErrorsAvg":{"description":"Average count of error-ridden packets sent from the device, pointing to problems in packet formation or hardware issues.","type":"number"},"outputPacketSizeAvg":{"description":"Average size of packets sent. Helps in understanding the traffic distribution and network load.","type":"number"}},"type":"object","$$ref":"#/components/schemas/InterfaceHealthMetrics"},"type":"array"},"memoryHealthMetrics":{"description":"The memory health metrics for the device.","properties":{"linaUsageAvg":{"description":"Average memory utilisation by the LINA process. Expressed as a percentage value between 0 and 100.","type":"number"},"snortUsageAvg":{"description":"Average memory usage by the Snort engine. Expressed as a percentage value between 0 and 100.","type":"number"},"systemUsageAvg":{"description":"Provides an overview of the overall memory usage by the FTD system, useful for monitoring system health and detecting potential resource bottlenecks. Expressed as a percentage value between 0 and 100.","type":"number"}},"type":"object","$$ref":"#/components/schemas/MemoryHealthMetrics"},"raVpnSessionHealthMetrics":{"description":"The RA VPN session health metrics for the device.","properties":{"activeRavpnSessionsAvg":{"description":"The average number of active RA VPN sessions.","type":"number"},"inactiveRavpnSessionsAvg":{"description":"The average number of inactive or down RA VPN sessions.","type":"number"},"peakConcurRavpnSessions":{"description":"The peak concurrent RA VPN sessions active since the last reset.","type":"number"}},"type":"object","$$ref":"#/components/schemas/RaVpnSessionHealthMetrics"},"s2sVpnTunnelHealthMetrics":{"description":"The S2S VPN tunnel health metrics for the device. The maximum number of tunnels retrieved is 1000.","items":{"properties":{"tunnelId":{"description":"The unique identifier of the S2S VPN tunnel.","type":"string"},"tunnelName":{"description":"The name assigned to the S2S VPN tunnel.","type":"string"},"tunnelState":{"description":"The state of the S2S VPN tunnel. The possible values are TUNNEL_UP, TUNNEL_DOWN, and UNKNOWN.","enum":["TUNNEL_UP","TUNNEL_DOWN","UNKNOWN"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/S2sVpnTunnelHealthMetrics"},"type":"array"},"startTime":{"description":"The start of the time period (inclusive) for which the health metrics were retrieved for this device.","format":"date-time","type":"string"}},"type":"object","$$ref":"#/components/schemas/FmcHealthMetrics"},"type":"array"}}},"description":"FMC health metrics"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"405":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Method not allowed.","$$ref":"#/components/responses/http405MethodNotAllowed"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get health metrics on devices managed by the FMC (cdFMC only)","tags":["Inventory"],"__originalOperationId":"getFmcHealth","method":"get","path":"/v1/inventory/managers/{fmcUid}/health/metrics"}}