Lenovo Xclarity Controller REST API Guide Note: Before Using This Information, Read the General Information in “Notices” on Page Ccxciii
Total Page:16
File Type:pdf, Size:1020Kb
Lenovo XClarity Controller REST API Guide Note: Before using this information, read the general information in “Notices” on page ccxciii. Sixth Edition (Mar 2021) © Copyright Lenovo 2017, 2021. LIMITED AND RESTRICTED RIGHTS NOTICE: If data or software is delivered pursuant to a General Services Administration (GSA) contract, use, reproduction, or disclosure is subject to restrictions set forth in Contract No. GS-35F-05925. Contents Chapter 1. Introduction . 1 GET – Collection of Network adapters . 49 Authentication Methods . 1 GET – Network adapter properties. 50 Lenovo Extended Registries . 2 Resource NetworkPort . 53 Tools for Redfish . 2 GET – Collection of network ports . 53 GET – Network port properties . 54 Chapter 2. Service Root . 5 Resource NetworkDeviceFunction . 55 Resource ServiceRoot . 5 GET – Collection of Network device GET – Service root properties . 5 function . 56 GET – Network device PCIe functions . 57 Chapter 3. Session Management . 9 PATCH – Update network device PCIe Resource SessionService . 9 functions resource . 60 GET – Session management properties. 9 Resource Session . 10 Chapter 7. Power, thermal and GET – Session properties . 10 redundancy . 63 POST– Create a session. 11 Resource Power . 63 DELETE– Delete a session . 12 GET – Power management properties . 63 PATCH – Update power management Chapter 4. Account Management . 15 properties . 77 Resource AccountService . 15 Resource Power (Flex System Enterprise Chassis or Lenovo D2 Enclosure) . 79 GET – Account management properties . 15 GET – Power management properties . 79 PATCH – Update global account lockout properites and ldap properties . 18 Resource Thermal . 80 Resource ManagerAccount . 21 GET – Thermal management properties. 80 GET – Account properties . 21 Chapter 8. BMC Management. 85 POST – Create an account. 23 Resource Manager . 85 PATCH – Update userid/password/role/ PasswordChangeRequired . 26 GET – BMC management properties . 85 Resource Role . 28 PATCH – Update BMC time zone and other oem properties . 90 GET – Role properties . 28 POST – BMC reset . 93 PATCH – Update custom role privileges . 31 POST – BMC reset to factory defaults . 94 Chapter 5. Chassis Management . 33 Chapter 9. Network management. 95 Resource Chassis . 33 Resource EthernetInterface (BMC NIC). 95 GET – Collection for chassis . 33 GET – Collection of BMC ethernet interface GET – Chassis properties . 34 properties . 95 PATCH – Update chassis asset tag and GET – BMC Ethernet properties. 96 location LED and other location properties . 39 PATCH – Update BMC Ethernet Resource Chassis (Flex System Enterprise Chassis configurations . 102 or Lenovo D2 Enclosure . 43 PATCH – Update BMC Ethernet over USB GET – Collection for Flex System Enterprise configurations . 107 Chassis or Lenovo D2 Enclosure . 43 Resource EthernetInterface (Server NIC) . 110 GET – Flex System Enterprise Chassis or Lenovo D2 Enclosure properties . 44 GET – Collection of server Ethernet interfaces . 110 Resource Sensor . 45 GET – Server Ethernet interface properties . 111 GET – Chassis properties . 46 GET – Server Ethernet over USB Chapter 6. Network Adapter properties . 112 Devices. 49 Resource HostInterface. 114 GET – Collection of host interface . 114 Resource NetworkAdapters . 49 © Copyright Lenovo 2017, 2021 i GET – Host interface properties . 115 Resource Memory . 165 PATCH – Enable/disable host interface . 116 GET – Collection of server memories . 165 GET – Collection of ethernet interface . 117 GET – Memory properties . 167 Resource ManagerNetworkProtocol . 118 Resource NetworkInterface . 171 GET – BMC network services. 118 GET – Collection of network interfaces . 171 PATCH – Update BMC network service GET – Server network interfaces . 172 configurations . 122 Resource PCIeDevice . 173 GET – Server PCIe devices . 173 Chapter 10. Serial Interface Management . 127 Resource PCIeFunction. 175 GET – Functions of server PCIe functions . 175 Resource SerialInterface . 127 Resource PCIeSlot . 177 GET – Collection of BMC serial interface . 127 GET – Server PCIe slots . 177 GET – BMC serial interface properties . 128 Resource Processor . 179 PATCH – Update BMC serial interface configurations . 129 GET – Collection of CPUs . 179 GET – CPU properties . 180 Chapter 11. Virtual Media Resource ProcessorMetric . 184 Management . 131 GET – Processor metric properties . 184 Resource VirtualMedia . 131 Resource Memory Metrics . 186 GET – Collection of virtual media . 131 GET – memory metrics properties . 186 GET – Virtual media properties . 132 PATCH – Insert/Eject a virtual media . 133 Chapter 15. Storage Management . 187 Chapter 12. Server Management . 135 Resource Storage . 187 Resource ComputerSystem . 135 GET – Collection of storage controllers . 187 GET – Collection for server. 135 GET – Storage controller properties . 188 GET – Server properties . 136 Resource Drive . 192 PATCH – Update next-one-time boot GET – Drives managed by storage configurations and other properties . 144 controller . 192 POST – Server reset operations . 146 Resource Volume . 195 GET – Volumes managed by storage Chapter 13. Log Service and Event controller . 195 Log . 147 Resource StoragePool . 198 Resource LogService . 147 GET – StoragePool managed by storage GET – Collection of BMC log services . 147 controller . 198 GET – Service for BMC active logs . 148 Chapter 16. BIOS Setting and Boot GET – Service for BMC Platform event logs. 149 Management . 201 GET – Service for BMC audit event logs . 151 Resource Bios . 201 GET – Service for BMC Maintenance event GET – Resource for BIOS . 201 logs. 152 POST – Change BIOS password settings . 203 GET – Service for BMC Service Advisor event POST – Reset BIOS operation . 204 logs. 153 GET – The pending BIOS settings . 205 POST – Clear event logs . 154 PATCH – Update pending BIOS settings . 206 Resource LogEntry . 155 Resource AttributeRegistry . 207 GET – BMC active log entries. 155 GET – BIOS attribute registries . 207 GET – BMC Platform event log entries . 157 Resource SecureBoot . 212 GET – BMC Audit event log entries . 158 GET – Secure boot properties . 212 GET – BMC Maintenance event log entries . 160 PATCH – Update secure boot properties . 213 GET – BMC Service Advisor event log POST – Reset secure boot keys. 215 entries. 161 Resource BootOption . 217 Chapter 14. Server Inventory . 165 GET – Collection of Boot options . 217 ii Lenovo XClarity Controller REST API Guide GET – Boot options properties . 218 GET – Telemetry service properties . 263 GET – Action info of Chapter 17. Firmware Inventory and SubmitTestMetricReport . 264 Update Service. 221 POST – Submit a test Metric Report . 265 Resource UpdateService . 221 Resource MetricReportDefinition . 266 GET – Properties for firmware update GET – Collection of MetricReportDefinition . 266 service . 221 GET – MetricReportDefinition properties . 268 PATCH– Update update service status . 223 Resource MetricReport . 270 POST – Simple update for firmware . 225 GET – Collection of MetricReport . 270 POST – HTTP Push update for firmware . 228 GET – MetricReport properties . 272 POST – Multipart HTTP Push update for Resource MetricDefinition . 273 firmware . 235 GET – Collection of MetricDefinition . 273 Resource FirmwareInventory. 240 GET – MetricDefinition inventory GET – Collection for firmware inventories on properties . 274 the server . 240 GET – Firmware inventory properties. 241 Chapter 21. Job Management. 277 Chapter 18. Task Management . 245 Resource JobService . 277 GET - Job management properties . 277 Resource TaskService . 245 Resource Job . 278 GET – Task service properties . 245 GET – Job properties . 278 Resource Task . 246 PATCH – Update Schedule properties . 280 GET – Task properties . 246 Chapter 22. Certificate Chapter 19. Event Service. 249 Management . 283 Resource EventService . 249 Resource CertificateService . 283 GET – Event service properties . 249 GET – Certificate service properties . 283 POST – Submit a test event . 251 POST – Generate CSR . 284 Resource Event Subscription . 252 POST – Replace Certificate . 286 GET – Collection of event subscriptions . 253 Resource CertificateLocations . 287 GET – Event subscriptions . 253 GET – Certificate locations properties . 287 POST – Create a subscription . 255 Resource Certificate . 288 DELETE– Delete a subscription . 257 GET – Certificate properties . 288 SSE subscription . 258 POST – Rekey . 290 Event . 260 POST – Renew . 291 Event properties . 260 Notices . ccxciii Chapter 20. Telemetry Trademarks . ccxciv Management . 263 Index . 295 Resource TelemetryService . 263 © Copyright Lenovo 2017, 2021 iii iv Lenovo XClarity Controller REST API Guide Chapter 1. Introduction The Lenovo XClarity Controller (XCC) provides support for the industry standard Redfish Scalable Platforms Management API. The Redfish API can be used to access XCC data and services from applications running outside of the XCC. This allows for easy integration of Lenovo XCC capabilities into Lenovo or 3rd party software. Redfish uses RESTful interface semantics and JSON resource payload to perform system management via the HTTPS protocol. It is suitable for a wide range of servers, from stand-alone servers to rack mount and bladed environments, and scales equally well for large scale cloud environments. The XClarity Controller currently supports Redfish Specification v1.10.0 and Redfish Schema Bundle 2020.1. This document explains how to use the Redfish functions of the XClarity Controller on ThinkSystem servers. For more information on the Redfish industry standard, please refer to the following resources: