Intel® Rack Scale Design Generic Assets Management Interface … · Assets Management Interface (GAMI) API Specification v2.2 December 19, 2017 . Revision 001 . Intel® Rack Scale

Document Number: 336859-001

Intel® Rack Scale Design Generic Assets Management Interface (GAMI) API Specification v2.2

December 19, 2017

Revision 001

Intel® Rack Scale Design Generic Assets Management Interface (GAMI) API Specification v2.2 December 19, 2017 2 Document Number: 336859-001

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 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 © 2017 Intel Corporation. All rights reserved.

http://www.intel.com/design/literature.htm

Intel® Rack Scale Design Generic Assets Management Interface (GAMI) December 19, 2017 API Specification v2.2 Document Number: 336859-001 3

Contents 1 Introduction ......................................................................................................................................................................... 14

Scope .......................................................................................................................................................................................... 14 Intended audience ................................................................................................................................................................ 14 Terminology ............................................................................................................................................................................ 14 References ................................................................................................................................................................................ 15 Conventions ............................................................................................................................................................................ 15 Notes and Symbol Convention ........................................................................................................................................ 15

2 Generic Asset Management Interface ............................................................................................................................ 17 GAMI API architecture and design principles ............................................................................................................. 17 GAMI API synchronous and asynchronous operations .......................................................................................... 18

3 GAMI API Error Handling .................................................................................................................................................. 22 API error response ................................................................................................................................................................ 22

Example error JSON object ................................................................................................................... 22 API error codes ....................................................................................................................................................................... 22

General error codes .................................................................................................................................. 22 4 GAMI Data Model ................................................................................................................................................................ 24

Computer System management module .................................................................................................................... 24 Storage Services management module ....................................................................................................................... 24 Network management model ........................................................................................................................................... 25 Chassis management model............................................................................................................................................. 25 PCIe* Fabric management model ................................................................................................................................... 25 Subcomponent collections ............................................................................................................................................... 26 Mandatory and Optional properties .............................................................................................................................. 26

5 GAMI API definition ............................................................................................................................................................ 28 GAM Module Registration .................................................................................................................................................. 28

Request .......................................................................................................................................................... 29 Response ....................................................................................................................................................... 30

heartBeat .................................................................................................................................................................................. 30 Request .......................................................................................................................................................... 30 Response ....................................................................................................................................................... 31

getManagersCollection ....................................................................................................................................................... 31 Request .......................................................................................................................................................... 31 Response ....................................................................................................................................................... 32

getManagerInfo ...................................................................................................................................................................... 32 Request .......................................................................................................................................................... 32 Response ....................................................................................................................................................... 33

setComponentAttributes ................................................................................................................................................... 37 Request .......................................................................................................................................................... 37 Response ....................................................................................................................................................... 38

Set Manager Attributes ....................................................................................................................................................... 39 getTasksCollection ............................................................................................................................................................... 39


getTaskInfo .............................................................................................................................................................................. 40 Request .......................................................................................................................................................... 40 Response ....................................................................................................................................................... 41


deleteTask ................................................................................................................................................................................ 42 Request .......................................................................................................................................................... 42 Response ....................................................................................................................................................... 43

getTaskResult ......................................................................................................................................................................... 43 Request .......................................................................................................................................................... 43 Response ....................................................................................................................................................... 44

getCollection ........................................................................................................................................................................... 44 Request .......................................................................................................................................................... 44 Response ....................................................................................................................................................... 45

componentNotification ....................................................................................................................................................... 45 Notification ................................................................................................................................................... 46

getComputerSystemInfo .................................................................................................................................................... 47 Request .......................................................................................................................................................... 47 Response ....................................................................................................................................................... 47

Set Computer System Attributes .................................................................................................................................... 51 getProcessorInfo ................................................................................................................................................................... 52


getMemoryInfo ....................................................................................................................................................................... 56 Request .......................................................................................................................................................... 56 Response ....................................................................................................................................................... 57

