Enginehttp500

DocumentNumber:608494-001IntelRackScaleDesign(RSD)RackManagementModule(RMM)RepresentationalStateTransfer(REST)APISpecificationSoftwarev2.
4April2019Revision001IntelRSDRMMRESTAPISpecificationSoftwarev2.
4April20192DocumentNumber:608494-001YoumaynotuseorfacilitatetheuseofthisdocumentinconnectionwithanyinfringementorotherlegalanalysisconcerningIntelproductsdescribedherein.
YouagreetograntIntelanon-exclusive,royalty-freelicensetoanypatentclaimthereafterdraftedwhichincludessubjectmatterdisclosedherein.
Nolicense(express,implied,byestoppel,orotherwise)toanyintellectualpropertyrightsisgrantedbythisdocument.
Allinformationprovidedhereissubjecttochangewithoutnotice.
ContactyourIntelrepresentativetoobtainthelatestIntelproductspecificationsandroadmaps.
Inteldisclaimsallexpressandimpliedwarranties,includingwithoutlimitation,theimpliedwarrantiesofmerchantability,fitnessforaparticularpurpose,andnoninfringement,aswellasanywarrantyarisingfromcourseofperformance,courseofdealing,orusageintrade.
Inteltechnologies'featuresandbenefitsdependonsystemconfigurationandmayrequireenabledhardware,software,orserviceactivation.
Performancevariesdependingonsystemconfiguration.
Nocomputersystemcanbesecure.
Checkwithyoursystemmanufacturerorretailerorlearnmoreatwww.
intel.
com.
Allinformationprovidedhereissubjecttochangewithoutnotice.
ContactyourIntelrepresentativetoobtainthelatestIntelproductspecificationsandroadmaps.
Thisdocumentcontainsinformationonproducts,services,and/orprocessesindevelopment.
Allinformationprovidedhereissubjecttochangewithoutnotice.
ContactyourIntelrepresentativetoobtainthelatestforecast,schedule,specifications,androadmaps.
Theproductsandservicesdescribedmaycontaindefectsorerrors,knownaserrata,whichmaycausedeviationsfrompublishedspecifications.
Currentlycharacterizederrataareavailableonrequest.
Copiesofdocumentsthathaveanordernumberandarereferencedinthisdocumentmaybeobtainedbycalling1-800-548-4725orbyvisitingwww.
intel.
com/design/literature.
htm.
IntelandtheIntellogoaretrademarksofIntelCorporationintheUnitedStatesandothercountries.
*Othernamesandbrandsmaybeclaimedasthepropertyofothers.
Copyright2019IntelCorporation.
Allrightsreserved.
IntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-0013Contents1.
0Introduction61.
1Scope.
61.
2IntendedAudience61.
3Conventions61.
4NotesandSymbolConvention.
61.
5JSON*SerializationConvention.
71.
6HTTPResponseCodes.
71.
7Terminology71.
8ReferenceDocuments.
82.
0Overview102.
1APIStructureandRelation.
102.
2RackManagementModelandDefinitions113.
0RMMRESTAPIErrorCode.
123.
1APIErrorResponse.
123.
1.
1MessageObject.
123.
1.
2ErrorMessageDefinitions123.
1.
3IntelRackScaleMessageRegistry133.
1.
4ExampleErrorJSONObject133.
2APIErrorCodes.
143.
2.
1GeneralErrorCodes.
143.
2.
2PATCHMethodErrorCodes.
154.
0RackManagementModuleAPIDefinition.
164.
1Odata*Support.
164.
2AsynchronousOperations.
164.
3ProtocolVersion.
164.
3.
1Operations.
174.
4OdataServiceDocument174.
4.
1Operations.
174.
5IntelRSDOEMExtensions.
184.
6ServiceRoot.
194.
6.
1Operations.
194.
7ManagerCollection.
204.
7.
1Operations.
204.
8Manager.
214.
8.
1Operations.
214.
9MetricDefinitionCollection244.
9.
1Operations.
244.
10MetricDefinition254.
10.
1Operations.
254.
11TelemetryService264.
11.
1Operations.
264.
12ChassisCollection274.
12.
1Operations.
284.
13Chassis.
284.
13.
1Operations.
294.
14Power314.
14.
1Operations.
31IntelRSDRMMRESTAPISpecificationSoftwarev2.
4April20194DocumentNumber:608494-0014.
15Thermal.
344.
15.
1Operations.
344.
16UpdateService364.
16.
1Operations.
374.
17ActionInfo.
384.
17.
1Operations.
394.
18RMM–PSMECommonResources40FiguresFigure1.
TypicalRackComponents.
11Figure2.
ChassisCollectionRelationshipbetweenComponents.
27Figure3.
SimpleUpdateActionComponentInteractions.
38TablesTable1.
Terminology7Table2.
ReferenceDocumentsandResources.
8Table3.
ResourcesandUniformResourceIdentifiers(URIs)10Table4.
RackManagementDefinitions11Table5.
APIErrorResponseAttributes12Table6.
APIErrorResponseAttributes12Table7.
HTTPErrorStatusCodes14Table8.
ChassisProperties.
30Table9.
DesiredFanSpeedProperties36Table10.
RMM-PSMECommonResources.
40IntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-0015RevisionHistoryRevisionDescriptionDate001InitialreleaseforIntelRSDSoftwarereleasev2.
4April2019IntroductionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April20196DocumentNumber:608494-0011.
0IntroductionThisdocumentdefinestheinterfaceoftheIntelRackScaleDesign(IntelRSD)RackManagementModule(RMM)Softwarev2.
4.
1.
1ScopeTheinterfacespecifiedinthisdocumentisbasedontheDistributedManagementTaskForce's(DMTF)Redfish*ScalablePlatformsAPISpecification(DSP0266v1.
5.
0)andRedfishAPISchemaReadmev2018.
1(DSP8010v2018.
1)(refertoTable2).
1.
2IntendedAudienceTheintendedaudienceforthisdocumentincludesdesignersandengineersworkingwiththeSoftwarev2.
4release,portingthissoftwaretohardwareplatforms.
1.
3ConventionsThekeywords/phrases"MUST","MUSTNOT","REQUIRED","SHALL","SHALLNOT","SHOULD","SHOULDNOT","RECOMMENDED","MAY",and"OPTIONAL"inthisdocumentaretobeinterpretedasdescribedinKeywordsforuseinRFCstoIndicateRequirementLevels,March1997,RFC2119(refertoTable2).
1.
4NotesandSymbolConventionSymbolandnoteconventionissimilartotypographicalconventionsusedinCloudInfrastructureManagementInterface6(CIMI)ModelandRESTfulHTTP-basedProtocol7anInterfaceforManagingCloudInfrastructure,RFC2119(refertoTable2).
NotationusedinJavaScriptObjectNotation*(JSON*)serializationdescription:MandatoryinitalicsindicatedatatypesinsteadofliteralMandatoryCharactersareappendedtoitemstoindicatecardinality:""(0or1)"*"(0ormore)"+"(1ormore)Verticalbars,"|",denotechoice.
Forexample,"a|b"meansachoicebetween"a"and"b"Parentheses,"("and")",areusedtoindicatethescopeoftheoperatorsand"|"Ellipses(thatis,indicatepointsofextensibilityThelackofellipsesdoesnotmeannoextensibilitypointexists;ratheritisjustnotexplicitlycalledout.
IntroductionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-00171.
5JSON*SerializationConventionAnobjectisanunorderedsetofname/valuepairs.
Anobjectbeginswith{(leftbrace)andendswith}(rightbrace).
Eachnameisfollowedbya:(colon)andthename/valuepairsareseparatedbya,(comma).
Anarrayisanorderedcollectionofvalues.
Anarraybeginswith[(leftbracket)andendswith](rightbracket).
Valuesareseparatedbya:(comma).
Avaluecanbeastringindoublequotes,oranumber;ortrueorfalseornull;oranobjectoranarray.
Thesestructurescanbenested.
AstringisasequenceofzeroormoreUnicodecharacters,wrappedindoublequotes,usingbackslashescapes.
Acharacterisrepresentedasasinglecharacterstring.
AstringisverymuchlikeaCorJava*string.
AnumberisverymuchlikeaCorJavanumber,exceptthattheoctalandhexadecimalformatsarenotused.
1.
6HTTPResponseCodesTheHTTPResponseCodesarelistedinScalablePlatformsManagementAPISpecification,DSP0266,Section6.
5.
2(refertoTable2).
1.
7TerminologyTable1.
TerminologyTermDefinitionAPIApplicationProgrammingInterfaceBMCBaseboardManagementControllerCIMICloudInfrastructureManagementInterfaceCMControllerModuleOEMOriginalEquipmentManufacturesPODAphysicalcollectionofmultipleracksPODMPODManagerHTTPHypertextTransferProtocolIntelRSDIntelRackScaleDesignJSON*JavaScriptObjectNotation*MBPManagementBackplanePSMEPooledSystemManagementEnginePSUPowerSupplyUnitRESTRepresentationalStateTransferRMCRackManagementControllerRMMRackManagementModuleSSDPSimpleServiceDirectoryProtocolURIUniformResourceIdentifierURLUniformResourceLocatorUUIDUniversallyUniqueIdentifierIntroductionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April20198DocumentNumber:608494-0011.
8ReferenceDocumentsTable2.
ReferenceDocumentsandResourcesDocIDTitleLocation608486IntelRackScaleDesign(IntelRSD)PooledSystemManagementEngine(PSME)UserGuideSoftwarev2.
4Note:Note:https://www.
intel.
com/content/www/us/en/architecture-and-technology/rack-scale-design/rack-scale-design-resources.
html608487IntelRackScaleDesign(IntelRSD)ConformanceandSoftwareReferenceKitGettingStartedGuidev2.
4608488IntelRackScaleDesign(IntelRSD)PODManager(PODM)ReleaseNotesSoftwarev2.
4608490IntelRackScaleDesign(IntelRSD)PooledSystemManagement(PSME)ReleaseNotesSoftwarev2.
4608491IntelRackScaleDesignStorageServicesAPISpecificationSoftwarev2.
4608492IntelRackScaleDesign(IntelRSD)ArchitectureSpecificationSoftwarev2.
4608493IntelRackScaleDesign(IntelRSD)PodManager(PODM)RepresentationalStateTransfer(REST)APISpecificationSoftwarev2.
4608495IntelRackScaleDesign(IntelRSD)GenericAssetsManagementInterface(GAMI)APISpecificationv2.
4608496IntelRackScaleDesign(IntelRSD)PooledSystemManagementEngine(PSME)RESTAPISpecificationSoftwarev2.
4608497IntelRackScaleDesign(IntelRSD)ConformanceTestSuite(CTS)ReleaseNotes608489IntelRackScaleDesign(IntelRSD)PODManager(PODM)UserGuideSoftwarev2.
4N/AFieldProgrammableGateArray(FPGA)overFabricProtocolArchitectureSpecificationhttps://cdrdv2.
intel.
com/v1/dl/getContent/608298N/AIntelRackScaleDesign(IntelRSD)forCascadeLakePlatformFirmwareExtensionSpecificationhttps://cdrdv2.
intel.
com/v1/dl/getContent/596167DSP0263CloudInfrastructureManagementInterface6(CIMI)ModelandRESTfulHTTP-basedProtocol7AnInterfaceforManagingCloudInfrastructurehttps://www.
dmtf.
org/sites/default/files/standards/documents/DSP0263_1.
0.
0.
pdfDSP0266Redfish*ScalablePlatformsManagementAPISpecificationv1.
5.
0https://www.
dmtf.
org/sites/default/files/standards/documents/DSP0266_1.
5.
0.
pdfDSP8010Redfish*APISchemaReadmev2018.
1https://www.
dmtf.
org/sites/default/files/standards/documents/DSP8010_2018.
1.
zipRFC2119KeywordsforuseinRFCstoIndicateRequirementLevels,March1997https://ietf.
org/rfc/rfc2119.
txtRFC5789IETFPATCHMethodforHTTPhttps://tools.
ietf.
org/html/rfc5789IntroductionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-0019DocIDTitleLocationRFC7230HypertextTransferProtocol(HTTP/1.
1):MessageSyntaxandRoutinghttps://www.
rfc-editor.
org/rfc/pdfrfc/rfc7230.
txt.
pdfN/ARedfishBaseRegistryv1.
0.
0https://www.
dmtf.
org/sites/default/files/standards/documents/DSP8011_1.
0.
0a.
jsonNOTE:Copiesofdocumentshavinganordernumber,referencedinthisdocument,whichcannotbeaccessedmaybeobtainedbycalling18005484725orbyvisitingwww.
intel.
com/design/literature.
htmanddownloadacopy.
OverviewIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201910DocumentNumber:608494-0012.
0OverviewTheIntelRSDRMMRESTAPIv2.
4providestheREST-basedinterfacethatallowsforfullmanagementoftheRMM,includingassetdiscoveryandconfiguration.
2.
1APIStructureandRelationTable3providestheresourcesanduniformresourceidentifiers(URIs).
Table3.
ResourcesandUniformResourceIdentifiers(URIs)ResourceSchemaVersionURIServiceRootv1_3_1/redfish/v1ChassisCollection-/redfish/v1/ChassisCollectionChassisV1_7_0/redfish/v1/Chassis/{chassisID}PowerV1_5_0/redfish/v1/Chassis/{chassisID}/PowerThermalV1_4_0/redfish/v1/Chassis/{chassisID}/ThermalManagersCollection-/redfish/v1/ManagersManagerV1_4_0/redfish/v1/Managers/{managerID}NetworkProtocolV1_2_0/redfish/v1/Managers/{managerID}/NetworkProtocolEthernetInterfacesCollection-/redfish/v1/Managers/{managerID}/EthernetInterfacesEthernetInterfacesV1_4_0/redfish/v1/Managers/{managerID}/EthernetInterfaces/{nicID}VLANNetworkInterfacesCollection-/redfish/v1/Managers/{managerID}/EthernetInterfaces/{nicID}/VLANsVLANsNetworkInterfacesV1_1_0/redfish/v1/Managers/{managerID}/EthernetInterfaces/{nicID}/VLANs/{vlanID}EventServiceV1_1_0/redfish/v1/EventServiceEventSubscriptionsCollection-/redfish/v1/EventService/SubscriptionsEventSubscriptionV1_3_0/redfish/v1/EventService/Subscriptions/{subscriptionID}TaskServiceV1_1_0/redfish/v1/TaskServiceTaskCollection-/redfish/v1/TaskService/TasksTaskV1_2_0/redfish/v1/TaskService/Tasks/{taskID}TelemetryServiceWIP/redfish/v1/Oem/Intel_RackScale/TelemetryServiceMetricDefinitionsCollectionWIP/redfish/v1/Oem/Intel_RackScale/TelemetryService/MetricDefinitionsMetricDefinitionsWIP/redfish/v1/Oem/Intel_RackScale/TelemetryService/MetricDefinitions/{metricDefinitionId}UpdateServiceV1_2_1/redfish/v1/UpdateServiceActionInfoV1_0_3/redfish/v1/UpdateService/SimpleUpdateActionInfoAccountServiceV1_3_0/redfish/v1/AccountServiceRoleV1_2_1/redfish/v1/AccountService/Roles/AdministratorSessionServiceV1_1_3/redfish/v1/SessionServiceSessionV1_1_0/redfish/v1/SessionService/Sessions/Session1ManagerAccountV1_1_2/redfish/v1/AccountService/Accounts/Account1OverviewIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-001112.
2RackManagementModelandDefinitionsFigure1illustratestypicalrackcomponentsmanagedbytheIntelRMMAPISpecificationSoftwarev2.
4.
Figure1.
TypicalRackComponentsTable4.
RackManagementDefinitionsTermDefinitionRackIncludesoneormultiplePowerandThermalZones.
PowerZoneThePowerZoneisonepowermanagementdomain;theserversinapowerzonesharethesamePowerSupplyUnits(PSUs),includingapowershelfandanumberoftrayspoweredbythatpowershelf.
ThermalZoneTheThermalZoneisonethermalmanagementdomain;theserversinathermalzonesharethesamecoolingdevices(Fans).
Thedevicesinthezonecoolmultipletrays.
Tray/DrawerIncludesoneormultipleservermodules.
RMMRackManagementModule(RMM)istherackcontrollerexposing,managingpower,andthermalresources.
Figure1showsthelogicalconceptoftheRMM.
TherackinFigure1containsoneRMM.
CMorMBPControllerModule(CM)orManagementBackplane(MBP).
TheRMMcontains0tonCM/MBP.
RMMRESTAPIErrorCodeIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201912DocumentNumber:608494-0013.
0RMMRESTAPIErrorCodeThischaptercontainsdescriptionsofallerrorcodesthatmaybereturnedbytheRESTcallsimplementedintheRMMRESTAPIoftheIntelRSDv2.
4release.
3.
1APIErrorResponseIncaseofanerror,thePooledSystemManagementEngine(PSME)RESTAPIrespondswithanHypertextTransferProtocol(HTTP)statuscode,asdefinedbytheHypertextTransferProtocol(HTTP/1.
1):MessageSyntaxandRouting,RFC7230,(refertoTable2)andconstrainedbyadditionalrequirementsdefinedinthisspecification.
HTTPresponsestatuscodesaloneoftendonotprovideenoughinformationtoenabledeterministicerrorsemantics.
ThePSMERESTAPIreturnsextendederrorinformationasaJSONobjectwithasinglepropertynamederror.
ThevalueoftheattributeshallbeaJSONobjectwiththeattributesshowninTable5.
Table5.
APIErrorResponseAttributesAttributeDescriptioncodeAstringindicatingaspecificMessageIdfromthemessageregistry.
"Base.
1.
0.
GeneralError"shouldbeusedonlywhennoothermessageisbetter.
messageAhuman-readableerrormessageiscorrespondingtothemessageinthemessageregistry.
@Message.
ExtendedInfoAnarrayofmessageobjectsdescribingoneormoreerrormessage(s).
3.
1.
1MessageObjectMessageObjectsprovideadditionalinformationaboutanobject,property,orerrorresponse.
MessagesarerepresentedasaJSONobjectwiththeattributesshowninTable6.
Table6.
APIErrorResponseAttributesAttributeDescriptionMessageIdAstringindicatingaspecificerrorormessage(nottobeconfusedwiththeHTTPstatuscode).
Thiscodecanbeusedtoaccessadetailedmessagefromamessageregistry.
MessageAhuman-readableerrormessageindicatingthesemanticsassociatedwiththeerror.
Thisisthecompletemessage,anditdoesnotrelyonsubstitutionvariables.
MessageArgsAnoptionalarrayofstringsrepresentingthesubstitutionparametervaluesforthemessage.
ThisisincludedintheresponseifaMessageIdisspecifiedforaparameterizedmessage.
SeverityAnoptionalstringrepresentingtheseverityoftheerror.
ResolutionAnoptionalstringdescribingrecommendedaction(s)totaketoresolvetheerror.
RelatedPropertiesAnoptionalarrayofJSONPointersdefiningthespecificpropertiesinaJSONpayloaddescribedbythemessage.
3.
1.
2ErrorMessageDefinitionsThemessagesreturnedbyaRedfishservicearedefinedinMessageRegistries.
InthecurrentimplementationtheStorageServicesRESTAPIrespondswithmessagesfromtworegistries:TheRedfishBaseRegistryv1.
0.
0,refertoTable2.
TheIntelRackScaleRegistry,presentedinthenextsection.
TheURIsoftheregistriesmayalsobeobtainedfromtheservicebyqueryingtheMessageRegistryFileAPIat/redfish/v1/Registries.
RMMRESTAPIErrorCodeIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-001133.
1.
3IntelRackScaleMessageRegistryTheregistrycontainstwoRSD-specificerrormessages.
Request:GET/registries/Intel_RackScaleContent-Type:application/jsonResponse:{"@odata.
type":"#MessageRegistry.
v1_0_0.
MessageRegistry","Id":"Intel_RackScale.
1.
0.
0","Name":"IntelRackScaleMessageRegistry","Language":"en","Description":"ThisregistrydefinesmessagesspecifictoIntelRackScale","RegistryPrefix":"Intel_RackScale","RegistryVersion":"1.
0.
0","OwningEntity":"IntelCorporation","Messages":{"PropertyNotModifiable":{"Description":"Indicatesthatapropertycannotbemodifiedeventhoughthemetadataspecifiesitaswritable","Message":"Theserviceisunabletomodifytheproperty%1eventhoughmetadataspecifiesitaswriteable.
","Severity":"Warning","NumberOfArgs":1,"ParamTypes":["string"],"Resolution":"Removetheunmodifiablepropertyfromtherequestbodyandresubmittherequest.
"},"PropertyValueRestricted":{"Description":"IndicatesthatthevaluegivenforapropertyisnotwithinrestrictionsimposedbytheService(eventhoughitmaybecorrectaccordingtometadata)","Message":"Thevalue%1forproperty%2isnotwithinrestrictionsimposedbytheService.
","Severity":"Warning","NumberOfArgs":1,"ParamTypes":["string","string"],"Resolution":"Correctthevalueforthepropertyintherequestbodyandresubmittherequest.
"}}}3.
1.
4ExampleErrorJSONObject{"error":{"code":"Base.
1.
0.
GeneralError","message":"Ageneralerrorhasoccurred.
SeeExtendedInfoformoreinformation.
","@Message.
ExtendedInfo":[{RMMRESTAPIErrorCodeIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201914DocumentNumber:608494-001"@odata.
type":"/redfish/v1/$metadata#Message.
v1_0_0.
Message","MessageId":"Base.
1.
0.
MalformedJSON","Message":"TherequestbodysubmittedwasmalformedJSONandcouldnotbeparsedbythereceivingservice","Severity":"Error"}{"@odata.
type":"/redfish/v1/$metadata#Message.
v1_0_0.
Message","MessageId":"Base.
1.
0.
PropertyNotWriteable","RelatedProperties":["#/Name"],"Message":"ThepropertyNameisareadpropertyandcannotbeassignedavalue","MessageArgs":["Name"],"Severity":"Warning","Resolution":"Removethepropertyfromtherequestbodyandresubmittherequestiftheoperationfailed"}]}}3.
2APIErrorCodesIngeneral,ifanerrorisnotdescribedinanyofthefollowingtables,itismappedtoanHTTP500InternalErrorCode.
3.
2.
1GeneralErrorCodesForadetailedlistofErrorCodes,refertoRedfish*ScalablePlatformsManagementAPISpecification,Section6.
5.
2(refertoTable2).
TheclientshouldbepreparedtohandletheerrorcodesshowninTable7.
Table7.
HTTPErrorStatusCodesHTTPStatusCodeDescription400BadRequestTherequestcouldnotbeprocessedbecauseitcontainsmissingorinvalidinformation(suchasvalidationerroronaninputfield,amissingrequiredvalue,andsoon).
Anextendederrorshallbereturnedintheresponsebody.
404NotFoundTherequestspecifiedaURIofaresourcethatdoesnotexist.
405MethodNotAllowedTheHTTPverbspecifiedintherequest(forexample,DELETE,GET,HEAD,POST,PUT,PATCH)isnotsupportedfortherequestURI.
TheresponseshallincludeanAllowheaderthatprovidesalistofmethodssupportedbytheresourceidentifiedbyrequestURI.
409ConflictAcreationorupdaterequestcouldnotbecompleted,becauseitwouldcauseaconflictinthecurrentstateoftheresourcessupportedbytheplatform(forexample,anattempttosetmultipleattributesthatworkinalinkedmannerusingincompatiblevalues).
500InternalServerErrorTheserverencounteredanunexpectedconditionthatpreventeditfromfulfillingtherequest.
Anextendederrorshallbereturnedintheresponsebody.
501NotImplementedTheserverdoesnot(currently)supportthefunctionalityrequiredtofulfilltherequest.
Thisistheappropriateresponsewhentheserverdoesnotrecognizetherequestmethodandisnotcapableofsupportingitforanyresource.
503ServiceUnavailableTheserveriscurrentlyunabletohandletherequestduetotemporaryoverloadingormaintenanceoftheserver.
RMMRESTAPIErrorCodeIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-001153.
2.
2PATCHMethodErrorCodesForthePATCHmethoderrorcodes,theIntelRSDserviceconformstotheIETFPATCHMethodforHTTP,RFC5789standard(refertoTable2).
Theservicerespondswiththefollowingerrorcodesinthecaseslisted:400BadRequest–malformedJSONintherequest(valuesnotinrange,unknownproperty,andsoon).
Thecode,messageandextendedinformationwithintheerrorresponseexplainwhyarequestwasrejected.
OfspecialconcernaretheRSD-specificmessagesfromtheIntel_RackScaleregistry.
PropertyNotModifiableisreturnedwhenaPATCHrequestwassentforapropertywhich,whilewritableaccordingtometadata,isread-onlyontheRMMRESTAPI.
PropertyValueRestrictedisreturnedwhenaPATCHrequestcontainsavalueforapropertythatiscompliantwithmetadata,buttheservicehasadditionalrestrictionsontheacceptablevaluesforthatpropertywhichwerenotmetbyrequest.
405MethodNotAllowed–theresourcedoesnotsupportthePATCHmethod.
409Conflict–Updatecannotbeexecutedatthismoment.
Theusermightbeabletoresolvetheconflictandresubmittherequest.
501NotImplemented-ResourcesupportsPATCHmethod,butcurrentimplementationdoesnot.
500InternalServerError-Allothersituationsinwhichthepreviouscodesdonotfit.
Specifically,thisresponseisreturnediftheResourcesupportsthePATCHrequest,butoneofthePATCH-edpropertiescannotbeupdated,forinstance,ifunderlyinglayersdonotallowtheexecutionofaparticularrequest.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201916DocumentNumber:608494-0014.
0RackManagementModuleAPIDefinitionTheJSONexamplesinthisdocumentareinformative,notnormative.
Metadatafilesthatarereferencedbythisspecificationarenormative.
4.
1Odata*SupportIntelRSDsupportstheOdata*v4.
0asdefinedintheRedfish*ScalablePlatformsManagementAPISpecification(refertoTable2).
AllresourceswithinthisIntelRSDRMMRESTAPISpecificationareidentifiedbyauniqueidentifierpropertynamed"@odata.
id.
"ResourceIdentifiersarerepresentedinJSONpayloadsasUniformResourceLocator(URL)pathsrelativetotheRedfishSchemaportionoftheURI.
Forexample,theresourceidentifiersalwaysstartwith"/redfish/.
"TheresourceidentifieristhecanonicalURLfortheresourceandcanbeusedtoretrieveoredittheresource,asappropriate.
4.
2AsynchronousOperationsWhilethemajorityofoperationsinthisarchitecturearesynchronousinnature,someoperationstakealongtimetoexecute,moretimethanaclienttypicallywantstowait.
Forthisreason,someoperationscanbeasynchronousatthediscretionoftheservice.
Therequestportionofanasynchronousoperationisnodifferentfromtherequestportionoftheasynchronousoperation.
TheuseofHTTPResponsecodesenablesaclienttodetermineiftheoperationwascompletedsynchronouslyorasynchronously.
UseoftheHTTPResponsecodespreparesclientstohandlebothsynchronousandasynchronousresponsesforrequestsusingHTTPDELETE,POST,PATCHandPUTmethods.
Fordetails,refertoRedfish*ScalablePlatformsManagementAPISpecification,Section8.
2,AsynchronousOperations(refertoTable2).
4.
3ProtocolVersionTheprotocolversionisseparatefromtheversionoftheresources,ortheversionoftheRedfish*Schemav2018.
1,DSP8010,listedinTable2,supportedbythem.
EachversionoftheRedfishprotocolisstronglytyped.
ThisisaccomplishedusingtheURIoftheRedfishserviceincombinationwiththeresourceobtainedatthatURI,calledtheServiceRoot.
TherootURIforthisversionoftheRedfishprotocolis"/redfish/v1/".
WhiletheprimaryversionoftheprotocolisrepresentedintheURI,themajorversion,minorversion,anderrataversionoftheprotocolarerepresentedintheversionpropertyoftheServiceRootresource,asdefinedintheRedfishSchemaforthatresource.
Theprotocolversionisastringoftheform:MajorVersion.
MinorVersion.
ErrataWhere:MajorVersion=integer:somethingintheclasschangedinabackwardincompatibleway.
MinorVersion=integer:aminorupdate.
Newfunctionalitymayhavebeenaddedbutnothingremoved.
Compatibilityispreservedwithpreviousminorversions.
Errata=integer:somethinginthepriorversionwasbrokenandneededtobefixed.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-00117Anyresourcediscoveredthroughlinksfoundbyaccessingtherootservice,oranyserviceorresourcereferencedusingreferencesfromtherootservice,willconformtothesameversionoftheprotocolsupportedbytherootservice.
4.
3.
1Operations4.
3.
1.
1GETRequest:GET/redfishContent-Type:application/jsonResponse:{"v1":"/redfish/v1/"}4.
4OdataServiceDocumentThisOdataServiceDocumentprovidesastandardformatforenumeratingtheresourcesexposedbytheservice,enablinggenerichypermedia-drivenODataclientstonavigatetotheresourcesoftheservice.
4.
4.
1Operations4.
4.
1.
1GETRequest:GET/redfish/v1/odataContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata","value":[{"name":"Service","kind":"Singleton","url":"/redfish/v1/"},{"name":"Systems","kind":"Singleton","url":"/redfish/v1/Systems"},{"name":"Chassis","kind":"Singleton","url":"/redfish/v1/Chassis"},{"name":"Managers","kind":"Singleton","url":"/redfish/v1/Managers"},RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201918DocumentNumber:608494-001{"name":"Services","kind":"Singleton","url":"/redfish/v1/Services"},{"name":"EthernetSwitches","kind":"Singleton","url":"/redfish/v1/EthernetSwitches"},{"name":"EventService","kind":"Singleton","url":"/redfish/v1/EventService"},{"name":"Tasks","kind":"Singleton","url":"/redfish/v1/TaskService"},{"name":"Registries","kind":"Singleton","url":"/redfish/v1/Registries"},{"name":"Fabrics","kind":"Singleton","url":"/redfish/v1/Fabrics"},{"name":"UpdateService","kind":"Singleton","url":"/redfish/v1/UpdateService"},{"name":"AccountService","kind":"Singleton","url":"/redfish/v1/AccountService"},{"name":"SessionService","kind":"Singleton","url":"/redfish/v1/SessionService"},{"name":"TelemetryService","kind":"Singleton","url":"/redfish/v1/Oem/Intel_RackScale/TelemetryService"}]}4.
5IntelRSDOEMExtensionsAllIntelRSDOEMExtensionstoallresourcesdefinedinthisdocumentaresupported.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-001194.
6ServiceRootServiceRootresource–entrypoint.
Properties'detailsareavailableintheServiceRoot_v1.
xmlmetadatafile.
4.
6.
1Operations4.
6.
1.
1GETRequest:GET/redfish/v1Content-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#ServiceRoot.
ServiceRoot","@odata.
id":"/redfish/v1/","@odata.
type":"#ServiceRoot.
v1_3_1.
ServiceRoot","Id":"RootService","Name":"RootService","Description":"description-as-string","RedfishVersion":"1.
5.
0","UUID":"92384634-2938-2342-8820-489239905423","Systems":{"@odata.
id":"/redfish/v1/Systems"},"Chassis":{"@odata.
id":"/redfish/v1/Chassis"},"Managers":{"@odata.
id":"/redfish/v1/Managers"},"StorageServices":{"@odata.
id":"/redfish/v1/StorageServices"},"EventService":{"@odata.
id":"/redfish/v1/EventService"},"Fabrics":{"@odata.
id":"/redfish/v1/Fabrics"},"Tasks":{"@odata.
id":"/redfish/v1/TaskService"},"Registries":{"@odata.
id":"/redfish/v1/Registries"},"UpdateService":{"@odata.
id":"/redfish/v1/UpdateService"},"AccountService":{"@odata.
id":"/redfish/v1/AccountService"},"SessionService":{"@odata.
id":"/redfish/v1/SessionService"},"Oem":{RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201920DocumentNumber:608494-001"Intel_RackScale":{"@odata.
type":"#Intel.
Oem.
ServiceRoot","ApiVersion":"2.
4.
0","EthernetSwitches":{"@odata.
id":"/redfish/v1/EthernetSwitches"},"TelemetryService":{"@odata.
id":"/redfish/v1/Oem/Intel_RackScale/TelemetryService"}}}"Links":{}}4.
6.
1.
2PUTThePUToperationisnotallowedontheservicerootresource.
4.
6.
1.
3PATCHServiceRootoperationisnotallowedonthisresource.
4.
6.
1.
4POSTServiceRootoperationisnotallowedonthisresource.
4.
6.
1.
5DELETEServiceRootoperationisnotallowedonthisresource.
4.
7ManagerCollectionTheManagerCollectionresourceprovidesacollectionofallmanagersavailableinarack,manageablethroughtheRMM.
Metadatafile:ManagerCollection_v1.
xml4.
7.
1Operations4.
7.
1.
1GETRequest:GET/redfish/v1/ManagersContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#ManagerCollection.
ManagerCollection","@odata.
id":"/redfish/v1/Managers","@odata.
type":"#ManagerCollection.
ManagerCollection","Name":"ManagerCollection","Description":"description-as-string","Members@odata.
count":2,"Members":[{RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-00121"@odata.
id":"/redfish/v1/Managers/RackManager"},{"@odata.
id":"/redfish/v1/Managers/ZoneManager"}]}4.
7.
1.
2PUTManagerCollectionoperationisnotallowedonthisresource.
4.
7.
1.
3PATCHManagerCollectionoperationisnotallowedonthisresource.
4.
7.
1.
4POSTManagerCollectionoperationisnotallowedonthisresource.
4.
7.
1.
5DELETEManagerCollectionoperationisnotallowedonthisresource.
4.
8ManagerTheManagerisasystemsmanagemententity,whichmayimplementorprovideaccesstoaRedfishservice.
ExamplesofmanagersareBaseboardManagementControllers(BMCs),EnclosureManagers,ManagementControllers,andothersubsystemsthatassignmanageabilityfunctions.
TherecanbemultipleManagersinimplementation,andtheymayormaynotbedirectlyaccessiblethroughaRedfish-definedinterface.
Properties'detailsareavailableintheManager_v1.
xmlmetadatafile.
4.
8.
1Operations4.
8.
1.
1GETRequest:GET/redfish/v1/Managers/RackManagerContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Manager.
Manager","@odata.
id":"/redfish/v1/Managers/RMM","@odata.
type":"#Manager.
v1_2_0.
Manager","Id":"1","Name":"Manager","ManagerType":"RackManager","Description":"RackScaleRMC","ServiceEntryPointUUID":"11384622-2938-2342-8820-489239905423","UUID":"00000000-0000-0000-0000-000000000000","Model":"JooJanta200","DateTime":"2015-03-13T04:14:33+06:00","DateTimeLocalOffset":"+06:00",RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201922DocumentNumber:608494-001"Status":{"State":"Enabled","Health":"OK","HealthRollup":null},"GraphicalConsole":{"ServiceEnabled":true,"MaxConcurrentSessions":2,"ConnectTypesSupported":["KVMIP"]},"SerialConsole":{"ServiceEnabled":true,"MaxConcurrentSessions":1,"ConnectTypesSupported":["Telnet","SSH","IPMI"]},"CommandShell":{"ServiceEnabled":true,"MaxConcurrentSessions":4,"ConnectTypesSupported":["Telnet","SSH"]},"FirmwareVersion":"1.
00","NetworkProtocol":{"@odata.
id":"/redfish/v1/Managers/RackManager1/NetworkProtocol"},"EthernetInterfaces":{"@odata.
id":"/redfish/v1/Managers/RackManager1/EthernetInterfaces"},"Links":{"ManagerForServers":[],"ManagerForChassis":[{"@odata.
id":"/redfish/v1/Chassis/Rack1"}],"ManagerInChassis":{"@odata.
id":"/redfish/v1/Chassis/Rack1"},"ManagerForSwitches":[],"Oem":{"Intel_RackScale":{"@odata.
type":"Intel.
Oem.
ManagerLinks","ManagerForServices":[],"ManagerForFabrics":[],"ManagerForEthernetSwitches":[]}}},"Oem":{},"PowerState":"On","Actions":{"#Manager.
Reset":{"target":"/redfish/v1/Managers/RackManager/Actions/Manager.
Reset","ResetType@Redfish.
AllowableValues":["GracefulRestart"]},RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-00123"Oem":{"#Intel_RackScale.
LoadFactoryDefaults":{"target":"/redfish/v1/Managers/RackManager/Actions/Oem/Intel_RackScale.
LoadFactoryDefaults"}}}}4.
8.
1.
2PUTThemanageroperationisnotallowedonthisresource.
4.
8.
1.
3PATCHThemanageroperationisnotallowedonthisresource.
4.
8.
1.
4POSTThemanageroperationisnotallowedonthisresource.
4.
8.
1.
4.
1ManagerResetManagerResetcanbeinitiatedusingtheactionbelow.
Request:POST/redfish/v1/Managers/RackManager/Actions/Manager.
ResetContent-Type:application/json{"ResetType":"GracefulRestart"}Response:HTTP/1.
1204NoContentOr(whentaskiscreated)HTTP/1.
1202AcceptedLocation:http://:/redfish/v1/TaskService/Tasks/1/TaskMonitor{"@odata.
context":"/redfish/v1/$metadata#Task.
Task","@odata.
id":"/redfish/v1/TaskService/Tasks/1","@odata.
type":"#Task.
v1_0_0.
Task","Id":"1","Name":"Task1","TaskState":"New","StartTime":"2016-09-01T04:45+01:00","TaskStatus":"OK","Messages":[]}4.
8.
1.
4.
2ResettoFactoryDefaultsTheRackmanagermaysupportaResettoFactoryDefaults.
Thefollowingrequestactionperformssuchareset.
Request:RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201924DocumentNumber:608494-001POST/redfish/v1/Managers/RackManager/Actions/Oem/Intel_RackScale.
LoadFactoryDefaultContent-Type:application/json{}Response:HTTP/1.
1204NoContentOr(whentaskiscreated)HTTP/1.
1202AcceptedLocation:http://:/redfish/v1/TaskService/Tasks/1/TaskMonitor{"@odata.
context":"/redfish/v1/$metadata#Task.
Task","@odata.
id":"/redfish/v1/TaskService/Tasks/1","@odata.
type":"#Task.
v1_0_0.
Task","Id":"1","Name":"Task1","TaskState":"New","StartTime":"2016-09-01T04:45+01:00","TaskStatus":"OK","Messages":[]}4.
8.
1.
5DELETEResettofactorydefaultsoperationisnotallowedonthisresource.
4.
9MetricDefinitionCollectionPropertydetailsareavailableinIntel_RackScaleMetricDefinitionCollection_v1.
xmlmetadatafile.
4.
9.
1Operations4.
9.
1.
1GETRequest:GET/redfish/v1/Oem/Intel_RackScale/TelemetryService/MetricDefinitionsContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Intel_RackScale.
MetricDefinitionCollection.
MetricDefinitionCollection","@odata.
id":"/redfish/v1/Oem/Intel_RackScale/TelemetryService/MetricDefinitions","@odata.
type":"#Intel_RackScale.
MetricDefinitionCollection.
MetricDefinitionCollection","Name":"MetricDefinitionsCollection","Description":"description-as-string","Members@odata.
count":2,"Members":[{"@odata.
id":"/redfish/v1/Oem/Intel_RackScale/TelemetryService/MetricDefinitions/FanSpeedRPM"},RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-00125{"@odata.
id":"/redfish/v1/Oem/Intel_RackScale/TelemetryService/MetricDefinitions/RackTemperature"}]}4.
9.
1.
2PUTMetricdefinitioncollectionoperationisnotallowedonthisresource.
4.
9.
1.
3PATCHMetricdefinitioncollectionoperationisnotallowedonthisresource.
4.
9.
1.
4POSTMetricdefinitioncollectionoperationisnotallowedonthisresource.
4.
9.
1.
5DELETEMetricdefinitioncollectionoperationisnotallowedonthisresource.
4.
10MetricDefinitionPropertydetailsareavailableintheIntel_RackScaleMetricDefinition_v1.
xmlmetadatafile.
MetricDefinitiondescribeseithermetricassociatedwithaphysicalsensor(e.
g.
,exposedbyBMC)ormetricassociatedwiththespecificresource(e.
g.
,statisticsofRackPowerModule).
Thisresourceisoptionalformetricsandrequiredforsensors.
4.
10.
1Operations4.
10.
1.
1GETRequest:GET/redfish/v1/Oem/Intel_RackScale/TelemetryService/MetricDefinitions/RackTemperatureContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Intel_RackScale.
MetricDefinition.
MetricDefinition","@odata.
id":"/redfish/v1/Oem/Intel_RackScale/TelemetryService/MetricDefinitions/SLEDTemperatures","@odata.
type":"#Intel_RackScale.
MetricDefinition.
v1_0_0.
MetricDefinition","Description":"PSUTemperatureMetricDefinition","Name":"PowerSupplyUnitTemperaturedefinition","Id":"SLEDTemp1","SensorType":"Temperature","Implementation":"Physical","SensingInterval":"PT1S","MetricType":"Numeric","PhysicalContext":"Backplane","Units":"Cel","MinReadingRange":0,RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201926DocumentNumber:608494-001"MaxReadingRange":110,"Precision":1,"MetricProperties":["/redfish/v1/Chassis/Zone1/Thermal#/Temperatures/0/ReadingCelsius"]}4.
10.
1.
2PUTMetricdefinitionoperationisnotallowedonthisresource.
4.
10.
1.
3PATCHMetricdefinitionoperationisnotallowedonthisresource.
4.
10.
1.
4POSTMetricdefinitionoperationisnotallowedonthisresource.
4.
10.
1.
5DELETEMetricdefinitionoperationisnotallowedonthisresource.
4.
11TelemetryServicePropertydetailsareavailableintheIntel_RackScaleTelemetryService_v1.
xmlmetadatafile.
4.
11.
1Operations4.
11.
1.
1GETRequest:GET/redfish/v1/Oem/Intel_RackScale/TelemetryServiceContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Intel_RackScale.
TelemetryService.
TelemetryService","@odata.
type":"#Intel_RackScale.
TelemetryService.
v1_0_0.
TelemetryService","@odata.
id":"/redfish/v1/Oem/Intel_RackScale/TelemetryService","Id":"TelemetryService","Name":"TelemetryService","Status":{"State":"Enabled","Health":"OK"},"MetricDefinitions":{"@odata.
id":"/redfish/v1/Oem/Intel_RackScale/TelemetryService/MetricDefinitions"}}RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-001274.
11.
1.
2PUTTheTelemetryServiceoperationisnotallowedonthisresource.
4.
11.
1.
3PATCHTheTelemetryServiceoperationisnotallowedonthisresource.
4.
11.
1.
4POSTTheTelemetryServiceoperationisnotallowedonthisresource.
4.
11.
1.
5DELETETheTelemetryServiceoperationisnotallowedonthisresource.
4.
12ChassisCollectionTheChassisCollectionresourceshowninFigure2illustratestherelationshipbetweenvariouschassiscomponentsintheIntelRSDRack.
PropertydetailsareavailableintheChassisCollection_v1.
xmlmetadatafile.
Figure2.
ChassisCollectionRelationshipbetweenComponentsInFigure2,thenumbersrepresentaone-to-oneorto-manyrelationshipbetweencomponents,"*"denoteszeroormore.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201928DocumentNumber:608494-0014.
12.
1Operations4.
12.
1.
1GETRequest:GET/redfish/v1/ChassisContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Chassis","@odata.
id":"/redfish/v1/Chassis","@odata.
type":"#ChassisCollection.
ChassisCollection","Name":"ChassisCollection","Description":"description-as-string","Members@odata.
count":3,"Members":[{"@odata.
id":"/redfish/v1/Chassis/Rack1"},{"@odata.
id":"/redfish/v1/Chassis/Zone1"},{"@odata.
id":"/redfish/v1/Chassis/Drawer1"}]}4.
12.
1.
2PUTTheChassisCollectionoperationisnotallowedonthisresource.
4.
12.
1.
3PATCHTheChassisCollectionoperationisnotallowedonthisresource.
4.
12.
1.
4POSTTheChassisCollectionoperationisnotallowedonthisresource.
4.
12.
1.
5DELETETheChassisCollectionoperationisnotallowedonthisresource.
4.
13ChassisThisistheschemadefinitionfortheChassisresource,whichrepresentsthepropertiesofthephysicalcomponentsforanysystem.
Thisoneresourceisintendedtorepresentracks,rackmountservers,blades,modularsystems,enclosures,andallothercontainers.
Thenon-CPU/devicecentricpartsoftheschemaareallaccessedeitherdirectlyorindirectlythroughthisresource.
Detailsofthisresourcearedescribedinthemetadatafile:Chassis_v1.
xml.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-001294.
13.
1Operations4.
13.
1.
1GETRequest:GET/redfish/v1/Chassis/Rack1Content-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Chassis/Members/$entity","@odata.
id":"/redfish/v1/Chassis/R1","@odata.
type":"#Chassis.
v1_7_0.
Chassis","Id":"1","ChassisType":"Rack","Name":"name-as-string","Description":"description-as-string","Manufacturer":"IntelCorporation","Model":"RackScale_Rack","SKU":"sku-as-string","SerialNumber":"serial-number-as-string","PartNumber":"part-number-as-string","AssetTag":null,"IndicatorLED":null,"Status":{"State":"Enabled","Health":"OK","HealthRollup":null},"Oem":{"Intel_RackScale":{"@odata.
type":"Intel.
Oem.
RackChassis","Location":{"Id":"Rack1","ParentId":null},"RackSupportsDisaggregatedPowerCooling":false,"GeoTag":"1.
234234,54.
234234"}},"Links":{"@odata.
type":"#Chassis.
v1_7_0.
Links","Contains":[{"@odata.
id":"/redfish/v1/Chassis/Drawer1"},{"@odata.
id":"/redfish/v1/Chassis/Zone1"}],"ContainedBy":[],"ComputerSystems":[],"ManagedBy":[{"@odata.
id":"/redfish/v1/Managers/RackManager1"}],"ManagersInChassis":[{"@odata.
id":"/redfish/v1/Managers/RackManager1"}],"PoweredBy":[],"CooledBy":[],"Storage":[],RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201930DocumentNumber:608494-001"Drives":[],"Switches":[],"Oem":{"Intel_RackScale":{"@odata.
type":"#Intel.
Oem.
ChassisLinks","EthernetSwitches":[]}}},"PowerState":"On","Thermal":{"@odata.
id":"/redfish/v1/Chassis/Rack1/Thermal"},"Power":{"@odata.
id":"/redfish/v1/Chassis/Rack1/Power"},"UUID":"123-124-134-234-13423534","Actions":{"#Chassis.
Reset":{"target":"/redfish/v1/Chassis/Rack1/Actions/Chassis.
Reset","ResetType@Redfish.
AllowableValues":[]}}}4.
13.
1.
2PUTChassisoperationisnotallowedonthisresource.
4.
13.
1.
3PATCHThePATCHoperationcanupdatethepropertieslistedinTable8.
Table8.
ChassisPropertiesAttributeTypeRequiredDescriptionAssetTagStringNoTheuserassignedassettagforthischassis.
Oem->Intel_RackScale->LocationObjectNoTheobjectisrepresentingthephysicallocationofthechassis.
Validonlyforresourcetype"Rack.
"Followingpropertiescanbepatched:"Id"-StringcontainingphysicallocationIDofthischassis.
Oem->Intel_RackScale->GeoTagStringNoGeoTag–onlyforRackchassis.
Request:PATCH/redfish/v1/Chassis/1Content-Type:application/json{"AssetTag":"Myrack""Oem":{"Intel_RackScale":{"Location":{"Id":"Rack_1"}}}}RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-00131Response:HTTP/1.
1204NoContentOr:HTTP/1.
1200OK{(updatedresourcebody)}4.
13.
1.
4POSTChassis.
resetcanbeinitiatedusingtheactionbelow:Request:POST/redfish/v1/Chassis/Drawer1/Actions/Chassis.
ResetContent-Type:application/json{"ResetType":"ForceRestart"}Response:HTTP/1.
1204NoContentOr(whentaskiscreated)HTTP/1.
1202AcceptedLocation:http://:/redfish/v1/TaskService/Tasks/1/TaskMonitor{"@odata.
context":"/redfish/v1/$metadata#Task.
Task","@odata.
id":"/redfish/v1/TaskService/Tasks/1","@odata.
type":"#Task.
v1_0_0.
Task","Id":"1","Name":"Task1","TaskState":"New","StartTime":"2016-09-01T04:45+01:00","TaskStatus":"OK","Messages":[]}4.
13.
1.
5DELETEThechassisoperationisnotallowedonthisresource.
4.
14PowerPowermetricsresourcerepresentsthepropertiesofPowerConsumptionandPowerLimiting.
Detailedinformationaboutthispropertycanbeobtainedfromthemetadatafile:Power_v1.
xml4.
14.
1Operations4.
14.
1.
1GETRequest:GET/redfish/v1/Chassis/Zone1/PowerContent-Type:application/jsonRackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201932DocumentNumber:608494-001Response:{"@odata.
context":"/redfish/v1/$metadata#Power.
Power","@odata.
id":"/redfish/v1/Chassis/Zone1/Power","@odata.
type":"#Power.
v1_5_0.
Power","Id":"Power","Name":"Power","Description":"Power","PowerControl":[{"@odata.
id":"/redfish/v1/Chassis/Zone1/Power#/PowerControl/0","MemberId":"0","Name":"SystemPowerControl","PowerConsumedWatts":8000,"PowerRequestedWatts":8500,"PowerAvailableWatts":8500,"PowerCapacityWatts":10000,"PowerAllocatedWatts":8500,"PowerMetrics":{"IntervalInMin":null,"MinConsumedWatts":null,"MaxConsumedWatts":null,"AverageConsumedWatts":null},"PowerLimit":{"LimitInWatts":null,"LimitException":null,"CorrectionInMs":null},"RelatedItem":[{"@odata.
id":"/redfish/v1/Chassis/Drawer1"}],"Status":{"State":"Enabled","Health":"OK","HealthRollup":"OK"},"Oem":{}}],"Voltages":[{"@odata.
id":"/redfish/v1/Chassis/Zone1/Power#/Voltages/0","MemberId":"0","Name":"VRM1Voltage","SensorNumber":11,"Status":{"State":"Enabled","Health":"OK"},"ReadingVolts":12,"UpperThresholdNonCritical":null,"UpperThresholdCritical":null,"UpperThresholdFatal":null,"LowerThresholdNonCritical":null,"LowerThresholdCritical":null,"LowerThresholdFatal":null,"MinReadingRange":null,"MaxReadingRange":null,"PhysicalContext":"VoltageRegulator","RelatedItem":[{"@odata.
id":"/redfish/v1/Chassis/Drawer1"RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-00133}]}],"PowerSupplies":[{"@odata.
id":"/redfish/v1/Chassis/Zone1/Power#/PowerSupplies/0","MemberId":"0","Name":"PowerSupplyBay1","Status":{"State":"Enabled","Health":"Warning"},"Oem":{},"PowerSupplyType":"DC","LineInputVoltageType":"DCNeg48V","LineInputVoltage":-48,"PowerCapacityWatts":400,"LastPowerOutputWatts":192,"Model":"499253-B21","Manufacturer":"ManufacturerName","FirmwareVersion":"1.
00","SerialNumber":"1z0000001","PartNumber":"1z0000001A3a","SparePartNumber":"0000001A3a","InputRanges":[{"InputType":"DC","MinimumVoltage":-47,"MaximumVoltage":-49,"OutputWattage":400,"MinimumFrequencyHz":50,"MaximumFrequencyHz":60,"Oem":{}}],"IndicatorLED":"Off","RelatedItem":[{"@odata.
id":"/redfish/v1/Chassis/Drawer1"}]}],"Oem":{"Intel_RackScale":{"@odata.
type":"#Intel.
Oem.
Power","Actions":{"#Intel.
Oem.
RequestPowerSupplyStateChange":{"target":"/redfish/v1/Chassis/Zone1/Power/Oem/Intel_RackScale/Actions/Intel.
Oem.
RequestPowerSupplyStateChange","State@AllowableValues":["Enabled","Disabled"],"MemberId@AllowableValues":["0"]}}}}}4.
14.
1.
2PUTThepoweroperationisnotallowedonthisresource.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201934DocumentNumber:608494-0014.
14.
1.
3PATCHThepoweroperationisnotallowedonthisresource.
4.
14.
1.
4POSTPowersuppliescanbeenabled/disabledusingthefollowingaction.
Request:POST/redfish/v1/Chassis/Zone1/Power/Oem/Intel_RackScale/Actions/Intel.
Oem.
RequestPowerSupplyStateChangeContent-Type:application/json{"State":"Disabled","MemberId":"0"}Response:HTTP/1.
1204NoContentOr(whentaskiscreated)HTTP/1.
1202AcceptedLocation:http://:/redfish/v1/TaskService/Tasks/1/TaskMonitor{"@odata.
context":"/redfish/v1/$metadata#Task.
Task","@odata.
id":"/redfish/v1/TaskService/Tasks/1","@odata.
type":"#Task.
v1_0_0.
Task","Id":"1","Name":"Task1","TaskState":"New","StartTime":"2016-09-01T04:45+01:00","TaskStatus":"OK","Messages":[]}4.
14.
1.
5DELETEThepoweroperationisnotallowedonthisresource.
4.
15ThermalThermalmetricsresourcerepresentsthepropertiesofTemperatureandCooling.
Detailedinformationabouttheresource'spropertiescanbeobtainedfromthemetadatafile:Thermal_v1.
xml4.
15.
1Operations4.
15.
1.
1GETRequest:GET/redfish/v1/Chassis/Zone1/ThermalContent-Type:application/jsonRackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-00135Response:{"@odata.
context":"/redfish/v1/$metadata#Thermal.
Thermal","@odata.
id":"/redfish/v1/Chassis/Zone1/Thermal","@odata.
type":"#Thermal.
v1_4_0.
Thermal","Id":"Thermal","Name":"Thermal","Description":"Thermal","Temperatures":[{"@odata.
id":"/redfish/v1/Chassis/Zone1/Thermal#/Temperatures/0","MemberId":"0","Name":"DrawerinletTemp","SensorNumber":42,"Status":{"State":"Enabled","Health":"OK"},"ReadingCelsius":21,"UpperThresholdNonCritical":null,"UpperThresholdCritical":null,"UpperThresholdFatal":null,"LowerThresholdNonCritical":null,"LowerThresholdCritical":null,"LowerThresholdFatal":null,"MinReadingRangeTemp":null,"MaxReadingRangeTemp":null,"PhysicalContext":"Intake","RelatedItem":[{"@odata.
id":"/redfish/v1/Chassis/Drawer1"}]}],"Fans":[{"@odata.
id":"/redfish/v1/Chassis/Zone1/Thermal#/Fans/0","MemberId":"0","Name":"BaseBoardSystemFan","PhysicalContext":"Backplane","Status":{"State":"Enabled","Health":"OK"},"Reading":2100,"ReadingUnits":"RPM","UpperThresholdNonCritical":null,"UpperThresholdCritical":null,"UpperThresholdFatal":null,"LowerThresholdNonCritical":null,"LowerThresholdCritical":null,"LowerThresholdFatal":null,"MinReadingRange":null,"MaxReadingRange":null,"RelatedItem":[{"@odata.
id":"/redfish/v1/Chassis/Drawer1"}]}],RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201936DocumentNumber:608494-001"Oem":{"Intel_RackScale":{"@odata.
type":"#Intel.
Oem.
Thermal","VolumetricAirflowCfm":100,"DesiredSpeedPwm":50}}}4.
15.
1.
2PUTThermaloperationisnotallowedonthisresource.
4.
15.
1.
3PATCHThePATCHoperationcanupdatethefollowingproperties:Table9.
DesiredFanSpeedPropertiesAttributeTypeRequiredDescriptionOem->Intel_RackScale->DesiredSpeedPwmNumberNoThispropertyrepresentsthedesiredspeedofallFANsinthecurrentchassisasapercentageofmaximumfanspeed.
Allowedvaluesareintherangefrom0to100percent.
Request:PATCH/redfish/v1/Chassis/1Content-Type:application/json{"AssetTag":"Myrack""Oem":{"Intel_RackScale":{"DesiredSpeedPwm":90}}}Response:HTTP/1.
1204NoContentOr:HTTP/1.
1200OK{(updatedresourcebody)}4.
15.
1.
4POSTThePATCHoperationisnotallowedonthisresource.
4.
15.
1.
5DELETEThePATCHoperationisnotallowedonthisresource.
4.
16UpdateServiceUpdateServiceresourcerepresentsthepropertiesrequiredtoinvokethesoftware/firmwareupdate.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-00137Inthiscurrentrelease,onlytheManagerResourcescanbeupdated.
4.
16.
1Operations4.
16.
1.
1GETRequest:GET/redfish/v1/UpdateServiceContent-Type:application/jsonResponse:{"@odata.
type":"#UpdateService.
v1_0_2.
UpdateService","Id":"UpdateService","Name":"Updateservice","Status":{"State":"Enabled","Health":"OK","HealthRollup":"OK"},"ServiceEnabled":true,"Actions":{"#UpdateService.
SimpleUpdate":{"target":"/redfish/v1/UpdateService/Actions/SimpleUpdate","@Redfish.
ActionInfo":"/redfish/v1/UpdateService/SimpleUpdateActionInfo"},"Oem":{}},"Oem":{},"@odata.
context":"/redfish/v1/$metadata#UpdateService/$entity",}4.
16.
1.
2PUTTheUpdateServiceoperationisnotallowedonthisresource.
4.
16.
1.
3PATCHTheUpdateServiceoperationisnotallowedonthisresource.
4.
16.
1.
4POST4.
16.
1.
4.
1SimpleUpdateActionThesoftware/firmwareupdatecanbeinitiatedusingSimpleUpdateaction.
Figure3illustratestheinteractionbetweencomponents.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201938DocumentNumber:608494-001Figure3.
SimpleUpdateActionComponentInteractionsRequest:POST/redfish/v1/UpdateService/Actions/SimpleUpdateContent-Type:application/json{"ImageURI":"http://10.
0.
0.
1/images/rmm_image.
deb","Targets":["/redfish/v1/Managers/RackManager"],"TransferProtocol":"HTTP"}Response:HTTP/1.
1204NoContentOr(whentaskiscreated)HTTP/1.
1202AcceptedLocation:http://:/redfish/v1/TaskService/Tasks/1/TaskMonitor{"@odata.
context":"/redfish/v1/$metadata#Task.
Task","@odata.
id":"/redfish/v1/TaskService/Tasks/1","@odata.
type":"#Task.
v1_0_0.
Task","Id":"1","Name":"Task1","TaskState":"New","StartTime":"2016-09-01T04:45+01:00","TaskStatus":"OK","Messages":[]}4.
16.
1.
5DELETETheSimpleUpdateactionoperationisnotallowedonthisresource.
4.
17ActionInfoActionInfodescribestheparametersandotherinformationnecessarytoperformaRedfishActiontoaparticularactiontarget.
Asparametersupportmaydifferbetweenimplementationsandevenamonginstancesofaresource,thisdatacanbeusedtoensureactionrequestsfromapplicationscontainsupportedparameters.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTApril2019APISpecificationSoftwarev2.
4DocumentNumber:608494-001394.
17.
1Operations4.
17.
1.
1GET(UpdateService/SimpleUpdateActionInfo)Request:GET/redfish/v1/UpdateService/SimpleUpdateActionInfoContent-Type:application/jsonResponse:{"@odata.
type":"#ActionInfo.
v1_0_0.
ActionInfo","Parameters":[{"Name":"ImageURI","Required":true,"DataType":"String"},{"Name":"TransferProtocol","Required":false,"DataType":"String","AllowableValues":["HTTP","HTTPS","FTP"]},{"Name":"Targets","Required":false,"DataType":"StringArray","AllowableValues":["RackManager","ZoneManager"]}],"Oem":{},"@odata.
context":"/redfish/v1/$metadata#ActionInfo.
ActionInfo","@odata.
id":"/redfish/v1/UpdateService/SimpleUpdateActionInfo"}4.
17.
1.
2PUTTheUpdateService/SimpleUpdateActionInfooperationisnotallowedonthisresource.
4.
17.
1.
3PATCHThePATCHoperationisnotallowedonUpdateService/SimpleUpdateActionInforesource.
4.
17.
1.
4POSTTheUpdateService/SimpleUpdateActionInfooperationisnotallowedonthisresource.
4.
17.
1.
5DELETETheUpdateService/SimpleUpdateActionInfooperationisnotallowedonthisresource.
RackManagementModuleAPIDefinitionIntelRSDRMMRESTAPISpecificationSoftwarev2.
4April201940DocumentNumber:608494-0014.
18RMM–PSMECommonResourcesResourcesmentionedinTable10aresharedintheIntelRSDPSMERESTAPIandIntelRSDRMMRESTAPISpecificationsascommonresources.
RefertotheIntelRSDPSMERESTAPISpecificationforresourcedefinition,Table158,RequiredResourcesperServiceType(refertoTable2).
Table10.
RMM-PSMECommonResourcesResourceNameSupportedOperationsGETPATCHPOSTDELETEActionsEventServiceXEventDestinationCollectionXXEventDestinationXXMetricDefinitionXMetricDefinitionCollectionXMessageRegistryFileXEthernetInterfacesXNetworkProtocolXRegistriesXTaskXTaskCollectionXTaskServiceXTelemetryServiceXVLANXManagerAccountCollectionXManagerAccountXRoleCollectionXRoleXAccountServiceXSessionCollectionXXSessionXXSessionServiceXX