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 ...... 41 5.8.1 Request ...... 41

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 3

5.8.2 Response ...... 42 5.9 deleteTask ...... 44 5.9.1 Request ...... 44 5.9.2 Response ...... 44 5.10 getTaskResult ...... 45 5.10.1 Request ...... 45 5.10.2 Response ...... 45 5.11 getCollection ...... 46 5.11.1 Request ...... 46 5.11.2 Response ...... 46 5.12 componentNotification ...... 47 5.12.1 Notification ...... 47 5.13 getComputerSystemInfo ...... 49 5.13.1 Request ...... 49 5.13.2 Response ...... 49 5.14 Set Computer System Attributes ...... 53 5.15 getProcessorInfo ...... 53 5.15.1 Request ...... 54 5.15.2 Response ...... 54 5.16 getMemoryInfo ...... 58 5.16.1 Request ...... 58 5.16.2 Response ...... 58 5.17 getStorageSubsystemInfo ...... 63 5.17.1 Request ...... 63 5.17.2 Response ...... 63 5.18 Set Storage Subsystem Attributes ...... 65 5.19 getStorageControllerInfo ...... 65 5.19.1 Request ...... 65 5.19.2 Response ...... 65 5.20 getDriveInfo ...... 68 5.20.1 Request ...... 68 5.20.2 Response ...... 68 5.21 Set Drive Attributes ...... 72 5.22 getNetworkInterfaceInfo ...... 73 5.22.1 Request ...... 73 5.22.2 Response ...... 73 5.23 Set Network Interface Attributes ...... 76 5.24 getTrustedModuleInfo ...... 76 5.24.1 Request ...... 76 5.24.2 Response ...... 77 5.25 Set Trusted Module Attributes ...... 78 5.26 getFabricInfo ...... 78 5.26.1 Request ...... 78 5.26.2 Response ...... 79 5.27 getSwitchInfo ...... 80 5.27.1 Request ...... 80 5.27.2 Response ...... 81 5.28 Set Switch Attributes ...... 83 5.29 getPortInfo ...... 83 5.29.1 Request ...... 83

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 4 Document Number: 337206-003US

5.29.2 Response ...... 84 5.30 Set Port Attributes ...... 85 5.31 getEndpointInfo ...... 86 5.31.1 Request ...... 86 5.31.2 Response ...... 86 5.32 addEndpoint ...... 90 5.32.1 Request ...... 90 5.32.2 Response ...... 93 5.33 deleteEndpoint ...... 94 5.33.1 Request ...... 94 5.33.2 Response ...... 94 5.34 Set Endpoint Attributes ...... 95 5.35 getPCIeDeviceInfo ...... 95 5.35.1 Request ...... 95 5.35.2 Response ...... 95 5.36 Set PCIe* Device Attributes ...... 98 5.37 getPCIeFunctionInfo ...... 98 5.37.1 Request ...... 98 5.37.2 Response ...... 98 5.38 getZoneInfo ...... 100 5.38.1 Request ...... 100 5.38.2 Response ...... 101 5.39 addZone ...... 102 5.39.1 Request ...... 102 5.39.2 Response ...... 103 5.40 deleteZone ...... 103 5.40.1 Request ...... 103 5.40.2 Response ...... 104 5.41 addZoneEndpoints ...... 104 5.41.1 Request ...... 104 5.41.2 Response ...... 105 5.42 deleteZoneEndpoints ...... 105 5.42.1 Request ...... 105 5.42.2 Response ...... 106 5.43 getEthernetSwitchInfo ...... 106 5.43.1 Request ...... 107 5.43.2 Response ...... 107 5.44 Set Ethernet Switch Attributes ...... 112 5.45 getEthernetSwitchPortInfo ...... 112 5.45.1 Request ...... 112 5.45.2 Response ...... 113 5.46 Set Ethernet Switch Port Attributes ...... 117 5.47 addEthernetSwitchPort ...... 117 5.47.1 Request ...... 118 5.47.2 Response ...... 118 5.48 deleteEthernetSwitchPort ...... 119 5.48.1 Request ...... 119 5.48.2 Response ...... 120 5.49 addEthernetSwitchPortMembers ...... 120 5.49.1 Request ...... 120

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 5

5.49.2 Response ...... 121 5.50 deleteEthernetSwitchPortMembers ...... 121 5.50.1 Request ...... 121 5.50.2 Response ...... 122 5.51 getEthernetSwitchVxlanInfo ...... 122 5.51.1 Request ...... 123 5.51.2 Response ...... 123 5.52 addEthernetSwitchVxlan ...... 124 5.52.1 Request ...... 124 5.52.2 Response ...... 125 5.53 deleteEthernetSwitchVxlan ...... 126 5.53.1 Request ...... 126 5.53.2 Response ...... 127 5.54 getRemoteEthernetSwitchInfo ...... 127 5.54.1 Request ...... 127 5.54.2 Response ...... 128 5.55 getVlanInfo ...... 129 5.55.1 Request ...... 129 5.55.2 Response ...... 130 5.56 Set VLAN Attributes ...... 131 5.57 addVlan ...... 131 5.57.1 Request ...... 131 5.57.2 Response ...... 132 5.58 deleteVlan ...... 132 5.58.1 Request ...... 132 5.58.2 Response ...... 133 5.59 getPortVlanInfo ...... 133 5.59.1 Request ...... 133 5.59.2 Response ...... 134 5.60 Set Port VLAN Attributes ...... 135 5.61 addPortVlan ...... 135 5.61.1 Request ...... 135 5.61.2 Response ...... 136 5.62 deletePortVlan ...... 136 5.62.1 Request ...... 137 5.62.2 Response ...... 137 5.63 getPortStaticMacInfo ...... 138 5.63.1 Request ...... 138 5.63.2 Response ...... 138 5.64 Set Port Static MAC Attributes ...... 139 5.65 addPortStaticMac ...... 139 5.65.1 Request ...... 140 5.65.2 Response ...... 140 5.66 deletePortStaticMac ...... 141 5.66.1 Request ...... 141 5.66.2 Response ...... 141 5.67 getAclInfo ...... 142 5.67.1 Request ...... 142 5.67.2 Response ...... 142 5.68 addAcl ...... 144

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 6 Document Number: 337206-003US

5.68.1 Request ...... 144 5.68.2 Response ...... 145 5.69 deleteAcl ...... 145 5.69.1 Request ...... 145 5.69.2 Response ...... 146 5.70 addAclPort ...... 146 5.70.1 Request ...... 146 5.70.2 Response ...... 147 5.71 deleteAclPort ...... 147 5.71.1 Request ...... 148 5.71.2 Response ...... 148 5.72 getAclRuleInfo ...... 149 5.72.1 Request ...... 149 5.72.2 Response ...... 149 5.73 addAclRule ...... 152 5.73.1 Request ...... 152 5.73.2 Response ...... 154 5.74 deleteAclRule ...... 155 5.74.1 Request ...... 155 5.74.2 Response ...... 155 5.75 Set ACL Rule Attributes ...... 156 5.76 getChassisInfo ...... 157 5.76.1 Request ...... 157 5.76.2 Response ...... 157 5.77 setChassis Attributes ...... 160 5.78 getPowerZoneInfo ...... 160 5.78.1 Request ...... 160 5.78.2 Response ...... 161 5.79 getPsuInfo ...... 163 5.79.1 Request ...... 163 5.79.2 Response ...... 163 5.80 Set PSU Attributes ...... 165 5.81 getThermalZoneInfo ...... 165 5.81.1 Request ...... 165 5.81.2 Response ...... 166 5.82 Set Thermal Zone Attributes ...... 168 5.83 getFanInfo ...... 168 5.83.1 Request ...... 168 5.83.2 Response ...... 168 5.84 getChassisSensorInfo ...... 170 5.84.1 Request ...... 170 5.84.2 Response ...... 171 5.85 Set Fan Attributes ...... 172 5.86 getAuthorizationCertificate ...... 172 5.86.1 Request ...... 172 5.86.2 Response ...... 173 5.87 getStorageServiceInfo ...... 174 5.87.1 Request ...... 174 5.87.2 Response ...... 174 5.88 getStoragePoolInfo ...... 176

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 7

5.88.1 Request ...... 176 5.88.2 Response ...... 176 5.89 addStoragePool ...... 179 5.89.1 Request ...... 180 5.89.2 Response ...... 181 5.90 deleteStoragePool ...... 181 5.90.1 Request ...... 181 5.90.2 Response ...... 182 5.91 getVolumeInfo ...... 182 5.91.1 Request ...... 182 5.91.2 Response ...... 183 5.92 addVolume...... 188 5.92.1 Request ...... 188 5.92.2 Response ...... 191 5.93 deleteVolume ...... 191 5.93.1 Request ...... 191 5.93.2 Response ...... 192 5.94 Set Volume Attributes ...... 192 5.95 getMetricDefinitionsCollection ...... 193 5.95.1 Request ...... 193 5.95.2 Response ...... 193 5.96 getMetricDefinitionInfo ...... 194 5.96.1 Request ...... 194 5.96.2 Response ...... 194 5.97 Set Sensor Definition Attributes ...... 198 5.98 getMetrics ...... 198 5.98.1 Request ...... 198 5.98.2 Response ...... 199 5.98.3 Example sensors by asset type ...... 200 6.0 GAMI Commands Support Requirements ...... 202

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 ...... 25 Figure 4. Storage Services Management Data Model ...... 25 Figure 5. Network Management Data Model ...... 26 Figure 6. Chassis Management Data Model ...... 26 Figure 7. PCIe* Fabric Management Data Model ...... 26 Figure 8. PSME Generic Asset Management Interface API Communication Overview ...... 29

Tables

Table 1. Terminology ...... 14 Table 2. Reference Documents and Resources ...... 15 Table 3. General Error Codes ...... 23 Table 4. GAMI Subcomponent Collection Definition ...... 27 Table 5. GAM “attach” Registration Request ...... 30 Table 6. GAM Module Registration Response ...... 31

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 8 Document Number: 337206-003US

Table 7. heartBeat Command Request ...... 31 Table 8. heartBeat Command Response ...... 32 Table 9. getManagersCollection Response ...... 33 Table 10. Get Manager Info Request ...... 33 Table 11. getManagerInfo Response ...... 34 Table 12. setComponentAttributes Request ...... 38 Table 13. setComponentAttributes Response ...... 39 Table 14. Configurable Manager Attributes ...... 40 Table 15. getTasksCollection Response ...... 41 Table 16. getTaskInfo Request ...... 41 Table 17. getTaskInfo Response ...... 42 Table 18. deleteTask Request ...... 44 Table 19. deleteTask Response ...... 44 Table 20. getTask Result Request ...... 45 Table 21. getTaskResult Response ...... 45 Table 22. getCollection Request ...... 46 Table 23. getCollection Response ...... 46 Table 24. componentNotification ...... 47 Table 25. getComputerSystemInfo Request ...... 49 Table 26. getComputerSystemInfo Response ...... 49 Table 27. Configurable Computer System Attributes ...... 53 Table 28. getProcessorInfo Request ...... 54 Table 29. getProcessorInfo Response ...... 54 Table 30. getMemoryInfo Request ...... 58 Table 31. getMemoryInfo Response ...... 58 Table 32. Get Storage Subsystem Info Request ...... 63 Table 33. Get Storage Subsystem Info Response ...... 63 Table 34. Configurable Storage Subsystem Attributes ...... 65 Table 35. getStorageControllerInfo Request ...... 65 Table 36. getStorageControllerInfo Response ...... 65 Table 37. getDriveInfo Request ...... 68 Table 38. getDriveInfo Response ...... 68 Table 39. Set Drive Attributes ...... 72 Table 40. getNetworkInterfaceInfo Request ...... 73 Table 41. getNetworkInterfaceInfo Response ...... 73 Table 42. Configurable Network Interface Attributes ...... 76 Table 43. getTrustedModuleInfo Request ...... 76 Table 44. getTrustedModuleInfo Response ...... 77 Table 45. Configurable Trusted Module Attributes ...... 78 Table 46. getFabricInfo Request ...... 78 Table 47. getFabricInfo Response ...... 79 Table 48. getSwitchInfo Request ...... 80 Table 49. getSwitchInfo Response ...... 81 Table 50. Configurable Switch Attributes...... 83 Table 51. getPortInfo Request ...... 83 Table 52. getPortInfo Response ...... 84 Table 53. Configurable Port Attributes ...... 85 Table 54. getEndpointInfo Request ...... 86 Table 55. getEndpointInfo Response ...... 86

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 9