getStorageSubsystemInfo ................................................................................................................................................. 61 Request .......................................................................................................................................................... 61 Response ....................................................................................................................................................... 61

Set Storage Subsystem Attributes ................................................................................................................................. 63 getStorageControllerInfo ................................................................................................................................................... 63


getDriveInfo ............................................................................................................................................................................. 66 Request .......................................................................................................................................................... 66 Response ....................................................................................................................................................... 66

Set Drive Attributes .............................................................................................................................................................. 70 getNetworkInterfaceInfo .................................................................................................................................................... 70


Set Network Interface Attributes .................................................................................................................................... 74 getTrustedModuleInfo ........................................................................................................................................................ 74


Set Trusted Module Attributes ........................................................................................................................................ 76 getFabricInfo ........................................................................................................................................................................... 76


getSwitchInfo .......................................................................................................................................................................... 78 Request .......................................................................................................................................................... 78 Response ....................................................................................................................................................... 79

Set Switch Attributes ........................................................................................................................................................... 81 getPortInfo ............................................................................................................................................................................... 81


Set Port Attributes ................................................................................................................................................................ 83


getEndpointInfo ..................................................................................................................................................................... 83 Request .......................................................................................................................................................... 83 Response ....................................................................................................................................................... 84

getPCIeDeviceInfo ................................................................................................................................................................. 86 Request .......................................................................................................................................................... 86 Response ....................................................................................................................................................... 87

Set PCIe* Device Attributes ............................................................................................................................................... 89 getPCIeFunctionInfo ............................................................................................................................................................ 89


getZoneInfo ............................................................................................................................................................................. 91 Request .......................................................................................................................................................... 91 Response ....................................................................................................................................................... 92

addZone .................................................................................................................................................................................... 93 Request .......................................................................................................................................................... 93 Response ....................................................................................................................................................... 94

deleteZone ............................................................................................................................................................................... 94 Request .......................................................................................................................................................... 94 Response ....................................................................................................................................................... 95

Add Zone Endpoints ............................................................................................................................................................ 95 Request .......................................................................................................................................................... 95 Response ....................................................................................................................................................... 96

deleteZoneEndpoints .......................................................................................................................................................... 96 Request .......................................................................................................................................................... 96 Response ....................................................................................................................................................... 97

getEthernetSwitchInfo ........................................................................................................................................................ 97 Request .......................................................................................................................................................... 97 Response ....................................................................................................................................................... 98

Set Ethernet Switch Attributes ..................................................................................................................................... 101 getEthernetSwitchPortInfo ............................................................................................................................................. 102

Request ....................................................................................................................................................... 102 Response .................................................................................................................................................... 102

Set Ethernet Switch Port Attributes ............................................................................................................................ 106 addEthernetSwitchPort ................................................................................................................................................... 106


deleteEthernetSwitchPort .............................................................................................................................................. 108 Request ....................................................................................................................................................... 108 Response .................................................................................................................................................... 108

addEthernetSwitchPortMembers ................................................................................................................................ 109 Request ....................................................................................................................................................... 109 Response .................................................................................................................................................... 110

Delete Ethernet Switch Port Members ...................................................................................................................... 110 Request ....................................................................................................................................................... 110 Response .................................................................................................................................................... 111

getEthernetSwitchVxlanInfo .......................................................................................................................................... 111 Request ....................................................................................................................................................... 111 Response .................................................................................................................................................... 112

addEthernetSwitchVxlan ................................................................................................................................................. 113 Request ....................................................................................................................................................... 113 Response .................................................................................................................................................... 114


deleteEthernetSwitchVxlan ............................................................................................................................................ 114 Request ....................................................................................................................................................... 114 Response .................................................................................................................................................... 115

Get Remote Ethernet Switch Info ................................................................................................................................ 115 Request ....................................................................................................................................................... 115 Response .................................................................................................................................................... 116

getVlanInfo ........................................................................................................................................................................... 117 Request ....................................................................................................................................................... 117 Response .................................................................................................................................................... 118

