Get Chassis Inventory Summary - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Chassis Inventory Summary","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 Inventory summary data from the chassis.**","operationId":"getChassisInventorySummary","parameters":[{"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"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/inventorysummary ( Example payload for GET on Chassis Inventory Summary )":{"value":{"items":[{"fanList":[{"id":1,"model":"N/A","module":1,"operability":"operable","operationalState":"operable","power":"on","thermalStatus":"ok","tray":1,"vendor":"N/A"},{"id":2,"model":"N/A","module":1,"operability":"operable","operationalState":"operable","power":"on","thermalStatus":"ok","tray":1,"vendor":"N/A"}],"memoryList":[{"array":1,"bank":0,"capacity":65536,"id":1,"model":"HMAA8GR7AJR4N-XN","operability":"operable","operationalState":"operable","performance":"ok","power":"not-supported","serialNumber":"942ECC1A","thermalStatus":"ok","vendor":"Hynix"}],"modifiedTime":"2022-07-05T06:39:25Z","powerSupplyList":[{"id":2,"model":"FPR2K-PWR-AC-400","operability":"operable","operationalState":"operable","serialNumber":"LIT24452CCQ","thermalStatus":"ok","vendor":"Cisco Systems, Inc"}],"processorList":[{"id":1,"model":"49 AMD EPYC 7282 16-Core Processor","operability":"operable","operationalState":"operable","thermalStatus":"ok","type":"CPU","vendor":"AuthenticAMD"}],"securityModuleList":[{"availableCores":24,"id":1,"model":"FPR-3120","operability":"operable","operationalState":"ok","serialNumber":"FJC25111YAW","totalCores":32,"vendor":"Cisco Systems, Inc"}],"storageControllerList":[{"id":1,"model":"FPR_SOFTRAID","operability":"unknown","operationalState":"unknown","serialNumber":"1234567","storageLocalDisk":[{"id":1,"model":"Micron_7300_MTFDHBE960TDF","operability":"operable","serialNumber":"MSA244302V7","thermalStatus":"unknown","vendor":"Cisco Systems, Inc"}],"thermalStatus":"unknown","vendor":"Cisco Systems Inc"}]}],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/inventorysummary?offset=0&limit=25&expanded=true"},"paging":{"count":1,"limit":25,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","properties":{"description":{"type":"string"},"fanList":{"description":"List of all fans on the chassis","items":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"model":{"type":"string"},"module":{"format":"int32","type":"integer"},"operability":{"type":"string"},"operationalState":{"type":"string"},"power":{"type":"string"},"serialNumber":{"type":"string"},"thermalStatus":{"type":"string"},"tray":{"format":"int32","type":"integer"},"vendor":{"type":"string"}},"$$ref":"#/components/schemas/ChassisFan"},"type":"array"},"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"},"memoryList":{"description":"List of all memory units on the chassis","items":{"type":"object","properties":{"array":{"format":"int32","type":"integer"},"bank":{"format":"int32","type":"integer"},"capacity":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"location":{"type":"string"},"model":{"type":"string"},"operability":{"type":"string"},"operationalState":{"type":"string"},"performance":{"type":"string"},"power":{"type":"string"},"serialNumber":{"type":"string"},"thermalStatus":{"type":"string"},"vendor":{"type":"string"}},"$$ref":"#/components/schemas/ChassisMemory"},"type":"array"},"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"},"modifiedTime":{"description":"Time (in ISO 8601 format) when this inventory data was obtained from chassis","type":"string"},"name":{"type":"string"},"powerSupplyList":{"description":"List of all power supplies on the chassis","items":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"model":{"type":"string"},"operability":{"type":"string"},"operationalState":{"type":"string"},"serialNumber":{"type":"string"},"thermalStatus":{"type":"string"},"vendor":{"type":"string"}},"$$ref":"#/components/schemas/ChassisPowerSupply"},"type":"array"},"processorList":{"description":"List of all processors on the chassis","items":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"model":{"type":"string"},"operability":{"type":"string"},"operationalState":{"type":"string"},"serialNumber":{"type":"string"},"thermalStatus":{"type":"string"},"type":{"type":"string"},"vendor":{"type":"string"}},"$$ref":"#/components/schemas/ChassisProcessor"},"type":"array"},"securityModuleList":{"description":"List of all security modules on the chassis","items":{"type":"object","properties":{"availableCores":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"model":{"type":"string"},"operability":{"type":"string"},"operationalState":{"type":"string"},"partNumber":{"type":"string"},"serialNumber":{"type":"string"},"totalCores":{"format":"int32","type":"integer"},"vendor":{"type":"string"}},"$$ref":"#/components/schemas/ChassisSecurityModule"},"type":"array"},"storageControllerList":{"description":"List of all storage controllers on the chassis","items":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"model":{"type":"string"},"operability":{"type":"string"},"operationalState":{"type":"string"},"partNumber":{"type":"string"},"serialNumber":{"type":"string"},"storageLocalDisk":{"items":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"model":{"type":"string"},"operability":{"type":"string"},"serialNumber":{"type":"string"},"thermalStatus":{"type":"string"},"vendor":{"type":"string"}},"$$ref":"#/components/schemas/ChassisStorageLocalDisk"},"type":"array"},"thermalStatus":{"type":"string"},"vendor":{"type":"string"}},"$$ref":"#/components/schemas/ChassisStorageController"},"type":"array"},"type":{"description":"Type of the inventory summary. This is always InventorySummary","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ChassisInventorySummary"},"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"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/ChassisInventorySummaryListContainer"}}},"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":["Chassis"],"__originalOperationId":"getChassisInventorySummary","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/inventorysummary"}}