Table 56. IP Transport Details ...... 87 Table 57. Identifiers ...... 88 Table 58 addEndpoint Request ...... 90 Table 59. IP Transport Details ...... 91 Table 60. addEndpoint Response...... 93 Table 61. deleteEndpoint Request ...... 94 Table 62. deleteEndpoint Response ...... 94 Table 63. Configurable Endpoint Attributes ...... 95 Table 64. getPCIeDeviceInfo Request ...... 95 Table 65. getPCIeDeviceInfo Response ...... 95 Table 66. Set PCIe* Device Attributes ...... 98 Table 67. getPCIeFunctionInfo Request ...... 98 Table 68. getPCIeFunctionInfo Response ...... 98 Table 69. getZoneInfo Request ...... 100 Table 70. getZoneInfo Response ...... 101 Table 71. addZone Request ...... 102 Table 72. addZone Response ...... 103 Table 73. deleteZone Request ...... 103 Table 74. deleteZone Response ...... 104 Table 75. addZoneEndpoints Request ...... 104 Table 76. addZoneEndpoints Response ...... 105 Table 77. deleteZoneEndpoints Request ...... 105 Table 78. deleteZoneEndpoints Response ...... 106 Table 79. getEthernetSwitchInfo Request ...... 107 Table 80. getEthernetSwitchInfo Response ...... 107 Table 81. Configurable Ethernet Switch Attributes ...... 112 Table 82. getEthernetSwitchPortInfo Request ...... 112 Table 83. getEthernetSwitchPortInfo Response ...... 113 Table 84. Configurable Ethernet Switch Port Attributes ...... 117 Table 85. addEthernetSwitchPort Request ...... 118 Table 86. addEthernetSwitchPort Response ...... 118 Table 87. deleteEthernetSwitchPort Request ...... 119 Table 88. deleteEthernetSwitchPort Response ...... 120 Table 89. addEthernetSwitchPortMembers Request ...... 120 Table 90. addEthernetSwitchPortMembers Response ...... 121 Table 91. deleteEthernetSwitchPortMembers Request ...... 121 Table 92. deleteEthernetSwitchPortMembers Response ...... 122 Table 93. getEthernetSwitchVxlanInfo Request ...... 123 Table 94. getEthernetSwitchVxlanInfo Response ...... 123 Table 95. addEthernetSwitchVxlan Request ...... 124 Table 96. addEthernetSwitchVxlan Response ...... 125 Table 97. deleteEthernetSwitchVxlan Request ...... 126 Table 98. deleteEthernetSwitchVxlan Response ...... 127 Table 99. getRemoteEthernetSwitchInfo Request ...... 127 Table 100. getRemoteEthernetSwitchInfo Response ...... 128 Table 101. getVlanInfo Request ...... 129 Table 102. getVlanInfo Request ...... 130 Table 103. Configurable VLAN Attributes ...... 131 Table 104. addVlan Request ...... 131

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 10 Document Number: 337206-003US

Table 105. addVlan Response ...... 132 Table 106. deleteVlan Request ...... 132 Table 107. deleteVlan Response ...... 133 Table 108. getPortVlanInfo Request ...... 133 Table 109. getPortVlanInfo Response ...... 134 Table 110. Configurable Port VLAN Attributes ...... 135 Table 111. addPortVlan Request ...... 135 Table 112. addPortVlan Response ...... 136 Table 113. deletePortVlan Request...... 137 Table 114. deletePortVlan Response ...... 137 Table 115. getPortStaticMacInfo Request ...... 138 Table 116. getPortStaticMacInfo Response ...... 138 Table 117. Configurable Port Static MAC Attributes ...... 139 Table 118. addPortStaticMac Request ...... 140 Table 119. addPortStaticMac Response ...... 140 Table 120. deletePortStaticMac Request ...... 141 Table 121. deletePortStaticMac Response ...... 141 Table 122. getAclInfo Request ...... 142 Table 123. getAclInfo Response ...... 142 Table 124. addAcl Request ...... 144 Table 125. addAcl Response ...... 145 Table 126. deleteAcl Request ...... 145 Table 127. deleteAcl Response ...... 146 Table 128. addAclPort Request ...... 146 Table 129. addAclPort Response ...... 147 Table 130. deleteAclPort Request ...... 148 Table 131. deleteAclPort Response ...... 148 Table 132. getAclRuleInfo Request ...... 149 Table 133. getAclRuleInfo Response ...... 149 Table 134. addAclRule Request ...... 152 Table 135. addAclRule Response ...... 154 Table 136. deleteAclRule Request ...... 155 Table 137. deleteAclRule Response ...... 155 Table 138. Configurable ACL Rule Attributes ...... 156 Table 139. getChassisInfo Request ...... 157 Table 140. getChassisInfo Response ...... 157 Table 141. SetChassis Attributes ...... 160 Table 142. getPowerZoneInfo Request ...... 160 Table 143. getPowerZoneInfo Response ...... 161 Table 144. getPsuInfo Request ...... 163 Table 145. getPsuInfo Response ...... 163 Table 146. Configurable PSU Attributes ...... 165 Table 147. getThermalZoneInfo Request ...... 165 Table 148. getThermalZoneInfo Response ...... 166 Table 149. Configurable PSU Attributes ...... 168 Table 150. getFanInfo Request ...... 168 Table 151. getFanInfo Response ...... 168 Table 152. getChassisSensorInfo Request ...... 170 Table 153. getChassisSensorInfo Response ...... 171

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 11