Set VLAN Attributes .......................................................................................................................................................... 119 addVlan .................................................................................................................................................................................. 119


deleteVlan ............................................................................................................................................................................. 120 Request ....................................................................................................................................................... 120 Response .................................................................................................................................................... 121

getPortVlanInfo ................................................................................................................................................................... 121 Request ....................................................................................................................................................... 121 Response .................................................................................................................................................... 122

Set Port VLAN Attributes ................................................................................................................................................. 123 addPortVlan ......................................................................................................................................................................... 123


deletePortVlan .................................................................................................................................................................... 124 Request ....................................................................................................................................................... 124 Response .................................................................................................................................................... 125

getPortStaticMacInfo ........................................................................................................................................................ 125 Request ....................................................................................................................................................... 125 Response .................................................................................................................................................... 126

Set Port Static MAC Attributes ...................................................................................................................................... 127 addPortStaticMac ............................................................................................................................................................... 127


deletePortStaticMac .......................................................................................................................................................... 128 Request ....................................................................................................................................................... 128 Response .................................................................................................................................................... 129

getAclInfo .............................................................................................................................................................................. 129 Request ....................................................................................................................................................... 129 Response .................................................................................................................................................... 130

addAcl ..................................................................................................................................................................................... 131 Request ....................................................................................................................................................... 131 Response .................................................................................................................................................... 132

deleteAcl ................................................................................................................................................................................ 132 Request ....................................................................................................................................................... 132 Response .................................................................................................................................................... 133

addAclPort ............................................................................................................................................................................ 133 Request ....................................................................................................................................................... 133 Response .................................................................................................................................................... 134

deleteAclPort ....................................................................................................................................................................... 134 Request ....................................................................................................................................................... 134 Response .................................................................................................................................................... 135


getAclRuleInfo ..................................................................................................................................................................... 135 Request ....................................................................................................................................................... 136 Response .................................................................................................................................................... 136

addAclRule ............................................................................................................................................................................ 139 Request ....................................................................................................................................................... 139 Response .................................................................................................................................................... 141

deleteAclRule ....................................................................................................................................................................... 141 Request ....................................................................................................................................................... 141 Response .................................................................................................................................................... 142

Set ACL Rule Attributes ................................................................................................................................................... 142 getChassisInfo ..................................................................................................................................................................... 143


Set Chassis Attributes ....................................................................................................................................................... 146 getPowerZoneInfo ............................................................................................................................................................. 147


getPsuInfo ............................................................................................................................................................................. 149 Request ....................................................................................................................................................... 149 Response .................................................................................................................................................... 149

Set PSU Attributes ............................................................................................................................................................. 151 getThermalZoneInfo ......................................................................................................................................................... 151


Set Thermal Zone Attributes ......................................................................................................................................... 154 getFanInfo ............................................................................................................................................................................. 154


getChassisSensorInfo ....................................................................................................................................................... 156 Request ....................................................................................................................................................... 156 Response .................................................................................................................................................... 156

Set Fan Attributes .............................................................................................................................................................. 158 Get Authorization Certificate ......................................................................................................................................... 158


getStorageServicesInfo .................................................................................................................................................... 159 Request ....................................................................................................................................................... 159 Response .................................................................................................................................................... 160

getPhysicalDriveInfo ......................................................................................................................................................... 161 Request ....................................................................................................................................................... 161 Response .................................................................................................................................................... 162

getLogicalDriveInfo ........................................................................................................................................................... 163 Request ....................................................................................................................................................... 163 Response .................................................................................................................................................... 164

addLogicalDrive .................................................................................................................................................................. 166 Request ....................................................................................................................................................... 166 Response .................................................................................................................................................... 167

deleteLogicalDrive ............................................................................................................................................................. 168 Request ....................................................................................................................................................... 168 Response .................................................................................................................................................... 168

Set Logical Drive Attributes ............................................................................................................................................ 169


getiSCSITargetInfo ............................................................................................................................................................. 169 Request ....................................................................................................................................................... 169 Response .................................................................................................................................................... 169

