DOCSLIB.ORG

Intel® Rack Scale Design (Intel® RSD) PODM Restful API Specification

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Intel® Rack Scale Design (Intel® RSD) PODM Restful API Specification Intel® Rack Scale Design (Intel® RSD) POD Manager (PODM) Representational State Transfer (REST) API Specification Software v2.5 July 2019 Revision 001 Document Number: 613320-001 You may not use or facilitate the use of this document in connection with any infringement or other legal analysis concerning Intel products described herein. You agree to grant Intel a non-exclusive, royalty-free license to any patent claim thereafter drafted which includes subject matter disclosed herein. No license (express, implied, by estoppel, or otherwise) to any intellectual property rights is granted by this document. All information provided here is subject to change without notice. Contact your Intel representative to obtain the latest Intel product specifications and roadmaps. 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. 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 secure. Check with your system manufacturer or retailer or learn more at www.intel.com. All information provided here is subject to change without notice. Contact your Intel representative to obtain the latest Intel product specifications and roadmaps. This document contains information on products, services, and/or processes in development. All information provided here is subject to change without notice. Contact your Intel representative to obtain the latest forecast, schedule, specifications, and roadmaps. The products and services described may contain defects or errors, known as errata, which may cause deviations from published specifications. Current characterized errata are available on request. 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 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. Intel® RSD POD Manager REST API Specification Software v2.5 July 2019 2 Document Number: 613320-001 Contents Table of Contents 1.0 Introduction ........................................................................................................................................................................... 7 1.1 Scope ............................................................................................................................................................................................. 7 1.2 Intended Audience .................................................................................................................................................................. 7 1.3 Conventions ............................................................................................................................................................................... 7 1.4 Notes and Symbol Conventions ......................................................................................................................................... 7 1.5 Terminology ............................................................................................................................................................................... 7 1.6 References ................................................................................................................................................................................... 8 2.0 PODM API ............................................................................................................................................................................. 10 2.1 PODM API Structure and Relations ................................................................................................................................ 10 2.1.1 PODM API Resource Hierarchy ...................................................................................................................... 10 3.0 Support for Requests with Query Parameters ............................................................................................................ 13 3.1 Query with Filter Attribute ................................................................................................................................................. 13 3.1.1 Example Queries ................................................................................................................................................. 13 4.0 PODM REST API Error Codes ........................................................................................................................................... 14 4.1 API Error Response ............................................................................................................................................................... 14 4.1.1 Message Object.................................................................................................................................................... 14 4.1.2 Error Message Definitions ............................................................................................................................... 14 4.1.3 Intel RackScale Message Registry ................................................................................................................ 15 4.1.4 Example Error JSON Object ........................................................................................................................... 15 4.2 API Error Codes ...................................................................................................................................................................... 16 4.2.1 General Error Codes........................................................................................................................................... 16 4.2.2 PATCH Method Error Codes ........................................................................................................................... 17 4.2.3 POST Method Error Codes .............................................................................................................................. 17 5.0 PODM REST API Definition ............................................................................................................................................... 19 5.1 Odata* Support ...................................................................................................................................................................... 19 5.2 Protocol Version .................................................................................................................................................................... 19 5.2.1 Operations ............................................................................................................................................................. 19 5.3 Odata* Service Document.................................................................................................................................................. 20 5.3.1 Operations ............................................................................................................................................................. 20 5.4 Tagged Values Oem extension ........................................................................................................................................ 21 5.4.1 PATCH operation ................................................................................................................................................ 21 5.5 Intel® RSD PODM Service Root ........................................................................................................................................ 22 5.5.1 Operations ............................................................................................................................................................. 22 5.6 Managers Collection ............................................................................................................................................................ 23 5.6.1 Operations ............................................................................................................................................................. 24 5.7 Manager..................................................................................................................................................................................... 25 5.7.1 Operations ............................................................................................................................................................. 28 5.8 Chassis Collection ................................................................................................................................................................. 29 5.8.1 Operations ............................................................................................................................................................. 29 5.9 Chassis ......................................................................................................................................................................................
Load more