Table 154. Configurable Fan Attributes ...... 172 Table 155. getAuthorizationCertificate Request ...... 172 Table 156. getAuthorizationCertificate Response ...... 173 Table 157. getStorageServiceInfo Request ...... 174 Table 158. getStorageServiceInfo Response ...... 174 Table 159. getStoragePoolInfo Request ...... 176 Table 160. getStoragePoolInfo Response ...... 176 Table 161. addStoragePool Request ...... 180 Table 162. addStoragePool Response ...... 181 Table 163. deleteStoragePool Request ...... 181 Table 164. deleteStoragePool Response ...... 182 Table 165. getVolumeInfo Request ...... 182 Table 166. getVolumeInfo Response ...... 183 Table 167. addVolume Request ...... 188 Table 168 addVolume Response ...... 191 Table 169. deleteVolume Request ...... 191 Table 170. deleteVolume response ...... 192 Table 171. Configurable Volume Attributes ...... 192 Table 172. getMetricDefinitionsCollection Response ...... 193 Table 173. getMetricDefinitionInfo Definition ...... 194 Table 174. getMetricDefinitionInfo Response ...... 194 Table 175. Configurable Ethernet Switch Port Attributes ...... 198 Table 176. getMetrics Request ...... 198 Table 177. getMetrics Response ...... 199 Table 178. Example Sensors by Asset Type ...... 200 Table 179. GAMI Commands Support Requirements ...... 202

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 12 Document Number: 337206-003US

Revision History

Revision Description Date 003US Intel® RSD minor software release v 2.3.2 Steptember 2018

002US Intel® RSD Storage Services software v2.3.1 interim release July 2018  Update Table 83, ErrorCleared API defined 001US Initial release for Intel® RSD Storage Services software v2.3 May 2018

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 13

Introduction

1.0 Introduction

1.1 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 Design Software v2.3.2 Release.

1.2 Intended Audience The intended audiences for this document include designers and engineers working with the Intel® RSD Software v2.3.2 Release, porting this software to hardware platforms.

1.3 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.

1.4 Notes and Symbol Convention Symbol and note convention is similar to typographical conventions used in Cloud Infrastructure Management Interface 6 (CIMI) Model and RESTful HTTP-based Protocol 7, An Interface for Managing Cloud Infrastructure - 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".  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.

1.5 Terminology

Table 1. Terminology Term Definition AMC Asset Management Core BMC Baseboard Management Controller CIMI Cloud Infrastructure Management Interface CMDB configuration management database

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 14 Document Number: 337206-003US

Introduction

Term Definition DCB Data Center Bridging DCBX Data Center Bridging Extensions ETS Enhanced Transmission Selection GAM Generic Asset Management GAMI Generic Assets Management Interface HAL Hardware Abstraction Layer HTTP Hypertext Transfer Protocol IPMI Intelligent Platform Management Interface JSON* JavaScript Object Notation* JSON-RPC* Stateless, lightweight remote procedure call (RPC) protocol. See http://www.jsonrpc.org. LLDP Link Layer Discovery Protocol LVM logical volume management OData Open Data Protocol PCIe* Peripheral Component Interconnect Express* PNC Pooled NVMe Controller POD A physical collection of multiple racks PODM POD Manager PFC Priority Flow Control PSME Pooled System Management Engine PTAS Power Thermal Aware Solution PWM Pulse-width Modulation RESTful Representational State Transfer RMM Rack Management Module SDV Software Development Vehicle SNMP Simple Network Management Protocol TGT Ticket-Granting Ticket URI Uniform Resource Identifier UUID Universally Unique Identifier VLAN Virtual LAN XML Extensible Markup Language

1.6 References

Table 2. Reference Documents and Resources Doc ID Title Location Intel® Rack Scale Design (Intel® RSD) Pooled System Management Engine http://www.intel.com/intelRSD 337196 (PSME) User Guide Software v2.3.2 Intel® Rack Scale Design (Intel® RSD) Conformance and Software Reference 337197 Kit Getting Started Guide Software v2.3.2 Intel® Rack Scale Design (Intel® RSD) POD Manager (PODM) Release Notes 337198 Software v2.3.2 Intel® Rack Scale Design (Intel® RSD) POD Manager (PODM) 337199 Representational State Transfer (RESTful) User Guide Software v2.3.2 Intel® Rack Scale Design (Intel® RSD) Pooled System Management Engine 337200 (PSME) Release Notes Software v2.3.2 Intel® Rack Scale Design (Intel® RSD) Firmware Extension Specification 337201 Software v2.3.2

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 15

Introduction

Doc ID Title Location Intel® Rack Scale Design (Intel® RSD) Storage Services API Specification 337202 Software v2.3.2 Intel® Rack Scale Design (Intel® RSD) Architecture Specification Software 337203 v2.3.2 Intel® Rack Scale Design (Intel® RSD) POD Manager (PODM) Representational State Transfer (RESTful) API Specification Software 337204 v2.3.2 Intel® Rack Scale Design (Intel® RSD) Rack Management Module (RMM) Representational State Transfer (RESTful) API Specification Software 337205 v2.3.2 Intel® Rack Scale Design (Intel® RSD) Generic Assets Management Interface 337206 (GAMI) API Software v2.3.2 Intel® Rack Scale Design (Intel® RSD) Pooled System Management Engine (PSME) Representational State Transfer (RESTful) API Specification 337207 Software v2.3.2 https://www.dmtf.org/sites/default/f Cloud Infrastructure Management Interface 6 (CIMI) Model and RESTful iles/standards/documents/DSP0263 DSP0263 HTTP-based Protocol 7 An Interface for Managing Cloud Infrastructure _2.0.0.pdf https://dmtf.org/sites/default/files/st andards/documents/DSP0266_1.0.0 DSP0266 Scalable Platforms Management API Specification v1.1.0 .pdf https://www.dmtf.org/sites/default/f iles/standards/documents/DSP0266 DSP8010 Redfish Schema ReadMe v2016.3 _1.1.0.pdf RFC2119 Key Words for Use in RFCs to Indicate Requirement Levels, March 1997 https://ietf.org/rfc/rfc2119.txt RFC3339 Date and Time on the Internet: Timestamps https://tools.ietf.org/html/rfc3339 https://dmtf.org/sites/default/files/s tandards/documents/DSP0266_1.1. N/A Hypertext Transfer Protocol - HTTP/1.1 0.pdf

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 16 Document Number: 337206-003US