Set iSCSI Target Attributes ............................................................................................................................................. 171 addiSCSITarget .................................................................................................................................................................... 171


deleteiSCSITarget .............................................................................................................................................................. 173 Request ....................................................................................................................................................... 173 Response .................................................................................................................................................... 174

getMetricDefinitionsCollection ..................................................................................................................................... 174 Request ....................................................................................................................................................... 174 Response .................................................................................................................................................... 174

getMetricDefinitionInfo .................................................................................................................................................... 175 Request ....................................................................................................................................................... 175 Response .................................................................................................................................................... 176

Set Sensor Definition Attributes .................................................................................................................................. 179 Get Metrics ............................................................................................................................................................................ 179

Request ....................................................................................................................................................... 180 Response .................................................................................................................................................... 180 Example Sensors by Asset Type ....................................................................................................... 181

6 GAMI Commands Support Requirements .................................................................................................................. 183

Figures

Figure 1. Generic Assets Management Interface in the PSME Architecture ..................................................................... 17 Figure 2. Sample Asynchronous Communication ....................................................................................................................... 19 Figure 3. Computer System Management Data Model ............................................................................................................. 24 Figure 4. Storage Services Management Data Model ................................................................................................................ 24 Figure 5. Network Management Data Model ................................................................................................................................ 25 Figure 6. Chassis Management Data Model .................................................................................................................................. 25 Figure 7. PCIe* Fabric Management Data model ......................................................................................................................... 25 Figure 8. PSME Generic Asset Management Interface API Communication Overview ................................................ 28

Tables

Table 1. Terminology ............................................................................................................................................................................ 14 Table 2. Document References ......................................................................................................................................................... 15 Table 3. General Error Codes ............................................................................................................................................................. 22 Table 4. GAMI subcomponent collection definition ................................................................................................................. 26 Table 5. GAM Module Registration Request ................................................................................................................................ 29 Table 6. GAM Module Registration Response ............................................................................................................................. 30 Table 7. Heartbeat Command Request .......................................................................................................................................... 30 Table 8. heartBeat Command Response ....................................................................................................................................... 31 Table 9. getManagersCollection response ................................................................................................................................... 32 Table 10. Get Manager Info Request ................................................................................................................................................. 32 Table 11. getManagerInfo Response ................................................................................................................................................. 33 Table 12. setComponentAttributes Request ................................................................................................................................. 37 Table 13. setComponentAttributes response ............................................................................................................................... 38 Table 14. Configurable Manager Attributes ................................................................................................................................... 39


Table 15. getTasksCollection Response .......................................................................................................................................... 40 Table 16. getTaskInfo Request ............................................................................................................................................................ 40 Table 17. getTaskInfo response .......................................................................................................................................................... 41 Table 18. deleteTask request ............................................................................................................................................................... 42 Table 19. deleteTask response ............................................................................................................................................................ 43 Table 20. Get Task Result Request ..................................................................................................................................................... 43 Table 21. getTaskResult Response .................................................................................................................................................... 44 Table 22. getCollection Request ......................................................................................................................................................... 44 Table 23. getCollection Response ...................................................................................................................................................... 45 Table 24. componentNotification ....................................................................................................................................................... 46 Table 25. getComputerSystemInfo Request .................................................................................................................................. 47 Table 26. getComputerSystemInfo Response ............................................................................................................................... 47 Table 27. Configurable Computer System Attributes ................................................................................................................ 51 Table 28. getProcessorInfo Request ................................................................................................................................................. 52 Table 29. getProcessorInfo Response .............................................................................................................................................. 52 Table 30. getMemoryInfo Request ..................................................................................................................................................... 56 Table 31. getMemoryInfo Response .................................................................................................................................................. 57 Table 32. Get Storage Subsystem Info Request ........................................................................................................................... 61 Table 33. Get Storage Subsystem Info Response ........................................................................................................................ 61 Table 34. Configurable Storage Subsystem Attributes ............................................................................................................. 63 Table 35. getStorageControllerInfo Request ................................................................................................................................. 63 Table 36. getStorageControllerInfo Response .............................................................................................................................. 63 Table 37. getDriveInfo Request ........................................................................................................................................................... 66 Table 38. getDriveInfo Response ........................................................................................................................................................ 66 Table 39. Set Drive Attributes .............................................................................................................................................................. 70 Table 40. getNetworkInterfaceInfo Request .................................................................................................................................. 70 Table 41. getNetworkInterfaceInfo response ................................................................................................................................ 71 Table 42. Configurable Network Interface Attributes ................................................................................................................. 74 Table 43. getTrustedModuleInfo Request ...................................................................................................................................... 74 Table 44. getTrustedModuleInfo response .................................................................................................................................... 75 Table 45. Configurable Trusted Module Attributes ..................................................................................................................... 76 Table 46. getFabricInfo Request ......................................................................................................................................................... 76 Table 47. getFabricInfo Response ...................................................................................................................................................... 76 Table 48. getSwitchInfo Request ........................................................................................................................................................ 78 Table 49. getSwitchInfo Response ..................................................................................................................................................... 79 Table 50. Configurable Switch Attributes........................................................................................................................................ 81 Table 51. getPortInfo request .............................................................................................................................................................. 81 Table 52. getPortInfo Response .......................................................................................................................................................... 82 Table 53. Configurable Port Attributes ............................................................................................................................................ 83 Table 54. getEndpointInfo Request ................................................................................................................................................... 83 Table 55. getEndpointInfo response ................................................................................................................................................. 84 Table 56. getPCIeDeviceInfo Request ............................................................................................................................................... 86 Table 57. getPCIeDeviceInfo Response ............................................................................................................................................ 87 Table 58. Set PCIe* Device Attributes ............................................................................................................................................... 89 Table 59. getPCIeFunctionInfo Request .......................................................................................................................................... 89 Table 60. getPCIeFunctionInfo Response ....................................................................................................................................... 89 Table 61. getZoneInfo Request ........................................................................................................................................................... 91 Table 62. getZoneInfo Response ........................................................................................................................................................ 92 Table 63. addZone Request .................................................................................................................................................................. 93