Recommended publications
  • Server Base Manageability Requirements 1.0 Platform Design Document Non-Confidential
    Arm® Server Base Manageability Requirements 1.0 Platform Design Document Non-confidential Copyright © 2020 Arm Limited or its affiliates. All rights reserved. Document number: DEN0069B Server Base Manageability Requirements Server Base Manageability Requirements Copyright © 2020 Arm Limited or its affiliates. All rights reserved. Release inormation The Change History table lists the changes made to this document. Table 1-1 Change history Date Issue Confidentiality Change 30 January 2020 A Non-Confidential Initial release, SBMR 1.0 15 June 2020 B Non-Confidential License LES-PRE-21585 Page 2 of 45 Copyright © 2020 Arm Limited or its affiliates. All rights reserved. DEN0069B 1.0 Server Base Manageability Requirements Arm Non-Confidential Document Licence (“Licence”) This Licence is a legal agreement between you and Arm Limited (“Arm”) for the use of the document accompanying this Licence (“Document”). Arm is only willing to license the Document to you on condition that you agree to the terms of this Licence. By using or copying the Document you indicate that you agree to be bound by the terms of this Licence. If you do not agree to the terms of this Licence, Arm is unwilling to license this Document to you and you may not use or copy the Document. “Subsidiary” means any company the majority of whose voting shares is now or hereafter owner or controlled, directly or indirectly, by you. A company shall be a Subsidiary only for the period during which such control exists. This Document is NON-CONFIDENTIAL and any use by you and your Subsidiaries (“Licensee”) is subject to the terms of this Licence between you and Arm.
    [Show full text]
  • Defending Against Out-Of-Band Management BMC Attacks
    Defending Against Out-of-Band Management BMC Attacks Lee Fisher April 2019 LinuxFest NorthWest "Imagine trying to secure a computer with a small but powerful parasitic server on its motherboard; a bloodsucking leech that can't be turned off and has no documentation; you can't login, patch, or fix problems on it; server-based defensive, audit, or anti-malware software can’t be used for protection; its design is secret, implementation old, and it can fully control the computer's hardware and software; and it shares passwords with a bunch of other important servers, stores them in clear text for attackers to access. Not to mention it was designed for full control, remote management and monitoring, and it’s pretty damn good at it." --Dan Farmer, 2013 Agenda ● BMC/LOM concepts ● MC/SP (Intel ME/AMT, AMD PSP, Apple T2, ...) ● IPMI ● Intel SMM ● WS-MAN ● SMASH and DASH ● OpenBMC ● Redfish ● “IPMI++” (HP iLO, Dell iDRAC, ….) Credits ● All security guidance in this talk comes from existing BMC security research from: ● Dan Farmer, HD Moore, Matias Soler, Nicolas Waisman, Fabien Périgaud, Alexandre Gazet, Joffrey Czarny, Adrien Guinet, Jesse Michael, Mickey Shkatov, Oleksandr Bazhaniuk, ...and others that I am forgetting (sorry) CPU (and SMM) ● In early systems, the CPU was in charge of everything. Via the CPU, the firmware and OS code talked to the registers, RAM, and I/O busses. The CPU was in charge of system security. – This is the traditional model that attackers use, OS/app-level malware. ● On modern Intel (and AMD) systems, in addition to normal CPU mode, the CPU has a new mode, SMM (Systems Management Mode).
    [Show full text]
  • Integrated Dell Remote Access Controller 9 (Idrac9) Version 3.00.00.00 User's Guide Notes, Cautions, and Warnings
    Integrated Dell Remote Access Controller 9 (iDRAC9) Version 3.00.00.00 User's Guide Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. Copyright © 2017 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners. 2017-08 Rev. A01 Contents 1 Overview.......................................................................................................................................................17 Benefits of using iDRAC with Lifecycle Controller........................................................................................................18 Key features.......................................................................................................................................................................18 New in this release............................................................................................................................................................21 How to use this user's guide........................................................................................................................................... 21 Supported web browsers................................................................................................................................................22
    [Show full text]
  • Overview of DMTF Information and Data Models
    Overview of DMTF Information and Data Models ETSI NFV m-SDO Workshop, January 13, 2015 Presenter: Hemal Shah, Broadcom Corporation VP of Technology and Senior VP, DMTF Other Contributors: Enrico, John Leung, John Parchem, Bhumip, et al. Agenda • DMTF Technologies • DMTF Common Information Model (CIM) Overview • CIM based models/interfaces: NETMAN, VMAN, SMASH • Open Virtualization Format (OVF) • REST based Interfaces/Models: CIMI, CADF, Redfish • ETSI-NFV Infrastructure Management Mapping • Proposal to Move Forward 2 DMTF Management Technologies Infrastructure Management • Cloud • Virtualization • Data Center Platform Management • Server & Network • Storage (SNIA) • Desktop & Mobile Services Management • Network services DASH SMF • Software Entitlement • Security & audit NETMAN SMASH Protocols & Data Models (SMASH, PMCI, SMBIOS, CDM Redfish • WS-Man/CIM-XML SMF, Redfish) (SMI-S, CDM) (CDM, NETMAN) CIM, WBEM REST • REST/JSON/OData • CIM & Diagnostics • PLDM/MCTP 1/7/2016 DMTF Confidential 3 DMTF Common Information Model (CIM) • Common Information Model • Used by multiple orgs (e.g. SNIA SMI-S models for storage) • Core Specification • “Meta”-model, high level concepts and language definitions • “Core” and “Common” Models • Core Model contains info applicable to all mgmt domains • Common Models address specific domains • Application Applications and Services • Database Application Server • Device • Event Database • Interop Policy • Metrics Operating System/Virtualization Support • Network Systems, Devices/Storage, … Users/Security • Policy
    [Show full text]
  • A Year-In-Review with Jeff Hilland Prepare Now for 2019 Membership Dues and Changes in Case You Missed It • Youtube • Upcoming Events • More!
    Subscribe Past Issues Translate News from the DMTF View this email in your browser December 2018 Issue Highlights A Year-in-Review with Jeff Hilland Prepare Now for 2019 Membership Dues and Changes In Case You Missed It • YouTube • Upcoming Events • More! A Year-in-Review with Jeff Hilland Every year in our December issue, we take the opportunity to pause and reflect on the last twelve months. As we wrap up another highly productive year for DMTF, I’m happy to highlight the vast list of accomplishments the organization achieved in 2018: Technical Milestones Redfish Technical work on the Redfish® standard takes place in DMTF's Redfish Forum (formerly known as the Scalable Platforms Management Forum, or SPMF), with significant progress this year including: In April, DMTF announced that its Redfish standard has been adopted and published by the International Organization for Standardization (ISO) and the International Electrotechnical Commission (IEC) as ISO/IEC 30115:2018. Redfish’s publication by ISO/IEC as an International standard for Information Technology is expected to further accelerate worldwide adoption and interoperability. Redfish 2018.1 was released in May, with additional schemas for LDAP/ActiveDirectory support, as well as Server Sent-Eventing (SSE), and more. As part of the Redfish 2018.1 release, DMTF also debuted its new Redfish Resource and Schema Guide – a human- readable guide to the Redfish Schema to help educate users of Redfish. In September, updated Redfish DCIM Schemas were released as version 0.8 of the Redfish Data Center Equipment (DCIM) Model. Also in September, Redfish version 2018.2 was released, adding support for OpenAPI 3.0, as well as telemetry streaming and eventing, and improved event subscription methods.
    [Show full text]
  • DMTF Overview
    DMTF Overview Copyright © 2021 DMTF DMTF – An Industry Standards Organization WHO Led by innovative, industry-leading companies, DMTF has a global presence with members in multiple countries. WHAT DMTF standards support diverse emerging and traditional IT infrastructures including cloud, virtualization, network, servers and storage. A complete list is available at www.dmtf.org/standards. WHY Nationally and internationally recognized by ANSI and ISO, DMTF standards enable a more integrated and cost-effective approach to management through interoperable solutions. HOW Simultaneous development of Open Source and Open Standards is made possible by DMTF, which has the support, tools and infrastructure for efficient development and collaboration. 2 DMTF Board Member Companies 3 DMTF - International Standards Leader DMTF continues to grow its global presence • DMTF has a global presence with members in multiple countries • Members on: ü ISO JTC1/SC 38 representation ü ISO PAS submitter (only one of nine organizations in the world) Open and Collaborative • Industry input on standards welcome via the DMTF Feedback Portal • Open source development enabled within GitHub - DMTF invites review and contributions to its tools in public GitHub repositories • Standards adopted by open source projects, including Java WBEM Services, Open Linux Management Infrastructure (OpenLMI), Open Management Interface (OMI), OpenBMC, OpenDRIM, OpenPegasus, OpenStack Ceilometer, OpenStack Ironic, Small Footprint CIM Broker (SFCB), and more 4 5 Academic Alliances "Gheorghe
    [Show full text]
  • Theory on Platform Management Communications Infrastructure
    IARJSET ISSN (Online) 2393-8021 ISSN (Print) 2394-1588 International Advanced Research Journal in Science, Engineering and Technology Vol. 8, Issue 5, May 2021 DOI: 10.17148/IARJSET.2021.8572 Theory on Platform Management Communications Infrastructure Dandolu Chetan Karthikeya Reddy1, Chethana G2 Student, Electronics and Communication Engineering, R.V College of Engineering, India1 Assistant Professor, Electronics and Communication Engineering, R.V College of Engineering, India2 Abstract: Platform Management Communications Infrastructure (PMCI) Working Group develops standards for “inside the box” communication between platform management subsystem components. The Network Controller Sideband Interface (NCSI), Management Component Transport Protocol (MCTP), Platform Level Data Model (PLDM), and Security Protocol and Data Model (SPDM)are the standards that are developed by the PMCI group. These standards enable monitoring and control of systems regardless of the status of the operating system, whether it is running or not. This Paper Discusses how these four specifications effect on platform management subsystem. Keywords: PMCI, NC-SI, MCTP, PLDM, SPDM, platform management subsystem. I. INTRODUCTION Distributed Management Task Force (DMTF) fabricates open standards for IT infrastructures like cloud, servers, network and storage. Alliance partners and Member companies like Broadcom Inc., Cisco, Dell Technologies, Hewlett Packard Enterprise, Intel Corporation, Lenovo, NetApp, Positivo Tecnologia S.A., and Verizon work together to improve the standards of inter-operable management of information technologies. Fig 1: Platform Management Subsystem Platform Management Subsystem gives the ability to keeptrack and report on the health of the system hardware through isolated software (or hardware) that does not depend on the operational state of the hardware. Platform management is very important for enterprise-class systems.The platform management hardware most cases resides on the same board as the system hardware.
    [Show full text]
  • Overview of DMTF Information and Data Models
    Overview of DMTF Information and Data Models ETSI NFV m-SDO Workshop, January 13, 2015 Presenter: Hemal Shah, Broadcom Corporation VP of Technology and Senior VP, DMTF Other Contributors: Enrico, John Leung, John Parchem, Bhumip, George, Peter, et al. Agenda • DMTF Technologies • DMTF Common Information Model (CIM) Overview • CIM based models/interfaces: NETMAN, VMAN, SMASH • Open Virtualization Format (OVF) • REST based Interfaces/Models: CIMI, CADF, Redfish • ETSI-NFV Infrastructure Management Mapping • Proposal to Move Forward 2 DMTF Management Technologies Infrastructure Management • Cloud • Virtualization • Data Center Platform Management • Server & Network • Storage (SNIA) • Desktop & Mobile Services Management • Network services DASH SMF • Software Entitlement • Security & audit NETMAN SMASH Protocols & Data Models (SMASH, PMCI, SMBIOS, CDM Redfish • WS-Man/CIM-XML SMF, Redfish) (SMI-S, CDM) (CDM, NETMAN) CIM, WBEM REST • REST/JSON/OData • CIM & Diagnostics • PLDM/MCTP 1/22/16 DMTF Confidential 3 DMTF Common Information Model (CIM) • Common Information Model • Used by multiple orgs (e.g. SNIA SMI-S models for storage) • Core Specification • “Meta”-model, high level concepts and language definitions • “Core” and “Common” Models • Core Model contains info applicable to all mgmt domains • Common Models address specific domains • Application Applications and Services • Database Application Server • Device • Event Database • Interop Policy • Metrics Operating System/Virtualization Support • Network Systems, Devices/Storage, … Users/Security
    [Show full text]
  • Storage Management
    Power Matters.TM Next generation of ecosystem storage management Balaji Marimuthu, Manager Software Development, Microsemi [email protected] © 2018 Microsemi Corporation. Company Proprietary 1 Introduction § With the current hyperscale datacenters, managing multi-vendor storage hardware using one simple user friendly tool is the datacenter admins desire. Server and storage Industries are trying to solve this common problem by providing a standard way of storage management. DMTF and SNIA have attempted to standardize the storage management using CIM and SMI-S standards for a decade. Now DMTF and SNIA have reviewed the lessons we learnt in a decade and have come up with Redfish and Swordfish. A simplified and easy to implement and use standards for the next generation of storage management. In addition to the standard based storage management, below are the common ask on the next generation of storage management. § AI/ML based data analysis for prediction, notification and automated error recovery § In-band and Out of band management § Capability to run as containerized / server less application © 2018 Microsemi Corporation. Company Proprietary Power Matters.TM 2 Flavors of storage management tools § GUI § CLI § APIs (SDKs, RESTFul service,..) § Plugins (vSphere WC, OpenStack Horizon, LSMCLI,…) § Standalone scripts § Microservices for a specific functionality © 2018 Microsemi Corporation. Company Proprietary Power Matters.TM 3 Storage management tools requirements q Secure q Standard based q Easy to configure and provision the storage device q Monitoring q Notification q Alerts and events q Email and SMS notification q Push notification on mobile devices q Firmware upgrade q Progress task management q Online help q Discovery service q Log management q Scheduler service q Statistics q Topology view q Fault detection and remediation © 2018 Microsemi Corporation.
    [Show full text]
  • Integrated Dell Remote Access Controller 8/7 Version 2.60.60.60 User's Guide
    Integrated Dell Remote Access Controller 8/7 Version 2.60.60.60 User’s Guide Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. Copyright © 2018 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners. 2018 - 06 Rev. A00 Contents 1 Overview...................................................................................................................................................... 15 Benefits of using iDRAC with Lifecycle Controller....................................................................................................... 16 Key features...................................................................................................................................................................... 16 New in this release............................................................................................................................................................19 How to use this user guide..............................................................................................................................................19 Supported web browsers.................................................................................................................................................19
    [Show full text]
  • Validation of Redfish – the Scalable Platform Management Standard
    Validation of Redfish – The Scalable Platform Management Standard by Priyanka Kumari, B.E. A Thesis In Computer Science Submitted to the Graduate Faculty of Texas Tech University in Partial Fulfillment of the Requirements for the Degree of MASTER OF SCIENCES Approved Dr. Yong Chen Chair of Committee Dr. Alan Sill Dr. Yu Zhuang Mark Sheridan Dean of the Graduate School May, 2017 Copyright 2017, Priyanka Kumari Texas Tech University, Priyanka Kumari, May 2017 ACKNOWLEDGMENTS I would like to express my deepest appreciation to my advisor Dr. Yong Chen and my mentor Dr. Alan Sill for their persistent support, guidance, and encouragement without which this work would not have been possible. I thank them for providing me with the opportunity to work under their valued supervision. They were always there to help and guide me with my research and report. The experience has been enriching for me to grow both professionally and personally, and in a whole helped me become a better person. I would also like to thank Fatima Saleem from Intel and Paul Vancil from Dell for their support and invaluable guidance throughout my research. I am also thankful to DMTF for providing me the opportunity as well as all the needed resources to make this research successful. I really appreciate all their time and effort. I would like to thank my committee member, Dr. Yu Zhuang, for his timely help, valuable suggestions and inputs. I would also like to thank TTU students Elham Hojati, Ali Nosrati and Ghazanfar Ali, for their continual suggestions on this research. Finally, I must express my profound gratitude to my family and friends for the support and continuous encouragement throughout my study, research process and report writing.
    [Show full text]
  • HPE MSA 1060/2060/2062 Storage Management Guide
    HPE MSA 1060/2060/2062 Storage Management Guide Abstract This guide covers concepts used to administer an HPE MSA 1060/2060/2062 Storage system and provides information about managing the system by using its web interface, the Storage Management Utility (SMU). Part Number: R0Q73-90009 Published: September 2020 Edition: 1 © Copyright 2020 Hewlett Packard Enterprise Development LP Notices The information contained herein is subject to change without notice. The only warranties for Hewlett Packard Enterprise products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Hewlett Packard Enterprise shall not be liable for technical or editorial errors or omissions contained herein. Confidential computer software. Valid license from Hewlett Packard Enterprise required for possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. Links to third-party websites take you outside the Hewlett Packard Enterprise website. Hewlett Packard Enterprise has no control over and is not responsible for information outside the Hewlett Packard Enterprise website. Acknowledgments Intel®, Itanium®, Pentium®, Intel Inside®, and the Intel Inside logo are trademarks of Intel Corporation in the United States and other countries. Microsoft® and Windows® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated. Java® and Oracle® are registered trademarks of Oracle and/or its affiliates.
    [Show full text]