Generic Asset Management Interface

2.0 Generic Asset Management Interface

2.1 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 response (below) present JSON structures exchanged by the AMC application acting as a client and the GAM module acting as a server: Sample request: POST // HTTP/1.1 Host: jsonrpc.rackscale.intel.com Content-Type: application/json Content-Length: ... Accept: application/json { “jsonrpc”: “2.0”, “method”: “getProcessorInfo”, “params”: { “processor”: “123e4567-e89b-12d3-a456-426655440000” }, “id”: 987 }

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 17

Generic Asset Management Interface

Note:  Content-Type should be application/json-rpc, but may be application/json or application/jsonrequest.  Content-Length must be specified.  Accept must be specified and should read application/json-rpc but may be application/json or application/jsonrequest.  Host is not obligatory. Sample response: HTTP/1.1 200 OK Connection: close Content-Length: ... Content-Type: application/json Date: Tue, 17 Feb 2015 15:43:55 CEST

{ “jsonrpc”: “2.0”, “result”: { “status”: { “state”: “Enabled”, “health”: “OK” }, “socket”: “1”, “processorType”: “CPU”, “cpuid”: { “vendorId”: “GenuineIntel”, “numericId” 329442, “family”: 6, “model”: 5, “step”: 2, “microcodeInfo”: 11 }, “maxSpeedMHz”: 3700, “totalCores”: 8, “enabledCores”: 4, “totalThreads”: 4, “enabledThreads”: 2, “oem”: {} }, “id”: 987 }

2.2 GAMI API Synchronous and Asynchronous Operations GAM modules can handle commands in two ways: synchronously returning action result immediately or asynchronously providing response containing created Task Universally Unique Identifier (UUID). Task is a special kind of component that controls and monitors the state of asynchronous actions. Synchrony or asynchrony of command depends on GAM module implementation. When the GAM module receives a command, it decides to finish the action synchronously or asynchronously using the Task mechanism. If an action is completed asynchronously, the GAM module will return Task UUID. The command Get Task Info is for checking the Task state and its additional properties. If Task’s state is completed, the Get Task Result command will return the UUID and type of component affected by the task.

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 18 Document Number: 337206-003US

Generic Asset Management Interface

There is no Add Task command because all Add, Delete, and Set Component Attributes commands can trigger a task mechanism and return created Task UUID instead of a normal response described later in this document - the AMC application must be ready for that. Additionally the GAM modules will use the notification mechanism to notify the AMC application about the Task’s state change to avoid polling.

Figure 2. Sample Asynchronous Communication

GAM AMC Module

addVolume(clone)

"task": "uuid"

alt getTaskInfo("uuid") [polling] Task with state: "Completed"

[eventing] componentNotification("uuid", "Update", "Completed")

getTaskResult("uuid")

"logical": "uuid2"

getVolumeInfo("uuid2")

Volume

Example of an asynchronous request and response exchange with the “addVolume” command. Request: { “jsonrpc”: “2.0”, “method”: “addVolume”, “params”: { “volumeType”: “RawDevice”, “capacityBytes”: 1000000000, “capacitySources”: { “providingPools”: [ “b2fe60a7-33a8-63bb-da16-3e7b1a835ee5” ] }, “accessCapabilities”: [ <{“Read”, “Write”}> ], “replicaInfos”: [ { “replicaType”: “Clone”, “replica”: “4e20b351-6732-ab36-121e-887efa325e4c” } ], “bootable”: true, “oem”: {} }, “id”: 1 } Response: { “jsonrpc”: “2.0”, “result”: { “task”: “123e4567-e89b-12d3-a456-426655440000”,

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 19

Generic Asset Management Interface

“oem”: {} }, “id”: 2 } Sample “getTaskInfo” request: { “jsonrpc”: “2.0”, “method”: “getTaskInfo”, “params”: { “task”: “123e4567-e89b-12d3-a456-426655440000” }, “id”: 3 } Response: { “jsonrpc”: “2.0”, “result”: { “name”: “CloneVolume”, “startTime”: “2016-02-12T15:19:21+00:00”, “endTime”: “2016-02-12T17:19:21+00:00”, “state”: “Completed”, “status”: { “state”: “Enabled”, “health”: “OK” }, “messages”: [], “oem”: {} }, “id”: 4 } “getTask” Result: { “jsonrpc”: “2.0”, “method”: “getTaskResult”, “params”: { “task”: “123e4567-e89b-12d3-a456-426655440000” }, “id”: 5 } Response: { “jsonrpc”: “2.0”, “result”: { “uuid”: “987e4567-n46j-34dx-lk78-jg8555440473”, “type”: “Volume”, “oem”: {} }, “id”: 6 } “getVolumeInfo” Request: { “jsonrpc”: “2.0”, “method”: “getVolumeInfo”, “params”: {

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 20 Document Number: 337206-003US

Generic Asset Management Interface

“volume”: “987e4567-n46j-34dx-lk78-jg8555440473” }, “id”: 7 } Response: { “jsonrpc”: “2.0”, “result”: { “status”: { “state”: “Enabled”, “health”: “OK” }, “capacity”: { “consumedBytes”: 234534527, “allocatedBytes”: 1099511627776, “guaranteedBytes”: 1099511627776, “provisionedBytes”: 1099511627776 } “capacitySources”: [ { consumedBytes: 100849846, allocatedBytes: 549755813888, guaranteedBytes: 549755813888, providingPools: [ “b2fe60a7-33a8-63bb-da16- 3e7b1a835ee5” ] } ], “volumeType”: “NonRedundant”, “encrypted”: false, “encryptionTypes”: [], “identifiers”: [ { “durableName”: “/dev/nvme3n0”, “durableNameFormat”: “SystemPath” } ], “blockSizeBytes”: 512, “optimumIoSizeBytes”: 4096, “accessCapabilities”: [ “Read”, “Write” ], “bootable”: False, “erased”: True, “eraseOnDetach”: False, “replicaInfos”: [ { “replicaReadOnlyAccess”: “SourceElement”, “replicaType”: “Clone”, “replicaRole”: “Target”, “replica”: “4e20b351-6732-ab36-121e-887efa325e4c”, } ], “collections”: [ { “name”: “Endpoints”, “type”: “Endpoints” } ]

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 21

Generic Asset Management Interface

“oem”: {} }, “id”: 987 }

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 22 Document Number: 337206-003US

GAMI API Error Handling

3.0 GAMI API Error Handling

This chapter contains descriptions of all error codes that may be returned by the JSON-RPC calls implemented in the GAMI interfaces.

3.1 API Error Response The GAMI JSON-RPC API complies with JSON-RPC 2.0 specification. Each request may return an error response according to the JSON-RPC 2.0 error object given below: Error: { “jsonrpc”: “2.0”, “error”: { “code”: , “data”: , “message”: }, “id”: id }

3.1.1 Example Error JSON Object Error: { “jsonrpc”: “2.0”, “error”: { “code”: -32602, “data”: , “message”: “No such system” }, “id”: “456” }

3.2 API Error Codes

3.2.1 General Error Codes The error codes described by JSON-RPC 2.0 specification are listed in Table 3. Any command of GAMI protocol described in Section 5.0, GAMI API Definition may return any of these codes.

Table 3. General Error Codes Error Code Message Description -32700 Parse Error The server received invalid JSON. An error occurred on the server while parsing the JSON text. -32603 Internal Error Internal JSON-RPC error. -32602 Invalid Parameters Invalid method parameter(s). -32601 Method not found The method does not exist / is not available. -32600 Invalid Request The JSON sent is not a valid Request object. -1 Unknown Error Unknown error occurred.

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 23

GAMI API Error Handling

Error Code Message Description 10000 Not found Requested component could not be found. 11000 Not implemented The method is not implemented. 12000 Method not allowed The method is not allowed. 13000 Method conflict Used when method conflicts with an ongoing asynchronous action. 14000 Invalid value The JSON contains invalid value for some parameter. This is a generic value related error code used when none of remaining 14xxx matches. 14100 Unsupported value The value is not supported. 14200 Invalid collection The collection given is invalid. 14300 Invalid enum The value is out of supported values list. 14400 Invalid value format The value has incompatible format. 14500 Invalid UUID Component with requested UUID could not be found. 15000 Invalid field The JSON contains invalid field name. This is a generic property related error code used when none of remaining 15xxx matches. 15100 Unsupported field The field is not supported. 15200 Duplicated field The field has already been provided. 15300 Invalid field type The field has incompatible type. 15400 Unexpected field The field is unexpected. 15500 Missing field The field is missing. 20000 Compute Error Set of errors concerning Compute module. 21000 IPMI Error Set of errors concerning IPMI. 30000 Network Error Set of errors concerning Network module. 40000 Storage Error Set of errors concerning Storage module. 41000 iSCSI Error Set of errors concerning iSCSI. 42000 LVM Error Set of errors concerning LVM. 43000 NVMe Error Set of errors concerning NVMe. 50000 Fabric Error Set of errors concerning Fabric module. 60000 Chassis Error Set of errors concerning Chassis module. 61000 Certificate Error Set of errors concerning certificate problems from Chassis module.

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 24 Document Number: 337206-003US

GAMI Data Model

4.0 GAMI Data Model

4.1 Computer System Management Module

Figure 3. Computer System Management Data Model

Processors Task Memory Manager Systems Network Port VLANs Interfaces Storage Subsystems

4.2 Storage Services Management Module

Figure 4. Storage Services Management Data Model

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 25

GAMI Data Model

4.3 Network Management Model

Figure 5. Network Management Data Model Ethernet Ethernet Switch Ports Task Switch Ports VLAN Ports Ethernet Manager VLANs Switches

ACLs Rules

4.4 Chassis Management Model

Figure 6. Chassis Management Data Model

Power PSUs Zones Task Thermal Fans Zones Manager Chassis Chassis

Drives

4.5 PCIe* Fabric Management Model

Figure 7. PCIe* Fabric Management Data Model

Switches Ports

Zone Task Fabrics Zones Endpoints Endpoint Manager Endpoints Ports PCIe PCIe Devices Functions

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 26 Document Number: 337206-003US

GAMI Data Model

4.6 Subcomponent Collections The GAMI data model is a hierarchical model with a strict hierarchy of components and subcomponents. In general, any component may have multiple subcomponents of multiple types. These subcomponents are grouped within the subcomponent collections according to its type. Every component with at least one collection of subcomponents contains the special property object that defines these collections. This property is shown in a table with entries defining the single collection. The collection definition consists of three fields as presented in Table 4.

Table 4. GAMI Subcomponent Collection Definition Attribute Type Mandatory Description name String Yes Collection name; unique collection name used to identify the particular collection of subcomponents; this name is used to retrieve the collection content (identifiers of subcomponents grouped within the collection). Type String Yes Collection type; type of the subcomponents building the particular collection. slotMask String No Occupied slots mask; optional parameters that provide info about the max number of slots and location of occupied slots by subcomponents in the particular collection. This attribute makes sense for some of the collections (for example, chassis, processors, or fans) that occupied a physical slot or socket, but it does not make any sense for others (like VLANs) and therefore, should not be provided as a part of the collection definition.

Every collection is specified as a table with identifiers (such as the UUID) of all subcomponents establishing a given collection. The subcomponent identifier may be used to retrieve its detailed property, using a dedicated command dependent on the collection type. For example, for the collection of “Processors” use the “getProcessorInfo” command to retrieve detailed information about a given processor identified by identifier provided as a part of subcomponent collection. The GAMI defines the single command that retrieves a collection. This command accepts the identifier of the component and the collection name responds with a table of subcomponent identifiers. This is the universal command to get all collection in the GAMI protocol. The “GetCollection” command is described in Section 5.11, getCollectiongetCollection.