Table 64. addZone Response ............................................................................................................................................................... 94 Table 65. deleteZone Request ............................................................................................................................................................. 94 Table 66. deleteZone Response .......................................................................................................................................................... 95 Table 67. Add Zone Endpoints Request .......................................................................................................................................... 95 Table 68. Add Zone Endpoints Response ....................................................................................................................................... 96 Table 69. deleteZoneEndpoints Request ........................................................................................................................................ 96 Table 70. deleteZoneEndpoints Response ..................................................................................................................................... 97 Table 71. getEthernetSwitchInfo Request ...................................................................................................................................... 97 Table 72. getEthernetSwitchInfo Response ................................................................................................................................... 98 Table 73. Configurable Ethernet Switch Port Attributes ........................................................................................................ 101 Table 74. Get Ethernet Switch Port Info request ....................................................................................................................... 102 Table 75. getEthernetSwitchPortInfo Response ....................................................................................................................... 102 Table 76. Configurable Ethernet Switch Port Attributes ........................................................................................................ 106 Table 77. addEthernetSwitchPort Request ................................................................................................................................. 107 Table 78. addEthernetSwitchPort response ............................................................................................................................... 107 Table 79. deleteEthernetSwitchPort Request ............................................................................................................................ 108 Table 80. deleteEthernetSwitchPort Response ......................................................................................................................... 108 Table 81. addEthernetSwitchPortMembers Request .............................................................................................................. 109 Table 82 addEthernetSwitchPortMembers response ............................................................................................................ 110 Table 83. deleteEthernetSwitchPortMembers request .......................................................................................................... 110 Table 84. deleteEthernetSwitchPortMembers response ....................................................................................................... 111 Table 85. Get Ethernet Switch VxLAN Info request .................................................................................................................. 111 Table 86. getEthernetSwitchVxlanInfo Response ..................................................................................................................... 112 Table 87. addEthernetSwitchVxlan Request ............................................................................................................................... 113 Table 88. addEthernetSwitchVxlan Response ............................................................................................................................ 114 Table 89. deleteEthernetSwitchVxlan Request .......................................................................................................................... 114 Table 90. deleteEthernetSwitchVxlan Response ...................................................................................................................... 115 Table 91. getRemoteEthernetSwitchInfo Request ................................................................................................................... 115 Table 92. getRemoteEthernetSwitchInfo Response ................................................................................................................ 116 Table 93. getVlanInfo Request .......................................................................................................................................................... 117 Table 94. getVlanInfo Request .......................................................................................................................................................... 118 Table 95. Configurable VLAN Attributes ....................................................................................................................................... 119 Table 96. addVlan request ................................................................................................................................................................. 119 Table 97. addVlan response .............................................................................................................................................................. 120 Table 98. deleteVlan Request ........................................................................................................................................................... 120 Table 99. deleteVlan Response ........................................................................................................................................................ 121 Table 100. getPortVlanInfo Request ................................................................................................................................................. 121 Table 101. getPortVlanInfo Response .............................................................................................................................................. 122 Table 102. Configurable Port VLAN Attributes ............................................................................................................................. 123 Table 103. addPortVlan Request ........................................................................................................................................................ 123 Table 104. addPortVlan Response .................................................................................................................................................... 124 Table 105. deletePortVlan Request................................................................................................................................................... 124 Table 106. deletePortVlan Response ............................................................................................................................................... 125 Table 107. getPortStaticMacInfo Request ...................................................................................................................................... 125 Table 108. getPortStaticMacInfo Response ................................................................................................................................... 126 Table 109. Configurable Port Static MAC Attributes .................................................................................................................. 127 Table 110. addPortStaticMac Request ............................................................................................................................................. 127 Table 111. addPortStaticMac Response .......................................................................................................................................... 128 Table 112. Delete Port Static MAC Request ................................................................................................................................... 128


Table 113. Delete Port Static MAC Response ................................................................................................................................ 129 Table 114. getAclInfo Request ............................................................................................................................................................ 129 Table 115. getAclInfo Response ......................................................................................................................................................... 130 Table 116. addAcl Request ................................................................................................................................................................... 131 Table 117. addAcl Response ................................................................................................................................................................ 132 Table 118. deleteAcl Request .............................................................................................................................................................. 132 Table 119. deleteAcl Response ........................................................................................................................................................... 133 Table 120. addAclPort Request .......................................................................................................................................................... 133 Table 121. addAclPort Response ....................................................................................................................................................... 134 Table 122. deleteAclPort Request ..................................................................................................................................................... 134 Table 123. deleteAclPort Response .................................................................................................................................................. 135 Table 124. getAclRuleInfo Request ................................................................................................................................................... 136 Table 125. getAclRuleInfo Response ................................................................................................................................................ 136 Table 126. addAclRule Request .......................................................................................................................................................... 139 Table 127. addAclRule Response ....................................................................................................................................................... 141 Table 128. deleteAclRule Request ..................................................................................................................................................... 141 Table 129. deleteAclRule Response .................................................................................................................................................. 142 Table 130. Configurable ACL Rule Attributes ................................................................................................................................ 142 Table 131. getChassisInfo Request ................................................................................................................................................... 143 Table 132. getChassisInfo Response ................................................................................................................................................ 144 Table 133. Set Chassis Attributes ....................................................................................................................................................... 146 Table 134. getPowerZoneInfo Request ........................................................................................................................................... 147 Table 135. getPowerZoneInfo Response ........................................................................................................................................ 147 Table 136. getPsuInfo Request ........................................................................................................................................................... 149 Table 137. getPsuInfo Response ........................................................................................................................................................ 150 Table 138. Configurable PSU Attributes ......................................................................................................................................... 151 Table 139. getThermalZoneInfo Request ....................................................................................................................................... 152 Table 140. getThermalZoneInfo Response .................................................................................................................................... 152 Table 141. Configurable PSU Attributes ......................................................................................................................................... 154 Table 142. getFanInfo Request ........................................................................................................................................................... 154 Table 143. getFanInfo Response ........................................................................................................................................................ 154 Table 144. getChassisSensorInfo Request ..................................................................................................................................... 156 Table 145. getChassisSensorInfo Response .................................................................................................................................. 157 Table 146. Configurable Fan Attributes ........................................................................................................................................... 158 Table 147. Get Authorization Certificate Request ....................................................................................................................... 158 Table 148. Get Authorization Certificate Response .................................................................................................................... 158 Table 149. getStorageServicesInfo request ................................................................................................................................... 159 Table 150. getStorageServicesInfo Response............................................................................................................................... 160 Table 151. getPhysicalDriveInfo Request ....................................................................................................................................... 161 Table 152. getPhysicalDriveInfo response ..................................................................................................................................... 162 Table 153. getLogicalDriveInfo Request .......................................................................................................................................... 163 Table 154. getLogicalDriveInfo Response ...................................................................................................................................... 164 Table 155. addLogicalDrive Request ................................................................................................................................................ 166 Table 156. addLogicalDrive Response ............................................................................................................................................. 167 Table 157. deleteLogicalDrive Request ........................................................................................................................................... 168 Table 158. deleteLogicalDrive Response ........................................................................................................................................ 168 Table 159. Configurable Logical Drive Attributes ........................................................................................................................ 169 Table 160. getiSCSITargetInfo Request ........................................................................................................................................... 169 Table 161. getiSCSITargetInfo Response ........................................................................................................................................ 169


Table 162. Configurable iSCSI Target Attributes ......................................................................................................................... 171 Table 163. addiSCSITarget Request .................................................................................................................................................. 172 Table 164. addiSCSITarget Response .............................................................................................................................................. 173 Table 165. deleteiSCSITarget Request ............................................................................................................................................. 173 Table 166. deleteiSCSITarget Response ......................................................................................................................................... 174 Table 167. getMetricDefinitionsCollection Response ................................................................................................................ 175 Table 168. getMetricDefinitionInfo Definition ............................................................................................................................... 175 Table 169. getMetricDefinitionInfo Response ............................................................................................................................... 176 Table 170. Configurable Ethernet Switch Port Attributes ........................................................................................................ 179 Table 171. Get Metrics Request .......................................................................................................................................................... 180 Table 172. Get Sensor Values Response ......................................................................................................................................... 180 Table 173. Example Sensors by Asset Type .................................................................................................................................. 181 Table 174. GAMI Commands Support Requirements ................................................................................................................ 183


Revision History Revision Description Date 001 Initial release December 19, 2017

Introduction


Scope This document contains information about the Intel® Rack Scale Design Generic Assets Management Interface (GAMI) API Specification designed and implemented for Intel® Rack Scale Architecture Software v2.0 Release.

Intended audience The intended audiences for this document include designers and engineers working with the Software v2.2 Release, porting this software to HW platforms.

Terminology Table 1. Terminology

Term Definition AMC Asset Management Core BMC Baseboard Management Controller CIMI Cloud Infrastructure Management Interface GAM Generic Asset Management GAMI Generic Assets Management Interface HAL Hardware Abstraction Layer HTTP Hypertext Transfer Protocol JSON JavaScript Object Notation JSON-RPC Stateless, lightweight remote procedure call (RPC) protocol. See http://www.jsonrpc.org. Module Physical component housing a blade or switch OData Open Data Protocol PCIe* Peripheral Component Interconnect Express* PNC Pooled NVMe Controller POD A physical collection of multiple racks PODM POD Manager PSME Pooled System Management Engine REST Representational state transfer RMM Rack Management Module SDV Software Development Vehicle URI Uniform Resource Identifier UUID Universally Unique Identifier VLAN Virtual LAN XML Extensible Markup Language

http://www.jsonrpc.org/

Introduction


References Table 2. Document References

Doc ID Title Location 336811 Intel® Rack Scale Design (RSD) Conformance and Software Reference Kit

Getting Started Guide v2.2, Revision 001 http://www.intel.com/intelRSD

336814 Intel® Rack Scale Design Pod Manager (PDOM) Release Notes, Software v2.2, Revision 001

336815 Intel® Rack Scale Design Pod Manager (PDOM) User Guide, Software v2.2, Revision 001

336816 Intel® Rack Scale Design PSME Release Notes, Software v2.2, Revision 001 336810 Intel® Rack Scale Design PSME User Guide, Software v2.2, Revision 001 336855 Intel® Rack Scale Design PSME REST API Specification, Software v2.2, Revision

001 336856 Intel® Rack Scale Design Storage Services API Specification, Software v2.2,

Revision 001 336857 Intel® Rack Scale Design Pod Manager REST API Specification, Software v2.2,

Revision 001 336858 Intel® Rack Scale Design Rack Management Module (RMM) API Specification,

Software v2.2, Revision 001 336860 Intel® Rack Scale Design Firmware Extension Specification, Software v2.2,

Revision 001 336861 Intel® Rack Scale Design Architecture Specification, Software v2.2, Revision 001 336862 Intel® RSD v2.2 Solid State Drive (SSD) Technical Advisory RFC2119 Key words for use in RFCs to Indicate Requirement Levels, March 1997 https://www.ietf.org/rfc/rfc2119.

txt SDP0266 Scalable Platforms Management API Specification v1.1.0 https://www.dmtf.org/sites/defa

ult/files/standards/documents/DSP0266_1.1.0.pdf

DSP8010 Redfish Schema v2016.3 https://www.dmtf.org/sites/default/files/standards/documents/DSP8010_2016.3.zip

Conventions The key words/phrases "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119, refer to Table 2.

Notes and Symbol Convention Symbol and note convention are similar to typographical conventions used in Cloud Infrastructure Management Interface (CIMI) - a DMTF Standard Publication, refer to Table 2.

Notation used in JSON serialization description:

• Mandatory in italics indicate data types instead of literal Mandatory. • Characters are appended to items to indicate cardinality:

− "?" (0 or 1) − "*" (0 or more) − "+" (1 or more)

• Vertical bars, "|", denote choice. For example, "a|b" means a choice between "a" and "b".

http://www.intel.com/intelRSDhttps://www.ietf.org/rfc/rfc2119.txthttps://www.ietf.org/rfc/rfc2119.txthttps://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.1.0.pdfhttps://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.1.0.pdfhttps://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.1.0.pdfhttps://www.dmtf.org/sites/default/files/standards/documents/DSP8010_2016.3.ziphttps://www.dmtf.org/sites/default/files/standards/documents/DSP8010_2016.3.ziphttps://www.dmtf.org/sites/default/files/standards/documents/DSP8010_2016.3.zip

Introduction


• Parentheses, "(" and ")", are used to indicate the scope of the operators "?", "*", "+" and "|". • Ellipses (i.e., "...") indicate points of extensibility.

The lack of ellipses does not mean no extensibility point exists; it is just not explicitly called out.

Generic Asset Management Interface


GAMI API architecture and design principles This document describes the Asset Management Core (AMC) application to the Generic Asset Management (GAM) module interconnection protocol. The AMC application supports a modular hardware abstraction layer. Each hardware component is handled by a dedicated GAM module managed via JSON-RPC API sent over an HTTP socket. This document specifies the JSON-RPC API to communicate with GAM modules.

Figure 1. Generic Assets Management Interface in the PSME Architecture

The GAMI JSON-RPC 2.0 protocol is HTTP and uses an HTTP POST command to send the JSON structures. A sample request and respon

Documents

Intel® Rack Scale Design Generic Assets Management Interface … · Assets Management Interface (GAMI) API Specification v2.2 December 19, 2017 . Revision 001 . Intel® Rack Scale