+ All Categories
Home > Documents > Intel® Rack Scale Design (Intel® RSD) Generic Assets … · (GAMI) API Specification Software...

Intel® Rack Scale Design (Intel® RSD) Generic Assets … · (GAMI) API Specification Software...

Date post: 06-Feb-2021
Category:
Upload: others
View: 2 times
Download: 0 times
Share this document with a friend
219
Document Number: 608495-001 Intel® Rack Scale Design (Intel® RSD) Generic Assets Management Interface (GAMI) API Specification Software v2.4 April 2019 Revision 001
Transcript
  • Document Number: 608495-001

    Intel® Rack Scale Design (Intel® RSD)

    Generic Assets Management Interface

    (GAMI)

    API Specification

    Software v2.4

    April 2019

    Revision 001

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    API Specification Software v2.4 April 2019

    2 Document Number: 608495-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.

    This document grants no license (express or implied, by estoppel or otherwise) to any intellectual property rights.

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

    file:///C:/Users/menewmax/Desktop/projects/CPG-Redfish/ww28-29/pete-edited/www.intel.comhttp://www.intel.com/design/literature.htm

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    April 2019 API Specification Software v2.4

    Document Number: 608495-001 3

    Contents 1.0 Introduction ......................................................................................................................................................................... 14

    1.1 Intended Audience ............................................................................................................................................................... 14 1.2 Conventions ............................................................................................................................................................................ 14 1.3 Notes and Symbol Convention ........................................................................................................................................ 14 1.4 Terminology ............................................................................................................................................................................ 14 1.5 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 .................................................................................................................................................. 22 3.1 API Error Response ............................................................................................................................................................... 22

    3.1.1 Example Error JSON Object ........................................................................................................................... 22 3.2 API Error Codes ...................................................................................................................................................................... 22

    3.2.1 General Error Codes........................................................................................................................................... 22 4.0 GAMI Data Model ................................................................................................................................................................ 24

    4.1 Computer System Management Module ..................................................................................................................... 24 4.2 Storage Services Management Module ........................................................................................................................ 24 4.3 Network Management Model ........................................................................................................................................... 25 4.4 Chassis Management Model ............................................................................................................................................. 25 4.5 PCIe* Fabric Management Model.................................................................................................................................... 25 4.6 Subcomponent Collections ............................................................................................................................................... 25 4.7 Mandatory and Optional Properties .............................................................................................................................. 26

    5.0 GAMI API Definition ........................................................................................................................................................... 27 5.1 GAM Module Registration .................................................................................................................................................. 27

    5.1.1 Request ................................................................................................................................................................... 28 5.1.2 Response ................................................................................................................................................................ 28

    5.2 heartBeat .................................................................................................................................................................................. 29 5.2.1 Request ................................................................................................................................................................... 29 5.2.2 Response ................................................................................................................................................................ 30

    5.3 getManagersCollection ....................................................................................................................................................... 30 5.3.1 Request ................................................................................................................................................................... 30 5.3.2 Response ................................................................................................................................................................ 31

    5.4 getManagerInfo ...................................................................................................................................................................... 31 5.4.1 Request ................................................................................................................................................................... 32 5.4.2 Response ................................................................................................................................................................ 32

    5.5 setComponentAttributes ................................................................................................................................................... 37 5.5.1 Request ................................................................................................................................................................... 37 5.5.2 Response ................................................................................................................................................................ 38

    5.6 Set Manager Attributes ....................................................................................................................................................... 39 5.7 getTasksCollection ............................................................................................................................................................... 39

    5.7.1 Request ................................................................................................................................................................... 39 5.7.2 Response ................................................................................................................................................................ 39

    5.8 getTaskInfo .............................................................................................................................................................................. 40 5.8.1 Request ................................................................................................................................................................... 40 5.8.2 Response ................................................................................................................................................................ 41

    5.9 deleteTask ................................................................................................................................................................................ 42

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    API Specification Software v2.4 April 2019

    4 Document Number: 608495-001

    5.9.1 Request ................................................................................................................................................................... 42 5.9.2 Response ................................................................................................................................................................ 43

    5.10 getTaskResultInfo ................................................................................................................................................................. 43 5.10.1 Request ................................................................................................................................................................... 43 5.10.2 Response ................................................................................................................................................................ 44

    5.11 getCollection ........................................................................................................................................................................... 44 5.11.1 Request ................................................................................................................................................................... 44 5.11.2 Response ................................................................................................................................................................ 45

    5.12 componentNotification ....................................................................................................................................................... 46 5.12.1 Notification ............................................................................................................................................................ 46

    5.13 getComputerSystemInfo .................................................................................................................................................... 47 5.13.1 Request ................................................................................................................................................................... 47 5.13.2 Response ................................................................................................................................................................ 48

    5.14 Set Computer System Attributes .................................................................................................................................... 53 5.15 getProcessorInfo ................................................................................................................................................................... 53

    5.15.1 Request ................................................................................................................................................................... 54 5.15.2 Response ................................................................................................................................................................ 54

    5.16 Set Processor Attributes .................................................................................................................................................... 60 5.17 getAccelerationFunctionInfo ............................................................................................................................................ 60

    5.17.1 Request ................................................................................................................................................................... 60 5.17.2 Response ................................................................................................................................................................ 61

    5.18 getMemoryInfo ....................................................................................................................................................................... 62 5.18.1 Request ................................................................................................................................................................... 62 5.18.2 Response ................................................................................................................................................................ 63

    5.19 Set Memory Attributes ........................................................................................................................................................ 69 5.20 getMemoryDomainInfo ....................................................................................................................................................... 69

    5.20.1 Request ................................................................................................................................................................... 69 5.20.2 Response ................................................................................................................................................................ 70

    5.21 getMemoryChunksInfo ....................................................................................................................................................... 71 5.21.1 Request ................................................................................................................................................................... 71 5.21.2 Response ................................................................................................................................................................ 72

    5.22 getStorageSubsystemInfo ................................................................................................................................................. 73 5.22.1 Request ................................................................................................................................................................... 73 5.22.2 Response ................................................................................................................................................................ 74

    5.23 Set Storage Subsystem Attributes ................................................................................................................................. 75 5.24 getStorageControllerInfo ................................................................................................................................................... 76

    5.24.1 Request ................................................................................................................................................................... 76 5.24.2 Response ................................................................................................................................................................ 76

    5.25 getDriveInfo ............................................................................................................................................................................. 79 5.25.1 Request ................................................................................................................................................................... 79 5.25.2 Response ................................................................................................................................................................ 80

    5.26 deleteDrive ............................................................................................................................................................................... 84 5.26.1 Request ................................................................................................................................................................... 84 5.26.2 Response ................................................................................................................................................................ 84

    5.27 Set Drive Attributes .............................................................................................................................................................. 85 5.28 getNetworkInterfaceInfo .................................................................................................................................................... 85

    5.28.1 Request ................................................................................................................................................................... 85 5.28.2 Response ................................................................................................................................................................ 85

    5.29 Set Network Interface Attributes .................................................................................................................................... 89 5.30 getTrustedModuleInfo ........................................................................................................................................................ 89

    5.30.1 Request ................................................................................................................................................................... 89

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    April 2019 API Specification Software v2.4

    Document Number: 608495-001 5

    5.30.2 Response ................................................................................................................................................................ 90 5.31 Set Trusted Module Attributes ........................................................................................................................................ 91 5.32 getFabricInfo ........................................................................................................................................................................... 91

    5.32.1 Request ................................................................................................................................................................... 91 5.32.2 Response ................................................................................................................................................................ 92

    5.33 getSwitchInfo .......................................................................................................................................................................... 93 5.33.1 Request ................................................................................................................................................................... 93 5.33.2 Response ................................................................................................................................................................ 94

    5.34 Set Switch Attributes ........................................................................................................................................................... 96 5.35 getPortInfo ............................................................................................................................................................................... 96

    5.35.1 Request ................................................................................................................................................................... 96 5.35.2 Response ................................................................................................................................................................ 97

    5.36 Set Port Attributes ................................................................................................................................................................ 99 5.37 getEndpointInfo ..................................................................................................................................................................... 99

    5.37.1 Request ................................................................................................................................................................... 99 5.37.2 Response ............................................................................................................................................................. 100

    5.38 addEndpoint ......................................................................................................................................................................... 103 5.38.1 Request ................................................................................................................................................................ 104 5.38.2 Response ............................................................................................................................................................. 106

    5.39 deleteEndpoint .................................................................................................................................................................... 107 5.39.1 Request ................................................................................................................................................................ 107 5.39.2 Response ............................................................................................................................................................. 107

    5.40 Set Endpoint Attributes ................................................................................................................................................... 108 5.41 getPCIeDeviceInfo .............................................................................................................................................................. 108

    5.41.1 Request ................................................................................................................................................................ 108 5.41.2 Response ............................................................................................................................................................. 109

    5.42 Set PCIe* Device Attributes ............................................................................................................................................ 111 5.43 getPCIeFunctionInfo ......................................................................................................................................................... 111

    5.43.1 Request ................................................................................................................................................................ 111 5.43.2 Response ............................................................................................................................................................. 112

    5.44 getZoneInfo .......................................................................................................................................................................... 113 5.44.1 Request ................................................................................................................................................................ 113 5.44.2 Response ............................................................................................................................................................. 114

    5.45 addZone ................................................................................................................................................................................. 115 5.45.1 Request ................................................................................................................................................................ 115 5.45.2 Response ............................................................................................................................................................. 116

    5.46 deleteZone ............................................................................................................................................................................ 116 5.46.1 Request ................................................................................................................................................................ 117 5.46.2 Response ............................................................................................................................................................. 117

    5.47 addZoneEndpoints ............................................................................................................................................................ 117 5.47.1 Request ................................................................................................................................................................ 118 5.47.2 Response ............................................................................................................................................................. 118

    5.48 deleteZoneEndpoints ....................................................................................................................................................... 119 5.48.1 Request ................................................................................................................................................................ 119 5.48.2 Response ............................................................................................................................................................. 119

    5.49 getEthernetSwitchInfo ..................................................................................................................................................... 120 5.49.1 Request ................................................................................................................................................................ 120 5.49.2 Response ............................................................................................................................................................. 120

    5.50 Set Ethernet Switch Attributes ..................................................................................................................................... 125 5.51 getEthernetSwitchPortInfo ............................................................................................................................................. 126

    5.51.1 Request ................................................................................................................................................................ 126

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    API Specification Software v2.4 April 2019

    6 Document Number: 608495-001

    5.51.2 Response ............................................................................................................................................................. 127 5.52 Set Ethernet Switch Port Attributes ............................................................................................................................ 131 5.53 addEthernetSwitchPort ................................................................................................................................................... 131

    5.53.1 Request ................................................................................................................................................................ 131 5.53.2 Response ............................................................................................................................................................. 132

    5.54 deleteEthernetSwitchPort .............................................................................................................................................. 133 5.54.1 Request ................................................................................................................................................................ 133 5.54.2 Response ............................................................................................................................................................. 133

    5.55 addEthernetSwitchPortMembers ................................................................................................................................ 134 5.55.1 Request ................................................................................................................................................................ 134 5.55.2 Response ............................................................................................................................................................. 135

    5.56 deleteEthernetSwitchPortMembers ........................................................................................................................... 135 5.56.1 Request ................................................................................................................................................................ 135 5.56.2 Response ............................................................................................................................................................. 136

    5.57 getEthernetSwitchVxlanInfo .......................................................................................................................................... 136 5.57.1 Request ................................................................................................................................................................ 136 5.57.2 Response ............................................................................................................................................................. 137

    5.58 addEthernetSwitchVxlan ................................................................................................................................................. 138 5.58.1 Request ................................................................................................................................................................ 138 5.58.2 Response ............................................................................................................................................................. 139

    5.59 deleteEthernetSwitchVxlan ............................................................................................................................................ 139 5.59.1 Request ................................................................................................................................................................ 139 5.59.2 Response ............................................................................................................................................................. 140

    5.60 getRemoteEthernetSwitchInfo ..................................................................................................................................... 140 5.60.1 Request ................................................................................................................................................................ 141 5.60.2 Response ............................................................................................................................................................. 141

    5.61 getVlanInfo ........................................................................................................................................................................... 143 5.61.1 Request ................................................................................................................................................................ 143 5.61.2 Response ............................................................................................................................................................. 143

    5.62 Set VLAN Attributes .......................................................................................................................................................... 144 5.63 addVlan .................................................................................................................................................................................. 145

    5.63.1 Request ................................................................................................................................................................ 145 5.63.2 Response ............................................................................................................................................................. 145

    5.64 deleteVlan ............................................................................................................................................................................. 146 5.64.1 Request ................................................................................................................................................................ 146 5.64.2 Response ............................................................................................................................................................. 146

    5.65 getPortVlanInfo ................................................................................................................................................................... 147 5.65.1 Request ................................................................................................................................................................ 147 5.65.2 Response ............................................................................................................................................................. 147

    5.66 Set Port VLAN Attributes ................................................................................................................................................. 149 5.67 addPortVlan ......................................................................................................................................................................... 149

    5.67.1 Request ................................................................................................................................................................ 149 5.67.2 Response ............................................................................................................................................................. 150

    5.68 deletePortVlan .................................................................................................................................................................... 150 5.68.1 Request ................................................................................................................................................................ 150 5.68.2 Response ............................................................................................................................................................. 151

    5.69 getPortStaticMacInfo ........................................................................................................................................................ 151 5.69.1 Request ................................................................................................................................................................ 151 5.69.2 Response ............................................................................................................................................................. 152

    5.70 Set Port Static MAC Attributes ...................................................................................................................................... 153 5.71 addPortStaticMac ............................................................................................................................................................... 153

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    April 2019 API Specification Software v2.4

    Document Number: 608495-001 7

    5.71.1 Request ................................................................................................................................................................ 153 5.71.2 Response ............................................................................................................................................................. 154

    5.72 deletePortStaticMac .......................................................................................................................................................... 154 5.72.1 Request ................................................................................................................................................................ 155 5.72.2 Response ............................................................................................................................................................. 155

    5.73 getAclInfo .............................................................................................................................................................................. 156 5.73.1 Request ................................................................................................................................................................ 156 5.73.2 Response ............................................................................................................................................................. 156

    5.74 addAcl ..................................................................................................................................................................................... 157 5.74.1 Request ................................................................................................................................................................ 158 5.74.2 Response ............................................................................................................................................................. 158

    5.75 deleteAcl ................................................................................................................................................................................ 159 5.75.1 Request ................................................................................................................................................................ 159 5.75.2 Response ............................................................................................................................................................. 159

    5.76 addAclPort ............................................................................................................................................................................ 160 5.76.1 Request ................................................................................................................................................................ 160 5.76.2 Response ............................................................................................................................................................. 161

    5.77 deleteAclPort ....................................................................................................................................................................... 161 5.77.1 Request ................................................................................................................................................................ 161 5.77.2 Response ............................................................................................................................................................. 162

    5.78 getAclRuleInfo ..................................................................................................................................................................... 162 5.78.1 Request ................................................................................................................................................................ 162 5.78.2 Response ............................................................................................................................................................. 163

    5.79 addAclRule ............................................................................................................................................................................ 166 5.79.1 Request ................................................................................................................................................................ 166 5.79.2 Response ............................................................................................................................................................. 168

    5.80 deleteAclRule ....................................................................................................................................................................... 169 5.80.1 Request ................................................................................................................................................................ 169 5.80.2 Response ............................................................................................................................................................. 169

    5.81 Set ACL Rule Attributes ................................................................................................................................................... 170 5.82 getChassisInfo ..................................................................................................................................................................... 171

    5.82.1 Request ................................................................................................................................................................ 171 5.82.2 Response ............................................................................................................................................................. 171

    5.83 SetChassis Attributes ........................................................................................................................................................ 174 5.84 getPowerZoneInfo ............................................................................................................................................................. 174

    5.84.1 Request ................................................................................................................................................................ 175 5.84.2 Response ............................................................................................................................................................. 175

    5.85 getPsuInfo ............................................................................................................................................................................. 177 5.85.1 Request ................................................................................................................................................................ 177 5.85.2 Response ............................................................................................................................................................. 177

    5.86 Set PSU Attributes ............................................................................................................................................................. 179 5.87 getThermalZoneInfo ......................................................................................................................................................... 180

    5.87.1 Request ................................................................................................................................................................ 180 5.87.2 Response ............................................................................................................................................................. 180

    5.88 Set Thermal Zone Attributes ......................................................................................................................................... 182 5.89 getFanInfo ............................................................................................................................................................................. 182

    5.89.1 Request ................................................................................................................................................................ 182 5.89.2 Response ............................................................................................................................................................. 183

    5.90 getChassisSensorInfo ....................................................................................................................................................... 184 5.90.1 Request ................................................................................................................................................................ 185 5.90.2 Response ............................................................................................................................................................. 185

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    API Specification Software v2.4 April 2019

    8 Document Number: 608495-001

    5.91 Set Fan Attributes .............................................................................................................................................................. 186 5.92 getAuthorizationCertificate ............................................................................................................................................ 187

    5.92.1 Request ................................................................................................................................................................ 187 5.92.2 Response ............................................................................................................................................................. 187

    5.93 getStorageServiceInfo ...................................................................................................................................................... 188 5.93.1 Request ................................................................................................................................................................ 188 5.93.2 Response ............................................................................................................................................................. 189

    5.94 getStoragePoolInfo ........................................................................................................................................................... 190 5.94.1 Request ................................................................................................................................................................ 190 5.94.2 Response ............................................................................................................................................................. 191

    5.95 addStoragePool .................................................................................................................................................................. 194 5.95.1 Request ................................................................................................................................................................ 194 5.95.2 Response ............................................................................................................................................................. 195

    5.96 deleteStoragePool ............................................................................................................................................................. 196 5.96.1 Request ................................................................................................................................................................ 196 5.96.2 Response ............................................................................................................................................................. 197

    5.97 getVolumeInfo ..................................................................................................................................................................... 197 5.97.1 Request ................................................................................................................................................................ 197 5.97.2 Response ............................................................................................................................................................. 198

    5.98 addVolume............................................................................................................................................................................ 203 5.98.1 Request ................................................................................................................................................................ 203 5.98.2 Response ............................................................................................................................................................. 206

    5.99 deleteVolume ...................................................................................................................................................................... 206 5.99.1 Request ................................................................................................................................................................ 207 5.99.2 Response ............................................................................................................................................................. 207

    5.100 Set Volume Attributes ...................................................................................................................................................... 207 5.101 getMetricDefinitionsCollection ..................................................................................................................................... 208

    5.101.1 Request ................................................................................................................................................................ 208 5.101.2 Response ............................................................................................................................................................. 208

    5.102 getMetricDefinitionInfo .................................................................................................................................................... 209 5.102.1 Request ................................................................................................................................................................ 209 5.102.2 Response ............................................................................................................................................................. 209

    5.103 Set Sensor Definition Attributes .................................................................................................................................. 213 5.104 getMetrics .............................................................................................................................................................................. 213

    5.104.1 Request ................................................................................................................................................................ 214 5.104.2 Response ............................................................................................................................................................. 214 5.104.3 Example sensors by asset type .................................................................................................................. 216

    6.0 GAMI Commands Support Requirements .................................................................................................................. 217

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

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    April 2019 API Specification Software v2.4

    Document Number: 608495-001 9

    Tables

    Table 1. Terminology ............................................................................................................................................................................ 14 Table 2. Reference Documents and Resources .......................................................................................................................... 15 Table 3. General Error Codes ............................................................................................................................................................. 22 Table 4. GAMI Subcomponent Collection Definition ............................................................................................................... 26 Table 5. GAM "attach" Registration Request ................................................................................................................................ 28 Table 6. GAM Module Registration Response ............................................................................................................................. 29 Table 7. heartBeat Command Request .......................................................................................................................................... 29 Table 8. heartBeat Command Response ....................................................................................................................................... 30 Table 9. getManagersCollection Response .................................................................................................................................. 31 Table 10. getManager Info Request ................................................................................................................................................... 32 Table 11. getManagerInfo Response ................................................................................................................................................. 32 Table 12. setComponentAttributes Request ................................................................................................................................. 37 Table 13. setComponentAttributes Response .............................................................................................................................. 38 Table 14. Configurable Manager Attributes ................................................................................................................................... 39 Table 15. getTasksCollection Response .......................................................................................................................................... 39 Table 16. getTaskInfo Request ............................................................................................................................................................ 40 Table 17. getTaskInfo Response ......................................................................................................................................................... 41 Table 18. deleteTask Request .............................................................................................................................................................. 42 Table 19. deleteTask Response ........................................................................................................................................................... 43 Table 20. getTask ResultInfo Request .............................................................................................................................................. 43 Table 21. getTaskResultInfo 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 ............................................................................................................................... 48 Table 27. Configurable Computer System Attributes ................................................................................................................ 53 Table 28. getProcessorInfo Request ................................................................................................................................................. 54 Table 29. getProcessorInfo Response .............................................................................................................................................. 54 Table 30. Reconfiguration Slot Details ............................................................................................................................................. 58 Table 31. Set Drive Attributes .............................................................................................................................................................. 60 Table 32. getAccelerationFunctionInfo Request .......................................................................................................................... 60 Table 33. getAccelerationFunctionInfo Response ....................................................................................................................... 61 Table 34. getMemoryInfo Request ..................................................................................................................................................... 62 Table 35. getMemoryInfo Response .................................................................................................................................................. 63 Table 36. Configurable Memory Attributes .................................................................................................................................... 69 Table 37. getMemoryDomainInfo Request ..................................................................................................................................... 69 Table 38. getMemoryDomainInfo Response .................................................................................................................................. 70 Table 39. getMemoryChunksInfo Request...................................................................................................................................... 71 Table 40. getMemoryChunksInfo Response .................................................................................................................................. 72 Table 41. getStorageSubsystemInfo Request ............................................................................................................................... 73 Table 42. getStorageSubsystemInfo Response ............................................................................................................................ 74 Table 43. Configurable Storage Subsystem Attributes ............................................................................................................. 75 Table 44. getStorageControllerInfo Request ................................................................................................................................. 76 Table 45. getStorageControllerInfo Response .............................................................................................................................. 76 Table 46. getDriveInfo Request ........................................................................................................................................................... 79 Table 47. getDriveInfo Response ........................................................................................................................................................ 80 Table 48. deleteDrive Request ............................................................................................................................................................. 84

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    API Specification Software v2.4 April 2019

    10 Document Number: 608495-001

    Table 49. deleteDrive Response .......................................................................................................................................................... 84 Table 50. Set Drive Attributes .............................................................................................................................................................. 85 Table 51. getNetworkInterfaceInfo Request .................................................................................................................................. 85 Table 52. getNetworkInterfaceInfo Response ............................................................................................................................... 85 Table 53. Configurable Network Interface Attributes ................................................................................................................. 89 Table 54. getTrustedModuleInfo Request ...................................................................................................................................... 89 Table 55. getTrustedModuleInfo Response ................................................................................................................................... 90 Table 56. Configurable Trusted Module Attributes ..................................................................................................................... 91 Table 57. getFabricInfo Request ......................................................................................................................................................... 91 Table 58. getFabricInfo Response ...................................................................................................................................................... 92 Table 59. getSwitchInfo Request ........................................................................................................................................................ 93 Table 59. getSwitchInfo Response ..................................................................................................................................................... 94 Table 61. Configurable Switch Attributes........................................................................................................................................ 96 Table 62. getPortInfo Request ............................................................................................................................................................. 96 Table 63. getPortInfo Response .......................................................................................................................................................... 97 Table 64. Configurable Port Attributes ............................................................................................................................................ 99 Table 65. getEndpointInfo Request ................................................................................................................................................... 99 Table 66. getEndpointInfo Response ............................................................................................................................................. 100 Table 67. IP Transport Details ........................................................................................................................................................... 101 Table 68. Identifiers ............................................................................................................................................................................... 101 Table 69 addEndpoint Request ....................................................................................................................................................... 104 Table 70. IP Transport Details ........................................................................................................................................................... 104 Table 71 addEndpoint Response.................................................................................................................................................... 106 Table 72 deleteEndpoint Request .................................................................................................................................................. 107 Table 73 deleteEndpoint Response .............................................................................................................................................. 107 Table 74. Configurable Endpoint Attributes ............................................................................................................................... 108 Table 75. getPCIeDeviceInfo Request ............................................................................................................................................ 108 Table 76. getPCIeDeviceInfo Response ......................................................................................................................................... 109 Table 77. Set PCIe* Device Attributes ............................................................................................................................................ 111 Table 78. getPCIeFunctionInfo Request ....................................................................................................................................... 111 Table 79. getPCIeFunctionInfo Response .................................................................................................................................... 112 Table 80. getZoneInfo Request ........................................................................................................................................................ 113 Table 81. getZoneInfo Response ..................................................................................................................................................... 114 Table 82. addZone Request ............................................................................................................................................................... 115 Table 83. addZone Response ............................................................................................................................................................ 116 Table 84. deleteZone Request .......................................................................................................................................................... 117 Table 85. deleteZone Response ....................................................................................................................................................... 117 Table 86. addZoneEndpoints Request .......................................................................................................................................... 118 Table 87. addZoneEndpoints Response ....................................................................................................................................... 118 Table 88. deleteZoneEndpoints Request ..................................................................................................................................... 119 Table 89. deleteZoneEndpoints Response .................................................................................................................................. 119 Table 90. getEthernetSwitchInfo Request ................................................................................................................................... 120 Table 91. getEthernetSwitchInfo Response ................................................................................................................................ 120 Table 92. Configurable Ethernet Switch Attributes .................................................................................................................. 126 Table 93. getEthernetSwitchPortInfo Request ........................................................................................................................... 126 Table 94. getEthernetSwitchPortInfo Response ....................................................................................................................... 127 Table 95. Configurable Ethernet Switch Port Attributes ........................................................................................................ 131 Table 96. addEthernetSwitchPort Request ................................................................................................................................. 131 Table 97. addEthernetSwitchPort Response .............................................................................................................................. 132 Table 98. deleteEthernetSwitchPort Request ............................................................................................................................ 133

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    April 2019 API Specification Software v2.4

    Document Number: 608495-001 11

    Table 99. deleteEthernetSwitchPort Response ......................................................................................................................... 133 Table 100. addEthernetSwitchPortMembers Request .............................................................................................................. 134 Table 101 addEthernetSwitchPortMembers Response ........................................................................................................... 135 Table 102. deleteEthernetSwitchPortMembers Request ......................................................................................................... 135 Table 103. deleteEthernetSwitchPortMembers Response ...................................................................................................... 136 Table 104. getEthernetSwitchVxlanInfo Request ........................................................................................................................ 136 Table 105. getEthernetSwitchVxlanInfo Response ..................................................................................................................... 137 Table 106. addEthernetSwitchVxlan Request ............................................................................................................................... 138 Table 107. addEthernetSwitchVxlan Response ............................................................................................................................ 139 Table 108. deleteEthernetSwitchVxlan Request .......................................................................................................................... 139 Table 109. deleteEthernetSwitchVxlan Response ...................................................................................................................... 140 Table 110. getRemoteEthernetSwitchInfo Request ................................................................................................................... 141 Table 111. getRemoteEthernetSwitchInfo Response ................................................................................................................ 141 Table 112. getVlanInfo Request .......................................................................................................................................................... 143 Table 113. getVlanInfo Request .......................................................................................................................................................... 143 Table 114. Configurable VLAN Attributes ....................................................................................................................................... 144 Table 115. addVlan Request ................................................................................................................................................................ 145 Table 116. addVlan Response ............................................................................................................................................................. 145 Table 117. deleteVlan Request ........................................................................................................................................................... 146 Table 118. deleteVlan Response ........................................................................................................................................................ 146 Table 119. getPortVlanInfo Request ................................................................................................................................................. 147 Table 120. getPortVlanInfo Response .............................................................................................................................................. 147 Table 121. Configurable Port VLAN Attributes ............................................................................................................................. 149 Table 122. addPortVlan Request ........................................................................................................................................................ 149 Table 123. addPortVlan Response .................................................................................................................................................... 150 Table 124. deletePortVlan Request................................................................................................................................................... 150 Table 125. deletePortVlan Response ............................................................................................................................................... 151 Table 126. getPortStaticMacInfo Request ...................................................................................................................................... 151 Table 127. getPortStaticMacInfo Response ................................................................................................................................... 152 Table 128. Configurable Port Static MAC Attributes .................................................................................................................. 153 Table 129. addPortStaticMac Request ............................................................................................................................................. 153 Table 130. addPortStaticMac Response .......................................................................................................................................... 154 Table 131. deletePortStaticMac Request ........................................................................................................................................ 155 Table 132. deletePortStaticMac Response ..................................................................................................................................... 155 Table 133. getAclInfo Request ............................................................................................................................................................ 156 Table 134. getAclInfo Response ......................................................................................................................................................... 156 Table 135. addAcl Request ................................................................................................................................................................... 158 Table 136. addAcl Response ................................................................................................................................................................ 158 Table 137. deleteAcl Request .............................................................................................................................................................. 159 Table 138. deleteAcl Response ........................................................................................................................................................... 159 Table 139. addAclPort Request .......................................................................................................................................................... 160 Table 140. addAclPort Response ....................................................................................................................................................... 161 Table 141. deleteAclPort Request ..................................................................................................................................................... 161 Table 142. deleteAclPort Response .................................................................................................................................................. 162 Table 143. getAclRuleInfo Request ................................................................................................................................................... 162 Table 144. getAclRuleInfo Response ................................................................................................................................................ 163 Table 145. addAclRule Request .......................................................................................................................................................... 166 Table 146. addAclRule Response ....................................................................................................................................................... 168 Table 147. deleteAclRule Request ..................................................................................................................................................... 169 Table 148. deleteAclRule Response .................................................................................................................................................. 169

  • Intel® Rack Scale Design (Intel® RSD) GAMI

    API Specification Software v2.4 April 2019

    12 Document Number: 608495-001

    Table 149. Configurable ACL Rule Attributes ................................................................................................................................ 170 Table 150. getChassisInfo Request ................................................................................................................................................... 171 Table 151. getChassisInfo Response ................................................................................................................................................ 171 Table 152. SetChassis Attributes ........................................................................................................................................................ 174 Table 153. getPowerZoneInfo Request ........................................................................................................................................... 175 Table 154. getPowerZoneInfo Response ........................................................................................................................................ 175 Table 155. getPsuInfo Request ........................................................................................................................................................... 177 Table 156. getPsuInfo Response ........................................................................................................................................................ 178 Table 157. Configurable PSU Attributes ......................................................................................................................................... 180 Table 158. getThermalZoneInfo Request ....................................................................................................................................... 180 Table 159. getThermalZoneInfo Response .................................................................................................................................... 180 Table 160. Configurable PSU Attributes ......................................................................................................................................... 182 Table 161. getFanInfo Request ........................................................................................................................................................... 182 Table 162. getFanInfo Response ........................................................................................................................................................ 183 Table 163. getChassisSensorInfo Request ..................................................................................................................................... 185 Table 164. getChassisSensorInfo Response .................................................................................................................................. 185 Table 165. Configurable Fan Attributes ........................................................................................................................................... 187 Table 166. getAuthorizationCertificate Request .......................................................................................................................... 187 Table 167. getAuthorizationCertificate Response ....................................................................................................................... 187 Table 168. getStorageServiceInfo Request .................................................................................................................................... 188 Table 169. getStorageServiceInfo Response ................................................................................................................................. 189 Table 170. getStoragePoolInfo Request ......................................................................................................................................... 190 Table 171. getStoragePoolInfo Response ...................................................................................................................................... 191 Table 172. addStoragePool Request ................................................................................................................................................ 194 Table 173. addStoragePool Response ............................................................................................................................................. 195 Table 174. deleteStoragePool Request ........................................................................................................................................... 196 Table 175. deleteStoragePool Response ........................................................................................................................................ 197 Table 176. getVolumeInfo Request ................................................................................................................................................... 197 Table 177. getVolumeInfo Response ................................................................................................................................................ 198 Table 178. addVolume Request ...............................................


Recommended