4.7 Mandatory and Optional Properties The JSON structures exchanged through the GAMI contains the fields defined as “Mandatory” or “Optional”. This information is necessary for the receiver of a JSON structure to properly interpret the received data.  If a field is specified as “Mandatory”, it means that the JSON structure with one or more missing “Mandatory” fields is not compliant with the GAMI specification.  If a field is specified as “Optional” it means the JSON stricture without such a field is still compliant with GAMI specification. Here are ways in which the “Optional” field may be specified in the JSON request structure are: 1. Field of the “Number” type may be: a. Specified: b. Set to “null” 2. Field of the “Boolean” type: a. Specified: “true” or “false” b. Set to “null” 3. Field of the “String” type: a. Specified:

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 27

GAMI Data Model

b. Specified as empty string: “” c. Set to “null” The “Optional” field in the request JSON structure shall exist; only its value is optional. The “Optional” field in the response JSON structure may be either fully avoided, or specified in the same way as in the request JSON structure.

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 28 Document Number: 337206-003US

GAMI API Definition

5.0 GAMI API Definition

5.1 GAM Module Registration GAM Module must register to the AMC application service to establish a communication channel. The registration procedure is performed using the JSON-RPC request sent to the preconfigured AMC application TCP/IP port. Figure 8 shows an example of the GAM module registration command sequence.

Figure 8. PSME Generic Asset Management Interface API Communication Overview

Asset Generic Asset Management Management Core Application Module POD HW ASSETS register (API version, IP address) IP address

getManagerCollection managers

getManagerInfo

system/chassis/switch collections info

getCollection(Systems) Management REST Protocol systems collection

getSystemInfo

processors, memory, storage controllers, network interfaces

getCollection(Chassis)

chassis collection

getChassisInfo sub-chassis, power, thermal info

OTHER COMMANDS

HW ASSET INFORMATION

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 29

GAMI API Definition

5.1.1 Request The GAM Module “attach” command is sent by the GAM module to the AMC. The application registers the GAM module to the AMC application.

Table 5. GAM “attach” Registration Request Parameter Type Mandatory Description version String Yes GAMI API version vendor String No Vendor name string ipv4address String Yes IPv4 address the GAM module is opening for incoming connections port Number Yes Port number for incoming connections gamiId String Yes GAM module unique identifier capabilities Array: Yes Capability name: String “Compute”, “Network”, “Storage”, “Chassis”, “Pnc”, “Rmm”, “NVMe”

Serialization: { “jsonrpc”: “2.0”, “method”: “attach”, “params”: { “version”: , “vendor”: , “ipv4address”: , “port”: , “gamiId”: , “capabilities”: [ <{“Compute”, “Network”, “Storage”, “Chassis”, “Pnc”, “Rmm”, “NVMe”}>, ... ] }, “id”: } Example: { “jsonrpc”: “2.0”, “method”: “attach”, “params”: { “version”: “1.0.0”, “vendor”: “Intel Corporation”, “ipv4address”: “127.0.0.1”, “port”: “8080” “gamiId”: “40bf1aa4-c440-11e5-9202-00a0c923456f”, “capabilities”: [ “Compute”, “Chassis” ] }, “id”: 345 }

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 30 Document Number: 337206-003US

GAMI API Definition

5.1.2 Response Upon a successful GAM module registration, the AMC application responds with the following response.

Table 6. GAM Module Registration Response Result Type Mandatory Description version String Yes GAMI API version ipv4address String Yes IPv4 address where the AMC Application is listening for requests and notifications from a newly registered GAM module. port Number Yes TCP port number AMC Application is listening on

Serialization: { “jsonrpc”: “2.0”, “result”: { “version”: , “ipv4address”: , “port”: }, “id”: } Example: { “jsonrpc”: “2.0”, “result”: { “version”: “1.0.0”, “ipv4address”: “127.0.0.1”, “port”: 8090 }, “id”: 345 }

5.2 heartBeat The GAM module sends the “heartBeat” command to the AMC application periodically to detect its status. If the GAM module does not receive a response for the “heartBeat” command, it means the AMC application is not running. If a timestamp returned by the AMC application in a response is lower than a timestamp returned in the previous command, this result indicates the AMC application has been restarted, since the heart beat timer is restarted along with AMC application. In both cases, the GAM module will reset its state and start a new registration procedure.

5.2.1 Request

Table 7. heartBeat Command Request Parameters Type Mandatory Description gamiId String Yes GAM module unique identifier

Serialization: { “jsonrpc”: “2.0”, “method”: “heartBeat”, “params”: { “gamiId”:

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 31

GAMI API Definition

}, “id”: } Example: { “jsonrpc”: “2.0”, “method”: “heartBeat’, “params”: { “gamiId”: “40bf1aa4-c440-11e5-9202-00a0c923456f”, }, “id”: 345 }

5.2.2 Response

Table 8. heartBeat Command Response Parameters Type Mandatory Description timeStamp Number Yes Time stamp returned by the AMC Application. minDelay Number Yes The minimum delay after which the GAM module can send the next “heartBeat” command to the AMC Application.

Serialization: { “jsonrpc”: “2.0”, “result”: { timeStamp: , minDelay: }, “id”: 334 } Example: { “jsonrpc”: “2.0”, “result”: { timeStamp: 5443323, minDelay: 5000 }, “id”: 345 }

5.3 getManagersCollection The AMC retrieves collection of main managers supported by the particular GAM Module by sending the “getManagersCollection” command to this GAM Module.

5.3.1 Request Serialization: { “jsonrpc”: “2.0”, “method”: “getManagersCollection”, “id”:

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 32 Document Number: 337206-003US

GAMI API Definition

} Example: { “jsonrpc”: “2.0”, “method”: “getManagersCollection”. “id”: 987 }

5.3.2 Response GAMI Module replies with the following response in a successful case:

Table 9. getManagersCollection Response Parameters Type Mandatory Description managers Array: Yes Member Type Mandatory Description Object manager String Yes Manager UUID

Serialization: { “jsonrpc”: “2.0”, “result”: [ { “manager”: }, ... ], “id”: } Example: { “jsonrpc”: “2.0”, “result”: [ { “manager”: “123e4567-e89b-12d3-a456-426655440000”, }, { “manager”: “863e4567-e87b-64d3-a489-987656540000”, } ], “id”: 987 }

