Intel® Rack Scale Design (Intel® RSD) Generic Assets Management Interface (GAMI) API Specification Software v2.3.2 September 2018 Revision 003US Document Number: 337206-003US All information provided here is subject to change without notice. Contact your Intel representative to obtain the latest Intel product specifications and roadmaps. Intel technologies’ features and benefits depend on system configuration and may require enabled hardware, software, or service activation. Performance varies depending on system configuration. No computer system can be absolutely secure. Check with your system manufacturer or retailer or learn more at www.intel.com. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document. The products described may contain design defects or errors known as errata, which may cause the product to deviate from published specifications. Current characterized errata are available on request. Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and noninfringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade. Copies of documents that have an order number and are referenced in this document may be obtained by calling 1-800-548-4725 or by visiting http://www.intel.com/design/literature.htm. Intel, Xeon, and the Intel logo are trademarks of Intel Corporation in the United States and other countries. *Other names and brands may be claimed as the property of others. Copyright © 2018 Intel Corporation. All rights reserved. Intel® RSD GAMI API Specification Software v2.3.2 September 2018 2 Document Number: 337206-003US Contents 1.0 Introduction ......................................................................................................................................................................... 14 1.1 Scope .......................................................................................................................................................................................... 14 1.2 Intended Audience ............................................................................................................................................................... 14 1.3 Conventions ............................................................................................................................................................................ 14 1.4 Notes and Symbol Convention ........................................................................................................................................ 14 1.5 Terminology ............................................................................................................................................................................ 14 1.6 References ................................................................................................................................................................................ 15 2.0 Generic Asset Management Interface ............................................................................................................................ 17 2.1 GAMI API Architecture and Design Principles ............................................................................................................ 17 2.2 GAMI API Synchronous and Asynchronous Operations ........................................................................................ 18 3.0 GAMI API Error Handling .................................................................................................................................................. 23 3.1 API Error Response ............................................................................................................................................................... 23 3.1.1 Example Error JSON Object ........................................................................................................................... 23 3.2 API Error Codes ...................................................................................................................................................................... 23 3.2.1 General Error Codes........................................................................................................................................... 23 4.0 GAMI Data Model ................................................................................................................................................................ 25 4.1 Computer System Management Module ..................................................................................................................... 25 4.2 Storage Services Management Module ........................................................................................................................ 25 4.3 Network Management Model ........................................................................................................................................... 26 4.4 Chassis Management Model ............................................................................................................................................. 26 4.5 PCIe* Fabric Management Model.................................................................................................................................... 26 4.6 Subcomponent Collections ............................................................................................................................................... 27 4.7 Mandatory and Optional Properties .............................................................................................................................. 27 5.0 GAMI API Definition ........................................................................................................................................................... 29 5.1 GAM Module Registration .................................................................................................................................................. 29 5.1.1 Request ................................................................................................................................................................... 30 5.1.2 Response ................................................................................................................................................................ 31 5.2 heartBeat .................................................................................................................................................................................. 31 5.2.1 Request ................................................................................................................................................................... 31 5.2.2 Response ................................................................................................................................................................ 32 5.3 getManagersCollection ....................................................................................................................................................... 32 5.3.1 Request ................................................................................................................................................................... 32 5.3.2 Response ................................................................................................................................................................ 33 5.4 getManagerInfo ...................................................................................................................................................................... 33 5.4.1 Request ................................................................................................................................................................... 33 5.4.2 Response ................................................................................................................................................................ 34 5.5 setComponentAttributes ................................................................................................................................................... 38 5.5.1 Request ................................................................................................................................................................... 38 5.5.2 Response ................................................................................................................................................................ 39 5.6 Set Manager Attributes ....................................................................................................................................................... 40 5.7 getTasksCollection ............................................................................................................................................................... 40 5.7.1 Request ................................................................................................................................................................... 40 5.7.2 Response ................................................................................................................................................................ 41 5.8 getTaskInfo .............................................................................................................................................................................