5.4 getManagerInfo The “getManagerInfo” command retrieves detailed information about a single manager.

5.4.1 Request

Table 10. Get Manager Info Request Parameters Type Mandatory Description manager String Yes Manager UUID

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 33

GAMI API Definition

Serialization: { “jsonrpc”: “2.0”, “method”: “getManagerInfo”, “params”: { “manager”: }, “id”: } Example: { “jsonrpc”: “2.0”, “method”: “getManagerInfo”, “params”: { “manager”: “123e4567-e89b-12d3-a456-426655440000” }, “id”: 987 }

5.4.2 Response

Table 11. getManagerInfo Response Result Type Mandatory Description

status Object Yes Attribute Type Mandatory Description state String Yes Known state of the component: "Enabled", “Disabled”, “StandbyOffline”, “StandbySpare”, “InTest”, “Starting”, “Absent”, “UnavailableOffline” health String No Overall health state from the view of this resource: "OK", “Warning”, “Critical”

type String Yes Manager type: "ManagementController", "EnclosureManager", "BMC", "RackManager", “EthernetSwitchManager”, “StorageSystemManager”, "AuxiliaryController" model String No Manager model location String No UUID of the chassis being a manager’s physical location guid String No GUID of the management controller parentId String No Identifier of the parent manager dateTime String No The current dateTime (with offset) for the manager, used to set or read time compatible with RFC 3339, refer to Table 2. dateTimeLocalOffs String No The time offset from UTC that the DateTime property is set to in format: et +06:00. firmwareVersion String Yes Manager firmware version ipv4Address String No IPv4 address manager is listening on

Intel® RSD GAMI API Specification Software v2.3.2 September 2018 34 Document Number: 337206-003US

GAMI API Definition

Result Type Mandatory Description

networkServices Array: No Attribute Type Mandatory Description Object name String Yes Protocol: "HTTP", “HTTPS”, “SNMP”, “VirtualMedia”, “Telnet”, “SSDP”, “IPMI”, “SSH”, “KVMIP” port Number No Service port number enabled Boolean Yes Is service enabled

graphicalConsole Object No Attribute Type Mandatory Description enabled Boolean No Console availability maxSessi Number No Number of sessions that ons can be established at the same time. typesSup Array: No Supported types of ported String connections

serialConsole Object Yes Attribute Type Mandatory Description signalType String No Signal type: “Rs232”, “Rs485” bitrate Number No Bitrate: 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400 parity String No Parity: “None”, “Even”, “Odd”, “Mark”, “Space” dataBits Number No Data bits: 5, 6, 7, 8 stopBits Number No Stop bits: 1, 2 flowContro String No Flow control: l “None”, “Software”, “Hardware” pinOut String No Pin out: “Cisco”, “Cyclades”, “Digi” enabled Boolean No Console availability maxSession Number No Number of sessions that s can be established at the same time. typesSuppo Array: No Supported types of rted String connections

commandShell Object No Attribute Type Mandatory Description enabled Boolea No Console availability n maxSessi Number No Number of sessions that ons can be established at the same time.

Intel® RSD GAMI September 2018 API Specification Software v2.3.2 Document Number: 337206-003US 35

GAMI API Definition

Result Type Mandatory Description

typesSup Array: No Supported types of ported String connections.

collections Array: Yes Object Attribute Type Mandatory Description name String Yes Collection name type String Yes Collection type: “Chassis”, ”Systems”, “EthernetSwitches”, “StorageServices”, “Managers”, “Fabrics”, “PCIeDevices”, “NetworkInterfaces” slotMask String No Occupied slots mask (Refer to Section 4.5 for details) allowedActions Array: No Allowable reset types: Allowed values: “On”, “ForceOff”, String “GracefulShutdown”, “GracefulRestart”, “ForceRestart”, “Nmi”, “ForceOn”, “PushPowerButton” oem Object No OEM specific data

Serialization: { “jsonrpc”: “2.0”, “result”: { “status”: { “state”: <{"Enabled", “Disabled”, “StandbyOffline”, “StandbySpare,”,“InTest”, “Starting”, “Absent, “UnavailableOffline”}>, “health”: <{"OK", “Warning”, “Critical”}> }, “type”: <{“ManagementController”, “EnclosureManager”, “BMC”, “RackManager”, “EthernetSwitchManager”, “StorageSystemManager”, “AuxiliaryController”}>, “model”: , “location”: , “guid”: , “parentId”: , “dateTime”: , “dateTimeLocalOffset”: , “firmwareVersion”: , “ipv4Address”: , “networkServices”: [ { “name”: <{“HTTP”, “HTTPS”, “SNMP”, “VirtualMedia”, “Telnet”, “SSDP”, “IPMI”, “SSH”, “KVMIP”}>, “port”: , “enabled”: }, ... ], “graphicalConsole”: { “enabled”: , “maxSessions”: , “typesSupported”: [ <{“KVMIP”}> ... ], } Intel® RSD GAMI API Specification Software v2.3.2 September 2018 36 Document Number: 337206-003US

GAMI API Definition

“serialConsole”: { “signalType”: , “bitrate”: , “parity”: , “dataBits”: , “stopBits”: , “flowControl”: , “pinOut”: , “enabled”: , “maxSessions”: , “typesSupported”: [ <{“Telnet”, “IPMI”, “SSH”}> ... ], }, “commandShell”: { “enabled”: , “maxSessions”: , “typesSupported”: [ <{“VirtualMedia”, “Telnet”, “SSH”}> ... ], } “collections”: [ { “name”: , “type”: <{“Chassis”, “Systems”, “EthernetSwitches”, “StorageServices”, “Managers”, “Fabrics”, “PCIeDevices”, “Drives”}>, “slotMask”: } ... ], “allowedActions”: [{“On”, “ForceOff”, “GracefulShutdown”, “GracefulRestart”, “ForceRestart”, “Nmi”, “ForceOn”, “PushPowerButton”}], “oem”: