creatinghttp500

DocumentNumber:332869-005IntelRackScaleDesignPodManagerAPISpecificationSoftwareVersion1.
2September2016Revision005IntelConfidentialIntelRackScaleDesignPodManagerAPISpecificationSeptember20162IntelConfidentialDocumentNumber:332869-005Nolicense(expressorimplied,byestoppelorotherwise)toanyintellectualpropertyrightsisgrantedbythisdocument.
Inteldisclaimsallexpressandimpliedwarranties,includingwithoutlimitation,theimpliedwarrantiesofmerchantability,fitnessforaparticularpurpose,andnoninfringement,aswellasanywarrantyarisingfromcourseofperformance,courseofdealing,orusageintrade.
Thisdocumentcontainsinformationonproducts,services,and/orprocessesindevelopment.
Allinformationprovidedhereissubjecttochangewithoutnotice.
ContactyourIntelrepresentativetoobtainthelatestforecast,schedule,specifications,androadmaps.
Theproductsandservicesdescribedmaycontaindefectsorerrorsknownaserratawhichmaycausedeviationsfrompublishedspecifications.
Currentcharacterizederrataareavailableonrequest.
Copiesofdocumentsthathaveanordernumberandarereferencedinthisdocumentmaybeobtainedbycalling1-800-548-4725orbyvisitinghttp://www.
intel.
com/design/literature.
htm.
IntelandtheIntellogoaretrademarksofIntelCorporationintheUnitedStatesandothercountries.
*Othernamesandbrandsmaybeclaimedasthepropertyofothers.
Copyright2016IntelCorporation.
Allrightsreserved.
IntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential3Contents1Introduction.
7Scope.
7Intendedaudience.
7Terminology7References.
72PODMAPI9PODMAPIstructureandrelations.
9PODMAPIphysicalresourcehierarchy93PODMRESTAPIErrorCodes.
11APIerrorresponse.
11ExampleerrorJSONobject.
11APIerrorcodes.
12Generalerrorcodes12Requesterrorcodes12Nodeassemblyerrorcodes12Nodeactionerrorcodes.
124PODMRESTAPIDefinition14Odatasupport14Protocolversion14Operations14IntelRackScaleDesignPODmanagerserviceroot.
14Operations15Chassiscollection17Operations17Chassis18Operations20PowerZonecollection.
21Operations21PowerZone.
22Operations24ThermalZonecollection.
25Operations26ThermalZone.
26Operations28Storageservicecollection.
30Operations30Composednodecollection31Operation.
35Composednode37Operations40PSMEresources44StorageServicesresources44SimpleStoragecollection.
44Operations45Simplestorage45Operations46IntelRackScaleDesignPodManagerAPISpecificationSeptember20164IntelConfidentialDocumentNumber:332869-0055CommonPropertyDescription.
48Status.
48Status->State.
48Status->Health.
48ComputerSystem.
Reset.
48BootSourceOverrideTarget/Supported.
486Appendix50CreatingnewComposedNode-explanation.
50CreatingComposedNodeusingJSONtemplate.
50SpecifyingrequirementsforaComposedNode.
50Generalassumptionsforallocation50Specifyingprocessorrequirements50Specifyingmemoryrequirements.
51SpecifyingRemoteDriverequirements.
52SpecifyingLocalDriverequirements.
54SpecifyingEthernetinterfacerequirements55Allocationalgorithm.
56FiguresFigure1PODMRESTAPIhierarchy.
9Figure2ComposedNodeStatechangesduringassemblyprocess40TablesTable1Terminology7Table2Referencedocuments.
7Table3ResourcesandURI.
9Table4APIerrorresponseattributes.
11Table5Generalerrorcodes12Table6Requesterrorcodes.
12Table7Nodeassemblyerrorcodes12Table8Nodedisassemblyerrorcodes.
12Table9IntelRackScaleDesignPODmanagerserviceRootattributes15Table10Chassiscollectionattributes.
17Table11Chassisattributes.
18Table12PowerZonecollectionattributes21Table13PowerZoneattributes22Table14PowerSupplyattributes23Table15ThermalZonecollectionattributes.
25Table16ThermalZoneattributes.
26Table17Fanattributes.
27Table18Temperatureattributes.
28Table19Storageservicecollectionattributes30Table20Composednodecollectionattributes.
31Table21ComposednodeAllocationactionattributes.
32Table22Remotemastertargetproperties35Table23Composednodeattributes.
37Table24Simplestoragecollectionattributes.
44IntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential5Table25Simplestorageattributes.
45IntelRackScaleDesignPodManagerAPISpecificationSeptember20166IntelConfidentialDocumentNumber:332869-005RevisionHistoryRevisionDescriptionDate0.
8ExternalreviewcommentsaddressedFebruary18,20160.
61ReviewcommentsincorporatedJanuary22,20160.
5ReadyforreviewJanuary8,20160.
1FirstinternaldraftDecember18,2015IntroductionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential7ScopeThisdocumentcontainsinformationabouttheIntelRackScaleDesignPodManagerRESTAPI,whichwasdesignedandimplementedfortheIntelRackScaleDesignSoftwarev1.
2releasefortheBulldogCreekSDV.
IntendedaudienceTheintendedaudienceforthisdocumentisdesignersandengineersworkingwiththeIntelRackScaleDesignSoftware1.
2release.
TerminologyTable1TerminologyTermDefinitionBMCBaseboardManagementControllerCIMICloudInfrastructureManagementInterfaceHTTPHypertextTransferProtocolJSONJavaScriptObjectNotationNICNetworkInterfaceCardOCCIOpenCloudComputingInterfaceODataOpenDataProtocolOVFOpenVirtualizationFormatPODAphysicalcollectionofmultipleracksPODMPODManagerPSMEPooledSystemManagementEngineRESTRepresentationalstatetransferSDVSoftwareDevelopmentVehicleURIUniformresourceidentifierUUIDUniversallyUniqueIdentifierXMLExtensibleMarkupLanguageReferencesTable2ReferencedocumentsDocIDTitleLocation332868IntelRackScaleDesignGAMIAPISpecificationhttp://intel.
com/intelRSD332869IntelRackScaleDesignPodManagerRESTAPISpecificationhttp://intel.
com/intelRSD332870IntelRackScaleDesignPodManagerReleaseNoteshttp://intel.
com/intelRSD332871IntelRackScaleDesignPodManagerUserGuidehttp://intel.
com/intelRSD332873IntelRackScaleDesignPSMERESTAPISpecificationhttp://intel.
com/intelRSD332872IntelRackScaleDesignPSMEReleaseNoteshttp://intel.
com/intelRSD332874IntelRackScaleDesignPSMEUserGuidehttp://intel.
com/intelRSD332877IntelRackScaleDesignRMMRESTAPISpecificationhttp://intel.
com/intelRSD332876IntelRackScaleDesignRMMReleaseNoteshttp://intel.
com/intelRSD332875IntelRackScaleDesignRMMUserGuidehttp://intel.
com/intelRSD332878IntelRackScaleDesignStorageServicesAPISpecificationhttp://intel.
com/intelRSDIntroductionIntelRackScaleDesignPodManagerAPISpecificationSeptember20168IntelConfidentialDocumentNumber:332869-005DocIDTitleLocation332936IntelRackScaleDesignBIOS/BMCTechGuidehttp://intel.
com/intelRSD332937IntelRackScaleDesignArchitecturalRequirementsSpecificationhttp://intel.
com/intelRSD334611IntelRackScaleDesignGettingStartedGuidehttp://intel.
com/intelRSDn/aScalablePlatformsManagementAPIhttp://dmtf.
org/standards/redfishPODMAPIIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential9PODMAPIstructureandrelationsThePODMRESTAPIprovidetheREST-basedinterfacethatallowsfullmanagementoftheIntelRackScaleDesignPODincludingassetdiscovery,configuration,andcomposednodeassembly.
PODMAPIphysicalresourcehierarchyFigure1PODMRESTAPIhierarchyTable3ResourcesandURIResourceURIServiceRoot/redfish/v1ChassisCollection/redfish/v1/ChassisChassis/redfish/v1/Chassis/{chassisID}ComputerSystemCollection/redfish/v1/SystemsComputerSystem/redfish/v1/Systems/{systemID}ProcessorsCollection/redfish/v1/Systems/{systemID}/ProcessorsProcessor/redfish/v1/Systems/{systemID/Processors/{processorID}MemoryCollection/redfish/v1/Systems/{systemID}/MemoryMemory/redfish/v1/Systems/{systemID}/Memory/{memoryID}MemoryChunkCollection/redfish/v1/Systems/{systemID}/MemoryChunkMemoryChunk/redfish/v1/Systems/{systemID}/MemoryChunk/{chunkID}StorageAdapterCollection/redfish/v1/Systems/{systemID}/AdaptersStorageAdapter/redfish/v1/Systems/{systemID}/Adapters/{adapterID}DevicesCollection/redfish/v1/Systems/{systemID}/Adapters/{adapterID}/DevicesDevices/redfish/v1/Systems/{systemID}/Adapters/{adapterID}/Devices/{deviceID}ManagerCollection/redfish/v1/ManagersManager/redfish/v1/Managers/{managerID}PODMAPIIntelRackScaleDesignPodManagerAPISpecificationSeptember201610IntelConfidentialDocumentNumber:332869-005ResourceURINetworkProtocol/redfish/v1/Managers/{managerID}/NetworkProtocolNetworkInterfaceCollection/redfish/v1/Systems/{systemID}/EthernetInterfaces/redfish/v1/Managers/{managerID}/EthernetInterfacesNetworkInterface/redfish/v1/Systems/{systemID}/EthernetInterfaces/{nicID}/redfish/v1/Managers/{managerID}/EthernetInterfaces/{nicID}EthernetSwitchCollection/redfish/v1/EthernetSwitchesEthernetSwitch/redfish/v1/EthernetSwitches/{switchID}FabricSwitchPortCollection/redfish/v1/EthernetSwitches/{switchID}/PortsFabricSwitchPort/redfish/v1/EthernetSwitches/{switchID}/Ports/{portID}VLANNetworkInterfaceCollection/redfish/v1/EthernetSwitches/{switchID}/Ports/{portID}/VLANsVLANNetworkInterface/redfish/v1/EthernetSwitches/{switchID}/Ports/{portID}/VLANs/{vlanID}IntelRackScaleDesignStorageServiceCollection/redfish/v1/ServicesIntelRackScaleDesignStorageService/redfish/v1/Services/{serviceID}IntelRackScaleDesignRemoteTargetCollection/redfish/v1/Services/{serviceID}/TargetsIntelRackScaleDesignRemoteTarget/redfish/v1/Services/{serviceID}/Targets/{targetID}IntelRackScaleDesignLogicalDriveCollection/redfish/v1/Services/{serviceID}/LogicalDrivesIntelRackScaleDesignLogicalDrive/redfish/v1/Services/{serviceID}/LogicalDrives/{driveID}IntelRackScaleDesignPhysicalDriveCollection/redfish/v1/Services/{serviceID}/DrivesIntelRackScaleDesignPhysicalDrive/redfish/v1/Services/{serviceID}/Drives/{driveID}IntelRackScaleDesignComposedNodeCollection/redfish/v1/NodesIntelRackScaleDesignComposedNode/redfish/v1/Nodes/{nodeID}SimpleStorageCollection/redfish/v1/Systems/{system1}/SimpleStorageSimpleStorage/redfish/v1/Systems/{system1}/SimpleStorage/{storageID}PowerZoneCollection/redfish/v1/Chassis/{chassisID}/PowerZonesPowerZone/redfish/v1/Chassis/{chassisID}/PowerZones/{powerzoneID}ThermalZoneCollection/redfish/v1/Chassis/{chassisID}/ThermalZonesThermalZone/redfish/v1/Chassis/{chassisID}/ThermalZones/{thermalzoneID}PODMRESTAPIErrorCodesIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential11ThischapterdescribesallerrorcodesthatmaybereturnedbytheRESTcallsimplementedinthePODMRESTAPIoftheIntelRackScaleDesignsoftwarev1.
1release.
APIerrorresponseInthecaseofanerror,PODMRESTAPIrespondswithanHTTPstatuscode,asdefinedbytheHTTP1.
1specificationandconstrainedbyadditionalrequirementsdefinedinthisspecification.
HTTPresponsestatuscodesaloneoftendonotprovideenoughinformationtodeterminetheerrorcause.
ThePODMRESTAPIreturnsextendederrorinformationasaJSONobjectwithasinglepropertynamed"error".
ThevalueofthispropertyshallbetheJSONobjectwiththepropertieslistedinTable4.
Table4APIerrorresponseattributesAttributeDescriptionMessageIdStringindicatingaspecificerrorormessage(nottobeconfusedwiththeHTTPstatuscode).
Thiscodecanbeusedtoaccessadetailedmessagefromamessageregistry.
MessageAhumanreadableerrormessageindicatingthesemanticsassociatedwiththeerror.
Thisshallbethecompletemessage,andnotrelyonsubstitutionvariables.
MessageArgsAnoptionalarrayofstringsrepresentingthesubstitutionparametervaluesforthemessage.
ThisshallbeincludedintheresponseifaMessageIdisspecifiedforaparameterizedmessageSeverityAnoptionalstringrepresentingtheseverityoftheerror.
ResolutionAnoptionalstringdescribingrecommendedaction(s)totaketoresolvetheerror.
RelatedPropertiesAnoptionalarrayofJSONPointersdefiningthespecificpropertieswithinaJSONpayloaddescribedbythemessage.
ExampleerrorJSONobject{"error":{"code":"Base.
1.
0.
GeneralError","message":"Ageneralerrorhasoccurred.
SeeExtendedInfoformoreinformation.
","@Message.
ExtendedInfo":[{"@odata.
type":"/redfish/v1/$metadata#Message.
1.
0.
0.
Message","MessageId":"Base.
1.
0.
MalformedJSON","Message":"TherequestbodysubmittedwasmalformedJSONandcouldnotbeparsedbythereceivingservice","Severity":"Error"}{"@odata.
type":"/redfish/v1/$metadata#Message.
1.
0.
0.
Message","MessageId":"Base.
1.
0.
PropertyNotWriteable","RelatedProperties":["#/Name"],"Message":"ThepropertyNameisareadonlypropertyandcannotbeassignedavalue","MessageArgs":["Name"PODMRESTAPIErrorCodesIntelRackScaleDesignPodManagerAPISpecificationSeptember201612IntelConfidentialDocumentNumber:332869-005],"Severity":"Warning","Resolution":"Removethepropertyfromtherequestbodyandresubmittherequestiftheoperationfailed"}]}}APIerrorcodesIngeneral,ifanerrorisnotdescribedinanyofthefollowingtables,itistobemappedintoHTTP500InternalErrorcode.
GeneralerrorcodesTable5GeneralerrorcodesErrorcodeDescriptionHTTPstatuscodeUnknownExceptionAgenericerrormessage,givenwhenanunexpectedconditionwasencounteredandnomorespecificmessageissuitable.
500InternalErrorServiceUnavailableTheserveriscurrentlyunabletohandletherequestduetotemporaryoverloadingormaintenanceoftheserver503ServiceunavailableRequesterrorcodesTable6RequesterrorcodesErrorcodeDescriptionHTTPstatuscodeInvalidEndpointInvalidendpointin/redfish/v1namespace404NotFoundInvalidHttpMethodInvalidHTTPrequestmethod405MethodNotAllowedMalformedUriMalformedURI400BadRequestBadAcceptHeaderBadAcceptfieldinrequestheader406NotAcceptableInvalidPayloadRequestpayloadisinvalidormissing400BadRequestNodeassemblyerrorcodesTable7NodeassemblyerrorcodesErrorcodeDescriptionHTTPstatuscodeNotSufficientResourcesNotsufficientresourcesforcreatingmachine500InternalServerErrorUnsupportedCreationRequestUnabletocreatemachineduetoerrorinmachinetemplateorbadcreationrequest400BadRequestResourcesStateMismatchConflictduringallocation409ConflictNodeactionerrorcodesTable8NodedisassemblyerrorcodesErrorcodeDescriptionHTTPstatuscodeComposedNodeActionExceptionUnabletoperformactiononactualstateofthecomposednode.
409ConflictPODMRESTAPIErrorCodesIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential13EachresourceavailableonRESTAPIhasownlistofpropertiesthatdescribesit.
Propertiescanbemandatory;insuchcasestheymustbepresentintheresultingJSON.
Whenapropertyisnotmandatory,itmaynotbepresentintheJSON.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201614IntelConfidentialDocumentNumber:332869-005OdatasupportIntelRackScaleDesignsupportOdatav4.
0asitisdefinedinRedfishspecification.
AllresourceswithinthisRESTfulAPIareidentifiedbyuniqueidentifierpropertynamed"@odata.
id".
ResourceIdentifiersshallberepresentedinJSONpayloadsasuripathsrelativetotheRedfishSchemaportionoftheuri.
Thatis,theyshallalwaysstartwith"/redfish/".
TheresourceidentifieristhecanonicalURLfortheresourceandcanbeusedtoretrieveoredittheresource,asappropriate.
ProtocolversionTheprotocolversionisseparatefromtheversionoftheresourcesortheversionoftheRedfishSchemasupportedbythem.
EachversionoftheRedfishprotocolisstronglytyped.
ThisisaccomplishedusingtheURIoftheRedfishserviceincombinationwiththeresourceobtainedatthatURI,calledtheServiceRoot.
TherootURIforthisversionoftheRedfishprotocolshallbe"/redfish/v1/".
WhilethemajorversionoftheprotocolisrepresentedintheURI,themajorversion,minorversionanderrataversionoftheprotocolarerepresentedintheVersionpropertyoftheServiceRootresource,asdefinedintheRedfishSchemaforthatresource.
Theprotocolversionisastringoftheform:MajorVersion.
MinorVersion.
ErrataWhere:MajorVersion=integer:somethingintheclasschangedinabackwardincompatibleway.
MinorVersion=integer:aminorupdate.
Newfunctionalitymayhavebeenaddedbutnothingremoved.
Compatibilitywillbepreservedwithpreviousminorversions.
Errata=integer:somethinginthepriorversionwasbrokenandneededtobefixed.
Anyresourcediscoveredthroughlinksfoundbyaccessingtherootserviceoranyserviceorresourcereferencedusingreferencesfromtherootserviceshallconformtothesameversionoftheprotocolsupportedbytherootservice.
OperationsGETRequest:GET/redfishContent-Type:applicaton/jsonResponse:{"v1":"/redfish/v1/"}IntelRackScaleDesignPODmanagerservicerootIntelRackScaleDesignPODManagerServiceRootresource–entrypoint.
Table9liststheattributes.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential15Table9IntelRackScaleDesignPODmanagerserviceRootattributesNameServicerootTypeURI/redfish/v1/AttributeTypeRedfishRequiredIntelRackScaleDesignRequiredNullableDescriptionIdStringNoNoResourceidentifierNameStringYesNoNameofservicerootDescriptionStringNoProvidesadescriptionofthisresourceandisusedforcommonalityintheschemadefinitionsUUIDStringNoUniqueidentifierforaserviceinstance–mustbeconstantforparticulardrawer.
Theformatofthisstringshallbea32-bytevalueintheform8-4-4-4-12RedfishVersionStringNoNoTheversionoftheRedfishserviceinformatMajor.
Minor.
ErrataEventServiceObjectNoThisistheschemadefinitionfortheEventService.
Itrepresentsthepropertiesfortheserviceitselfandhaslinkstotheactuallistofsubscriptions.
ChassisObjectNoLinktochassiscollection(Drawers)SystemsObjectNoLinktoComputerSystemscollection(logicalservernodes)ServicesObjectNoLinktoservicescollectionManagersObjectNoLinktoManagerscollectionEthernetSwitchesObjectNoLinktoEthernetSwitchescollectionNodesObjectLinktoComposedNodescollectionOemObjectNoOemextensionobject"Intel_RackScale"extensions:AttributeTypeDescriptionApiVersionStringVersionofIntelRackScaleAPIinformat:Major.
minor.
errataLinksObjectYesNoLinksectionsOperationsGETRequest:GET/redfish/v1Content-Type:applicaton/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#ServiceRoot.
ServiceRoot","@odata.
id":"/redfish/v1/","@odata.
type":"#ServiceRoot.
1.
0.
0.
ServiceRoot","Id":"RootService","Name":"RootService","RedfishVersion":"1.
0.
0","UUID":"92384634-2938-2342-8820-489239905423",PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201616IntelConfidentialDocumentNumber:332869-005"Systems":{"@odata.
id":"/redfish/v1/Systems"},"Chassis":{"@odata.
id":"/redfish/v1/Chassis"},"Managers":{"@odata.
id":"/redfish/v1/Managers"},"EventService":{"@odata.
id":"/redfish/v1/EventService"},"Services":{"@odata.
id":"/redfish/v1/Services"},"Nodes":{"@odata.
id":"/redfish/v1/Nodes"},"EthernetSwitches":{"@odata.
id":"/redfish/v1/EthernetSwitches"},"Oem":{"Intel:RackScale":{"@odata.
type":"#Intel.
Oem.
ServiceRoot","ApiVersion":"1.
2.
0",}},"Links":{}}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential17ChassiscollectionTable10ChassiscollectionattributesNameChassisTypeURI/redfish/v1/ChassisAttributeTypeRequiredDescriptionNameStringYesNameofcollectionMembers@odata.
countNumberNoCollectionmemberscountMembersArrayNoContainsthemembersofthiscollection.
OperationsGETRequest:GET/redfish/v1/ChassisContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Chassis","@odata.
id":"/redfish/v1/Chassis","@odata.
type":"#ChassisCollection.
ChassisCollection","Name":"ChassisCollection","Members@odata.
count":6,"Members":[{"@odata.
id":"/redfish/v1/Chassis/Pod"},{"@odata.
id":"/redfish/v1/Chassis/Rack1"},{"@odata.
id":"/redfish/v1/Chassis/Drawer1"},{"@odata.
id":"/redfish/v1/Chassis/FabricModule1"},{"@odata.
id":"/redfish/v1/Chassis/Sled1"},{"@odata.
id":"/redfish/v1/Chassis/Blade1"}]}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201618IntelConfidentialDocumentNumber:332869-005POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
ChassisThisistheschemadefinitionfortheChassisresource.
Itrepresentsthepropertiesforphysicalcomponentsforanysystem.
Thisoneobjectisintendedtorepresentracks,rackmountservers,blades,standalone,modularsystems,enclosures,andallothercontainers.
Thenon-cpu/devicecentricpartsoftheschemaareallaccessedeitherdirectlyorindirectlythroughthisresource.
Table11ChassisattributesNameChassisTypeURI/redfish/v1/Chassis/{chassisId}AttributeTypeRedfishRequiredIntelRackScaleDesignRequiredNullableDescriptionIdStringNoNoResourceidentifierNameStringYesNoNameofservicerootDescriptionStringNoProvidesadescriptionofthisresourceandisusedforcommonalityintheschemadefinitionsChassisTypeStringYesNoChassisTypeshallindicatethephysicalformfactorforthetypeofchassis.
Allowedvalues:"Pod"-Acollectionofequipmentracksinalarge,likelytransportable,container"Rack"-Anequipmentrack,typicallya19-inchwidefreestandingunit"Blade"-Anenclosedorsemi-enclosed,typicallyvertically-oriented,systemchassiswhichmustbepluggedintoamulti-systemchassistofunctionnormally"Enclosure"-Agenerictermforachassisthatdoesnotfitanyotherdescription"RackMount"-Asinglesystemchassisdesignedspecificallyformountinginanequipmentrack"Expansion"-Achassiswhichexpandsthecapabilitiesorcapacityofanotherchassis"Zone"-Alogicaldivisionorportionofaphysicalchassisthatcontainsmultipledevicesorsystemsthatcannotbephysicallyseparated"Sled"-Anenclosedorsemi-enclosed,systemchassiswhichmustbepluggedintoamulti-systemchassistofunctionnormallysimilartoabladetypechassis"Shelf"-Anenclosedorsemi-enclosed,typicallyhorizontally-oriented,systemchassiswhichmustbepluggedintoamulti-systemchassistofunctionnormally"Drawer"-Anenclosedorsemi-enclosed,typicallyhorizontally-oriented,systemchassiswhichmaybeslidintoamulti-systemchassis"Module"-Asmall,typicallyremovable,chassisorcardwhichcontainsdevicesforaparticularsubsystemorfunction"Other"-AchassisthatdoesnotfitanyofthesedefinitionsPODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential19NameChassisTypeURI/redfish/v1/Chassis/{chassisId}ManufacturerStringNoThisisthemanufacturerofthischassisModelStringNoThisisthemodelnumberforthechassisSKUStringNoThisistheSKUforthischassisSerialNumberStringNoTheserialnumberforthischassisPartNumberStringNoThepartnumberforthischassisAssetTagStringNoTheuserassignedassettagforthischassisIndicatorLEDStringNoThestateoftheindicatorLED,usedtoidentifythechassis.
Allowedvalues:"Lit""Blinking""Off""Unknown"StatusObjectNoSeechapter5.
1forstatusofresource.
OemObjectNoOemextensionobject"Intel_RackScale"extensions:AttributeTypeDescriptionLocationObjectPropertythatshowthischassisIDanditsparent.
Containsfollowingproperties:"Id"–stringcontaininglocationIDofthischassis"ParentId"–stringcontaininglocationIDofparentchassisRMMPresentBoolean,nullRMMpresenceinarackRackSupportDisaggregatedPowerCoolingBoolean,nullIndicatesifRacksupportdisaggregated(shared)powerandcoolingcapabilitiesUUIDString,nullChassisuniqueIDGeoTagString,nullProvidesinfoaboutgeographicalylocationofthischassis.
ActionsObjectNoNoChassisactions.
ThermalZonesObjectNoAreferencetoThermalZonescollectionPowerZonesObjectNoAreferencetoPowerZonescollectionLinksObjectNoNoLinksectionsComputerSystemsArrayNoAnarrayofreferencestothecomputersystemscontainedinthischassis.
ThiswillonlyreferenceComputerSystemsthataredirectlyandwhollycontainedinthischassisSwitchesArrayNoAnarrayofreferencestotheEthernetswitchedcontainedinthischassis.
ManagedByArrayNoAnarrayofreferencestothemanagerscontainedinthischassisManagersInChassisArrayNoAnarrayofreferencestothemanagerslocatedinthischassisContainedByObjectNoAreferencetothechassisthatthischassisiscontainedbyContainsArrayNoAnarrayofreferencestoanyotherchassisthatthischassishasinitPODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201620IntelConfidentialDocumentNumber:332869-005OperationsGETRequest:GET/redfish/v1/Chassis/1Content-Type:applicaton/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Chassis/Members/$entity","@odata.
id":"/redfish/v1/Chassis/Rack1","@odata.
type":"#Chassis.
1.
0.
0.
Chassis","Id":"Rack1","ChassisType":"RackMount","Name":"name-as-string","Description":"description-as-string","Manufacturer":"IntelCorporation","Model":"model-as-string","SKU":"sku-as-string","SerialNumber":"serial-number-as-string","PartNumber":"part-number-as-string","AssetTag":null,"IndicatorLED":"Unknown","PowerState":"On","Status":{"State":"Enabled","Health":"OK"},"Oem":{"Intel:RackScale":{"@odata.
type":"#Intel.
Oem.
RackChassis","Location":{"Id":"Rack1","ParentId":"Pod1"},"RMMPresent":true,"RackSupportsDisaggregatedPowerCooling":true,"UUID":"UniqueID","GeoTag":"54.
348103,18.
645172"}},"ThermalZones":{"@odata.
id":"/redfish/v1/Chassis/Rack1/ThermalZones"},"PowerZones":{"@odata.
id":"/redfish/v1/Chassis/Rack1/PowerZones"},"Links":{"Contains":[{"@odata.
id":"/redfish/v1/Chassis/Drawer1"}PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential21],"ContainedBy":null,"ComputerSystems":[],"Switches":[],"ManagedBy":[{"@odata.
id":"/redfish/v1/Managers/RMM"}],"ManagersInChassis":[{"@odata.
id":"/redfish/v1/Managers/RMM"}],"Oem":{}}}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
PowerZonecollectionPowerZonecollectionresource.
Table12PowerZonecollectionattributesNamePowerZoneCollectionTypeURI/redfish/v1/Chassis/{chassisID}/PowerZonesAttributeTypeRequiredDescriptionNameStringYesNameofcollectionMembers@odata.
countNumberNoCollectionmemberscountMembersArrayNoContainsthemembersofthiscollection.
OperationsGETRequest:GET/redfish/v1/Chassis/Rack1/PowerZonesContent-Type:application/jsonPODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201622IntelConfidentialDocumentNumber:332869-005Response:{"@odata.
context":"/redfish/v1/$metadata#PowerZoneCollection.
PowerZoneCollection","@odata.
id":"/redfish/v1/Chassis/Rack1/PowerZones","@odata.
type":"#PowerZoneCollection.
PowerZoneCollection","Name":"PowerZonesCollection","Members@odata.
count":1,"Members":[{"@odata.
id":"/redfish/v1/Chassis/Rack1/PowerZones/Power1"}]}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
PowerZoneThisresourceshallbeusedtorepresentapowerzoneresourceforanIntelRackScaleDesignimplementation.
ItcontainsPowerSuppliesandPowerControlinformation.
Table13PowerZoneattributesNamePowerZoneTypeURI/redfish/v1/Chassis/{chassisId}/PowerZones/{zoneID}AttributeTypeRedfishRequiredIntelRackScaleDesignRequiredNullableDescriptionIdStringNoNoResourceidentifierNameStringYesNoNameofservicerootDescriptionStringNoProvidesadescriptionofthisresourceandisusedforcommonalityintheschemadefinitionsStatusObjectNoSeechapter5.
1forstatusofresource.
RackLocationObjectNoZonephysicallocation.
AttributeTypeDescriptionRackUnitsStringRack.
Units:indicatestherackunittype.
"RU":rackunit,eachRU44.
5mmPODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential23"OU":openU,eachOU48mmXLocationNumberThehorizontallocationwithinuLocation,fromlefttoright(1.
.
MAXIMUM)0indicatenotavailable.
ULocationNumberTheindexofthetop-mostUofthecomponent,fromtoptobottom(1.
.
MAXIMUM)0indicatenotavailableUHeightNumberTheheightofmanagedzone,e.
g.
8for8U,16for16UMaxPSUsSupportedNumberNoThemaximumnumberofPowerSupplyUnitsupportedbyPowerZone.
PresenceStringNoIndicatestheaggregatedPowerSupplyUnitpresenceinformationAggregatedPowerSupplyUnitpresenceformat:LengthofstringindicatetotalslotofPowerSupplyUnitsinPowerZone.
Foreachbytethestring:"1"meanspresent"0"meansnotpresentNumberOfPSUsPresentNumberNoIndicatesthenumberofexistingPowerSupplyUnitinPowerZone.
PowerConsumedWattsNumberNoThetotalpowerconsumptionofPowerZone,sumoftrays'powerconsumptionPowerOutputWattsNumberNoThetotalpowerproductionofPowerZone,sumofPSUs'outputPowerCapacityWattsNumberNoThemaximumpowercapacitysupportedbyPowerZone.
PowerSuppliesArrayNoNoDetailsofthepowersuppliesassociatedwiththissystemordevice.
DetaileddescriptioninTable14ActionsObjectNoNoActionsthatcanbeexecutedonzoneLinksObjectNoNoLinkstoresourcesrelatedtothisresource.
Table14PowerSupplyattributesAttributeTypeRedfishRequiredIntelRackScaleDesignRequiredNullableDescriptionNameStringNoPowerSupplynamePowerCapacityWattsNumberNoThemaximumcapacityofthisPowerSupplyLastPowerOutputWattsNumberNoTheaveragepoweroutputofthisPowerSupplyManufacturerStringNoThemanufacturerofthisPowerSupplyModelNumberStringNoThemodelnumberforthisPowerSupplyFirmwareRevisionStringNoThefirmwareversionforthisPowerSupplySerialNumberStringNoTheserialnumberforthisPowerSupplyPartNumberStringNoThepartnumberforthisPowerSupplyStatusObjectNoStatusofresource,seechapter5.
1RackLocationObjectNoAttributeTypeDescriptionPODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201624IntelConfidentialDocumentNumber:332869-005RackUnitsStringRack.
Units:indicatestherackunittype.
"RU":rackunit,eachRU44.
5mm"OU":openU,eachOU48mmXLocationNumberThehorizontallocationwithinuLocation,fromlefttoright(1.
.
MAXIMUM)0indicatenotavailable.
ULocationNumberTheindexofthetop-mostUofthecomponent,fromtoptobottom(1.
.
MAXIMUM)0indicatenotavailableUHeightNumberTheheightofcomponent,e.
g.
8for8U,16for16UOperationsGETRequest:GET/redfish/v1/Chassis/Rack1/PowerZones/Power1Content-Type:applicaton/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Chassis/Rack/PowerZones/Members/$entity","@odata.
id":"/redfish/v1/Chassis/Rack1/PowerZones/1","@odata.
type":"PowerZone.
1.
0.
0.
PowerZone","Id":"1","Name":"powerzone1","Description":"powerzone1","Status":{"State":"Enabled","Health":"OK","HealthRollup":"OK"},"RackLocation":{"RackUnits":"OU","XLocation":0,"ULocation":1,"UHeight":8},"MaxPSUsSupported":6,"Presence":"111111","NumberOfPSUsPresent":6,"PowerConsumedWatts":2000,"PowerOutputWatts":2000,"PowerCapacityWatts":3000,"PowerSupplies":[{PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential25"Name":"Powersupply1","Status":{"State":"Enabled","Health":"OK","HealthRollup":"OK"},"RackLocation":{"RackUnits":"OU","XLocation":0,"ULocation":1,"UHeight":8},"SerialNumber":"","Manufacturer":"","ModelNumber":"","PartNumber":"","FirmwareRevision":"","PowerCapacityWatts":300,"LastPowerOutputWatts":48}],"Actions":{},"Links":{}}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
ThermalZonecollectionThermalZonecollectionresource.
Table15ThermalZonecollectionattributesNameThermalZoneCollectionTypeURI/redfish/v1/Chassis/{chassisID}/ThermalZonesAttributeTypeRequiredDescriptionNameStringYesNameofcollectionMembers@odata.
countNumberNoCollectionmemberscountMembersArrayNoContainsthemembersofthiscollection.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201626IntelConfidentialDocumentNumber:332869-005OperationsGETRequest:GET/redfish/v1/Chassis/Rack1/ThermalZonesContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#ThermalZoneCollection.
ThermalZoneCollection","@odata.
id":"/redfish/v1/Chassis/Rack1/ThermalZones","@odata.
type":"#ThermalZoneCollection.
ThermalZoneCollection","Name":"ThermalZonesCollection","Members@odata.
count":1,"Members":[{"@odata.
id":"/redfish/v1/Chassis/Rack1/ThermalZones/Thermal1"}]}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
ThermalZoneThisresourceshallbeusedtorepresentathermalzoneresourceforanIntelRackScaleDesignimplementation.
ItcontainsFansandtemperatureinformation.
Table16ThermalZoneattributesNameThermalZoneTypeURI/redfish/v1/Chassis/{chassisId}/ThermalZones/{zoneID}AttributeTypeRedfishRequiredIntelRackScaleDesignRequiredNullableDescriptionIdStringNoNoResourceidentifierNameStringYesNoNameofservicerootDescriptionStringNoProvidesadescriptionofthisresourceandisusedforcommonalityintheschemadefinitionsStatusObjectNoSeechapter5.
1forstatusofresource.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential27RackLocationObjectNoZonephysicallocation.
AttributeTypeDescriptionRackUnitsStringRack.
Units:indicatestherackunittype.
"RU":rackunit,eachRU44.
5mm"OU":openU,eachOU48mmXLocationNumberThehorizontallocationwithinuLocation,fromlefttoright(1.
.
MAXIMUM)0indicatenotavailable.
ULocationNumberTheindexofthetop-mostUofthecomponent,fromtoptobottom(1.
.
MAXIMUM)0indicatenotavailableUHeightNumberTheheightofmanagedzone,e.
g.
8for8U,16for16UPresenceStringNoIndicatestheaggregatedPowerSupplyUnitpresenceinformationAggregatedPowerSupplyUnitpresenceformat:LengthofstringindicatetotalslotofPowerSupplyUnitsinPowerZone.
Foreachbytethestring:"1"meanspresent"0"meansnotpresentDesiredSpeedPWMNumberNoThedesiredFANspeedincurrentThermalZonepresentinPWMunitDesiredSpeedRPMNumberNoThedesiredFANspeedincurrentThermalZonepresentinRPMunitMaxFansSupportedNumberNoNumberofmaximumfansthatcanbeinstalledingivenThermalZoneNumberOfFansPresentNumberNoTheexistingnumberofFanincurrentThermalZone.
VolumetricAirflowNumberNoRackLevelPTASTelemetry–VolumetricairflowincurrentThermalZone.
TemperaturesArrayNoNoArrayoftemperaturesensors.
DetaileddescriptioninTable18FansArrayNoNoDetailsofthefansassociatedwiththisthermalzone.
DetaileddescriptioninTable14ActionsObjectNoNoActionsthatcanbeexecutedonthermalzoneLinksObjectNoNoLinkstoresourcesrelatedtothisresource.
Table17FanattributesAttributeTypeRedfishRequiredIntelRackScaleDesignRequiredNullableDescriptionNameStringNoPowerControlFunctionnameReadingRPMNumberNoFanrpmreadingStatusObjectNoStatusofresource,seechapter5.
1RackLocationObjectNoFanphysicallocation.
AttributeTypeDescriptionPODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201628IntelConfidentialDocumentNumber:332869-005AttributeTypeRedfishRequiredIntelRackScaleDesignRequiredNullableDescriptionRackUnitsStringRack.
Units:indicatestherackunittype.
"RU":rackunit,eachRU44.
5mm"OU":openU,eachOU48mmXLocationNumberThehorizontallocationwithinuLocation,fromlefttoright(1.
.
MAXIMUM)0indicatenotavailable.
ULocationNumberTheindexofthetop-mostUofthecomponent,fromtoptobottom(1.
.
MAXIMUM)0indicatenotavailableUHeightNumberTheheightofmanagedfun,e.
g.
8for8U,16for16UTable18TemperatureattributesAttributeTypeRedfishRequiredIntelRackScaleDesignRequiredNullableDescriptionNameStringNoPowerSupplynameReadingCelsiusNumberNoCurrentvalueofthetemperaturesensor'sreadingPhysicalContextStringNoDescribestheareaordevicetowhichthistemperaturemeasurementapplies:"Intake"-Theintakepointofthechassis"Exhaust"-Theexhaustpointofthechassis"Backplane"-Abackplanewithinthechassis"PowerSupply"–Apowersupply"SystemBoard"-Thesystemboard(PCB)"ComputeBay"-Withinacomputebay"PowerSupplyBay"-WithinapowersupplybayStatusObjectNoSeechapter5.
1forstatusofresource.
OperationsGETRequest:PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential29GET/redfish/v1/Chassis/Rack1/ThermalZones/Thermal1Content-Type:applicaton/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Chassis/Rack/ThermalZones/Members/$entity","@odata.
type":"ThermalZone.
1.
0.
0.
ThermalZone","@odata.
id":"/redfish/v1/Chassis/Rack1/ThermalZones/1","Id":"1","Name":"thermalzone1","Description":"thermalzone1","RackLocation":{"RackUnits":"OU","XLocation":0,"ULocation":1,"UHeight":8},"Presence":"111100","DesiredSpeedPWM":50,"DesiredSpeedRPM":3000,"MaxFansSupported":6,"NumberOfFansPresent":6,"VolumetricAirflow":80,"Temperatures":[{"Name":"InletTemperature","Status":{"State":"Enabled","Health":"OK","HealthRollup":null},"ReadingCelsius":21,"PhysicalContext":"Intake"},{"Name":"OutletTemperature","Status":{"State":"Enabled","Health":"OK","HealthRollup":null},"ReadingCelsius":35,"PhysicalContext":"Exhaust"}],"Status":{"State":"Enabled","Health":"OK","HealthRollup":null},"Fans":[{"Name":"Fan1","Status":{PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201630IntelConfidentialDocumentNumber:332869-005"State":"Enabled","Health":"OK","HealthRollup":null},"ReadingRPM":0,"RackLocation":{"RackUnits":"OU","XLocation":0,"ULocation":1,"UHeight":8}}],"Actions":{},"Links":{}}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
StorageservicecollectionIntelRackScaleDesignstorageservicecollectionresource–providescollectionofavailablestorageservices.
Table19liststheattributes.
Table19StorageservicecollectionattributesNameStorageserviceTypeURI/redfish/v1/ServicesAttributeTypeMandatoryDescriptionNameStringYesNameofservicecollection.
Members@odata.
countNumberNoCollectionmemberscountMembersArrayNoContainsthemembersofthiscollection.
OperationsGETRequest:GET/redfish/v1/ServicesContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Services",PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential31"@odata.
id":"/redfish/v1/Services","@odata.
type":"#StorageServiceCollection.
StorageServiceCollection","Name":"StorageServicesCollection","Description":"CollectionofStorageServices","Members@odata.
count":1,"Members":[{"@odata.
id":"/redfish/v1/Services/RSS1"}]}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
ComposednodecollectionIntelRackScaleDesignComposedNodecollectionresource–providescollectionofalllogicalnodes.
Table20liststheattributes.
Table20ComposednodecollectionattributesNameComposednodecollectionTypeURI/redfish/v1/NodesAttributeTypeMandatoryDescriptionNameStringYesNameofcollectionMembers@odata.
countNumberNoCollectionmemberscountMembersArrayNoContainsthemembersofthiscollection.
ActionsObjectNoActionsavailable:Allocate–thisactionisfirstmandatorysteptocreatecomposednode.
Inresponseforthisactionproperresourceswillbefindandallocatedfornodecomposition.
NoderesourcewillbecreatedandURL(link)ofthisnodewillbereturned.
ToallocateaComposedNodeusingPodMRESTAPIitisnecessarytocreateaJSONtemplatedescribingrequestedresources.
TheJSONtemplatemaycontainvariousdetailsconcerningresourcestobeusedinComposedNode.
AllJSONtemplateelementsareoptional,buteachshouldbecoherentitself.
ItispossibletosupplyPodMwithaJSONtemplatecontainingnospecificrequirements(e.
g.
{}–apairofemptycurlybracesinHTTPrequestbody)thusallowingPodMtoproposeaComposedNodecontainingresourceschosenarbitrarilybyPodM.
FormatofJSONtemplate(actionpayload)isdescribedinTable21PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201632IntelConfidentialDocumentNumber:332869-005Formoreinformationaboutnodeallocationandassembly,refertoPODM_Allocation_Guidedocument.
Table21ComposednodeAllocationactionattributesAttributeTypeMandatoryDescriptionNameStringNoNameofcomposednode.
Note:BecauseComposedNodeisaRedfishresource-itsNamefieldismandatory,soanattempttodirectlysetanullvalueresultsinanexpectederror.
PodMwillsetadefaultnamefornewlycreatedComposedNoderesourceonlyuponnotsupplyingtheNameattribute.
DescriptionStringNoDescriptionofcomposednodeProcessorsArrayNoArrayofrequirementsforprocessorforcomposednode.
Eachprocessorrequirementmaycontainoneormoreoptionalattributes:AttributeTypeDescriptionModelStringProcessormodelthatshouldbeusedforcomposednode(exactmodelname)TotalCoresNumberMinimumnumberofprocessorcoresAchievableSpeedMHzNumberMinimumachievableprocessoroperatingfrequency.
InstructionSetStringProcessorsupportedinstructionset.
"x86"–x8632-bit"x86-64"–x8664-bit"IA-64"–IntelIA-64"ARM*-A32"–ARM32-bit"ARM-A64"–ARM64-bit"MIPS32"–MIPS32-bit"MIPS64"–MIPS64-bit"OEM"–OEM-definedResourceObjectReferencetoparticularprocessorthatshouldbeusedincomposednodeChassisObjectLinktochassisobjectwithinthisprocessorshouldbecontained.
BrandStringBrandofCPUthatshouldbeusedtoallocatenode.
Allowablevalues:Xeonfamily:E3,E5,E7SoC/Atomfamily:X3(Avoton),X5(Broadwell-DE),X7Corefamily:I3,I5,I7"Unknown"–processordoesn'tfittoanyabovecategoriesCapabilitiesArrayArrayofstringsdescribingprocessorcapabilities(likereportedin/proc/cpuinfoflags),suchas:PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential33"sse"-StreamingSIMDExtensions"avx"-AdvancedVectorExtensionsMemoryArrayNoArrayofrequirementsformemoryforcomposednode.
AttributeTypeDescriptionCapacityMiBNumberMinimummemorycapacityrequestedforcomposednodeDimmDeviceTypeStringTypedetailsofDIMM:"DDR""DDR2""DDR3""DDR4""DDR4SDRAM""DDR4ESDRAM""LPDDR4SDRAM""DDR3SDRAM""LPDDR3SDRAM""DDR2SDRAM""DDR2SDRAM-FB-DIMM""DDR2SDRAM-FB-DIMMPROBE""DDRSGRAM""DDRSDRAM""ROM""SDRAM""EDO""FastPageMode""PipelinedNibble"SpeedMHzNumberMinimumsupportedmemoryspeed.
ManufacturerStringRequestedmemorymanufacturer.
DataWidthBitsNumberRequestedmemorydatawidthinbits.
ResourceObjectReferencetoparticularmemorymodulethatshouldbeusedincomposednodeChassisObjectLinktochassisobjectwithinthismemorydimmshouldbecontained.
RemoteDrivesArrayNoArrayofrequirementsforremotedrivesthatshouldbecreated/connectedtocomposednodeAttributeTypeDescriptionCapacityGiBNumberMinimumdrivecapacityrequestedforcomposednodeiSCSIAddressStringDefinesTargetIQNofRemoteTargettobesetfornewRemoteTarget(shouldbeuniqueinPodM).
Note:Masterpropertyisrequiredforcreatingnewtarget.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201634IntelConfidentialDocumentNumber:332869-005MasterObjectDefinesmasterlogicalvolumethatshouldbetakentocreatenewremotetarget.
ItcontainspropertiesdescribedinTable22LocalDrivesArrayNoArrayofrequirementsforlocaldrivesforcomposednode.
AttributeTypeDescriptionCapacityGiBNumberMinimumdrivecapacityrequestedforcomposednodeTypeStringDrivetype"HDD""SSD""NVMe"MinRPMNumberMinimumrotationspeedofrequesteddrive.
SerialNumberStringSerialnumberofrequesteddriveInterfaceStringInterfaceofrequesteddrive:"SAS""SATA""PCIe*"ResourceObjectReferencetoparticularlocaldrivethatshouldbeusedincomposednodeChassisObjectLinktochassisobjectwithinthisdriveshouldbecontained.
EthernetInterfacesArrayNoArrayofrequirementsforEthernetinterfacesofcomposednodeAttributeTypeDescriptionSpeedMbpsNumberMinimumspeedofEthernetinterfacerequestedforcomposednodeVLANsArrayArrayofVLANsthatshouldbeconfiguredonconnectedswitchportforcomposednodeforgivenEthernetinterfaceinfollowingformat:VLANId–numberindicatingVLANIdTagged–BooleanvaluedescribingifgivenVLANistagged.
PrimaryVLANNumberPrimaryVLANIDthatshouldbesetforgivenEthernetInterfaceResourceObjectReferencetoparticularEthernetinterfacethatshouldbeusedincomposednodeChassisObjectLinktochassisobjectwithinthisnetworkinterfaceshouldbecontained.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential35Table22RemotemastertargetpropertiesAttributeTypeDescriptionTypeStringTypeofreplicationofmasterdrive:Clone–volumeshouldbeclonedSnapshot–CopyonWriteshouldbecreatedfromindicatedvolumeResourceObjectReferencetologicalvolumethatshouldbeusedasmasterforreplication.
OperationGETRequest:GET/redfish/v1/NodesContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Nodes","@odata.
id":"/redfish/v1/Nodes","@odata.
type":"#ComposedNodeCollection.
ComposedNodeCollection","Name":"ComposedNodesCollection","Members@odata.
count":1,"Members":[{"@odata.
id":"/redfish/v1/Nodes/Node1"}],"Actions":{"#ComposedNodesCollection.
Allocate":{"target":"/redfish/v1/Nodes/Actions/Allocate"}}}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTCurrentlyausercanrequestallocationofasinglenodewithasinglerequest.
Nodecomponents—CPU,memory,localstorage,networkinterface—mustbelocatedonasinglephysicalblade.
RemotestoragecanbelocatedanywhereinthePod.
BelowJSONisjustanexample.
FordetailsseeAppendix6,section6.
1.
Request:POST/redfish/v1/Nodes/Actions/AllocateContent-Type:application/json{"Name":"Myfirstcomposednode","Description":"Testnode","Processors":[{"Model":"Multi-CoreIntel(R)Xeon(R)processor7xxxSeries","TotalCores":2,PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201636IntelConfidentialDocumentNumber:332869-005"AchievableSpeedMHz":2000,"InstructionSet":"x86","Oem":{"Brand":"E5","Capabilities":["sse"],},"Resource":{"@odata.
id":"/redfish/v1/Systems/System1/Processors/CPU1"}}],"Memory":[{"CapacityMiB":16000,"DimmDeviceType":"DDR3","SpeedMHz":1600,"Manufacturer":"Intel","DataWidthBits":64,"Resource":{"@odata.
id":"/redfish/v1/Systems/System1/DimmConfig/Dimm1"},"Chassis":{"@odata.
id":"/redfish/v1/Chassis/Rack1"}}],"RemoteDrives":[{"CapacityGiB":80,"iSCSIAddress":"iqn.
oem.
com:fedora21","Master":{"Type":"Snapshot","Resource":{"@odata.
id":"/redfish/v1/Services/RSS1/LogicalDrives/sda1"}}}],"LocalDrives":[{"CapacityGiB":500,"Type":"HDD","MinRPM":5400,"SerialNumber":"12345678","Interface":"SATA","Resource":{"@odata.
id":"/redfish/v1/Systems/System1/Adapters/Adapter1/Devices/Device"}}],"EthernetInterfaces":[{"SpeedMbps":1000,"PrimaryVLAN":100,"VLANs":[{"VLANId":100,PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential37"Tagged":false}],"Resource":{"@odata.
id":"/redfish/v1/Systems/System1/EthernetInterfaces/LAN1"}}],"Oem":{}}Response:HTTP/1.
1201CreatedLocation:http://:/redfish/v1/Nodes/2DELETEOperationisnotallowedonthisresource.
ComposednodeComposednoderesource–providesdetailedinformationaboutanassembledlogicalnodeidentifiedby{systemID}.
Tableliststheattributes.
Table23ComposednodeattributesNameComposednodeTypeURI/redfish/v1/Nodes/{nodeID}AttributeTypeMandatoryDescriptionIdStringYesProvidesaIDofthisresourceNameStringYesNameofcomposednodeDescriptionStringNoUserprovidednodedescriptionPODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201638IntelConfidentialDocumentNumber:332869-005NameComposednodeTypeURI/redfish/v1/Nodes/{nodeID}AttributeTypeMandatoryDescriptionSystemTypeString(enum)NoTypeofcomputersystem:"Logical"–logicalinstanceofcomputersystemAssetTagStringNoTheuserassignedassettagforthischassisManufacturerStringNoThisisthemanufacturerofcomputersystemusedasabasefornode.
ModelStringNoModelofcomputersystemusedasabaseforthisnode.
SKUStringNoSKUofcomputersystemusedasabaseforthisnode.
SerialNumberStringNoSerialnumberofcomputersystemusedasabaseforthisnode.
PartNumberStringNoPartnumberofcomputersystemusedasabaseforthisnode.
UUIDStringNoUUIDofcomputersystemusedasabaseforthisnode.
HostNameStringNoHostnameofcomposednodePowerStateString(enum)NoThisisthecurrentpowerstateofthenode"On"-Thesystemispoweredon"Off"-Thesystemispoweredoff,althoughsomecomponentsmaycontinuetohaveAUXpowersuchasmanagementcontroller"PoweringOn"-AtemporarystatebetweenOffandOn.
Thistemporarystatecanbeveryshort.
"PoweringOff"-AtemporarystatebetweenOnandOff.
ThepoweroffactioncantaketimewhiletheOSisintheshutdownprocessBiosVersionStringNoTheversionofthesystemBIOSorprimarysystemfirmwareProcessorsObjectYesNameTypeMandatoryDescriptionCountNumberNoNumberofCPUsModelString,NullNoBasicinformationaboutprocessormodelStatusObjectNoSeechapter5.
1forstatusofresource.
MemoryObjectYesNameTypeMandatoryDescriptionTotalSystemMemoryGiBNumberNoAmountofinstalledmemoryinGiBStatusObjectNoSeechapter5.
1forstatusofresource.
StatusObject,nullNoSeechapter5.
1forstatusofresource.
ComposedNodeStateString(enum)YesCurrentstateofassemblyprocessforthisnode.
Allocating:Allocatingresourcesfornodeisinprogress.
NextstatecanbeAllocatedorFailedAllocated:Noderesourceshasbeenallocated,butassemblynotstartedyet.
AfterComposedNode.
AssembleactionstatewillprogresstoAssembling.
Assembling:Assemblyprocessinitiated,butnotfinishedyet.
WhenassemblyisdoneitwillchangeintoPoweredOn.
PoweredOn:NodesuccessfullyassembledandpoweredonPoweredOff:NodesuccessfullyassembledandpoweredoffFailed:Allocationorassemblyprocessfailed,orinruntimeoneofcomposingcomponentswasremovedortransitionedinerrorstate.
BootObjectNoNameTypeRequiredDescriptionBootSourceOverrideEnabledString,NullNoStateoftheBootSourceOverridefeature.
Propervalues:PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential39NameComposednodeTypeURI/redfish/v1/Nodes/{nodeID}AttributeTypeMandatoryDescription"Disabled""Once""Continuous"BootSourceOverrideTargetString,NullNoThecurrentbootsourcetobeusedatnextbootinsteadofthenormalbootdevice,ifBootSourceOverrideEnabledistrue.
BootSourceOverrideTarget@Redfish.
AllowableValuesArrayNoArrayofsupportedbootsources.
See:BootSourceOverrideTarget/SupportedOemObject,NullNoOEMdefinedobjectLinksObjectNoLinksection:NameTypeRequiredDescriptionComputerSystemObject,nullYesReferencetoComputerSystemresourceusedtocomposethisnode.
ProcessorsArrayNoArrayofreferencestoProcessorresourcesMemoryArrayNoArrayofreferencestoMemoryresourcesRemoteDrivesArrayNoAnarrayofreferencestotheremotestoragedrivesLocalDrivesArrayNoAnarrayofreferencestothecomputersystemlocalstoragedrivesEthernetInterfacesArrayNoArrayoflinkstoEthernetInterfacecollectionassociatedwiththisComposedNodeManagedByArrayNoAnarrayofreferencestoManagersresponsibleforthisComposedNodeActionsObjectYesActionsavailableforthisnode:Resetactionwithfollowingvalues:oOn-TurnthesystemonoForceOff-Turnthesystemoffimmediately(non-graceful)shutdownoGracefulRestart-PerformagracefulsystemshutdownfollowedbyarestartofthesystemoForceRestart-Performanimmediate(non-graceful)shutdown,followedbyarestartofthesystemoNmi-GenerateaDiagnosticInterrupt(usuallyanNMIonx86systems)toceasenormaloperations,performdiagnosticactionsandtypicallyhaltthesystem.
oForceOn-TurnthesystemonimmediatelyoPushPowerButton-SimulatethepressingofthephysicalpowerbuttononthissystemoGracefulShutdown–initiateasoft-shutdownofOSviaACPIPODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201640IntelConfidentialDocumentNumber:332869-005NameComposednodeTypeURI/redfish/v1/Nodes/{nodeID}AttributeTypeMandatoryDescriptionAssemble:Doesn'tconsumeanyparameters.
Secondstepofcreatingacomposednode(afterAllocateActiononNodescollection).
Thatactionwillassemblylogicalnode–initiateComposedNodeStatechangefromAllocatedstateintoAssemblingstateAfterfinishedassemblation,composednodewillstayinPoweredOffstate.
Tochangeitsstate,oneneedstoexecuteResetactionwith"On"parameter(makesurethatBootissetproperly).
Figure2ComposedNodeStatechangesduringassemblyprocessOperationsGETRequest:GET/redfish/v1/Nodes/{systemID}Content-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#Nodes/Members/$entity","@odata.
id":"/redfish/v1/Nodes/Node1","@odata.
type":"#ComposedNode.
1.
0.
0.
ComposedNode","Id":"Node1","Name":"ComposedNode","Description":"Node#1","SystemType":"Logical","AssetTag":"freeformassettag","Manufacturer":"ManufacturerName-thesameasComputerSystem","Model":"ModelName-thesameasComputerSystem","SKU":"SKU-thesameasComputerSystem",PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential41"SerialNumber":"2M220100SL-thesameasComputerSystem","PartNumber":"Computer1-thesameasComputerSystem","UUID":"00000000-0000-0000-0000-000000000000-thesameasComputerSystem","HostName":null,"PowerState":"On","BiosVersion":"P79v1.
00(09/20/2013)-thesameasComputerSystem","Status":{"State":"Enabled","Health":"OK","HealthRollUp":"OK"},"Processors":{"Count":2,"Model":"Multi-CoreIntel(R)Xeon(R)processor7xxxSeries","Status":{"State":"Enabled","Health":"OK"}},"Memory":{"TotalSystemMemoryGiB":32,"Status":{"State":"Enabled","Health":"OK"}},"ComposedNodeState":"Allocated","Boot":{"BootSourceOverrideEnabled":"Disabled","BootSourceOverrideTarget":"None","BootSourceOverrideTarget@Redfish.
AllowableValues":["None","Pxe","Hdd"]},"Oem":{},"Links":{"ComputerSystem":{"@odata.
id":"/redfish/v1/Systems/System1"},"Processors":[{"@odata.
id":"/redfish/v1/Systems/System1/Processors/CPU1"}],"Memory":[{"@odata.
id":"/redfish/v1/Systems/System1/DimmConfig/Dimm1"}],"EthernetInterfaces":[{PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201642IntelConfidentialDocumentNumber:332869-005"@odata.
id":"/redfish/v1/Systems/System1/EthernetInterfaces/LAN1"}],"LocalDrives":[{"@odata.
id":"/redfish/v1/Systems/System1/StorageControllers/Controller1/Drives/Drive1"}],"RemoteDrives":[{"@odata.
id":"/redfish/v1/Services/RSS1/Targets/target1"}],"ManagedBy":[{"@odata.
id":"/redfish/v1/Managers/PODM"}],"Oem":{}},"Actions":{"#ComposedNode.
Reset":{"target":"/redfish/v1/Systems/1/Actions/ComposedNode.
Reset","ResetType@Redfish.
AllowableValues":["On","ForceOff","GracefulRestart","ForceRestart","Nmi","ForceOn","PushPowerButton","GracefulShutdown"]},"#ComposedNode.
Assemble":{"target":"/redfish/v1/Systems/1/Actions/ComposedNode.
Assemble"}}}PUTOperationisnotallowedonthisresource.
PATCHCurrentlyonly"Boot"propertyispatchable.
Followingtabledescribe"Boot"propertiesthatcanbepatched:AttributeTypeRequiredDescriptionBootSourceOverrideEnabledStringNoDescribesthestateoftheBootSourceOverridefeature.
Allowedvalues:"Disabled"-Thesystemwillbootasnormal"Once"-Onitsnextbootcycle,thesystemwillboot(onetime)totheBootSourceOverrideTarget"Continuous"-ThesystemwillboottothetargetspecifiedintheBootSourceOverrideTargetuntilthispropertyissettoDisabledPODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential43BootSourceOverrideTargetStringNoThecurrentbootsourcetobeusedatnextbootinsteadofthenormalbootdevice,ifBootSourceOverrideEnabledistrue.
Supportedvalues:"None"-Bootfromthenormalbootdevice"Pxe"-BootfromthePre-BootEXecution(PXE)environment"Hdd"-BootfromaharddrivePATCH/redfish/v1/Nodes/Node1Content-Type:application/json{"Boot":{"BootSourceOverrideEnabled":"Once","BootSourceOverrideTarget":"Pxe"}}Response:HTTP/1.
1204NoContentPOSTResetActionRequest:POST/redfish/v1/Nodes/1/Actions/ComposedNode.
ResetContent-Type:application/json{"ResetType":"On"}Response:HTTP/1.
1204NoContentAssembleactionRequest:POST/redfish/v1/Nodes/1/Actions/ComposedNode.
AssembleResponse:HTTP/1.
1204NoContentDELETEUpondeletion(disassembly)ofComposedNodeseveralactionsareperformed:GracefulshutdownrequestissenttoComputerSystem.
AllVLANs(exceptforreservedones–seeReservedVLANs)areremovedfromassociatedEthernetswitchportsassociatedwithComputerSystem'sEthernetInterfaces.
ComputerSystemisdeallocated.
RemoteTargetisdeallocated(whenusedincomposition).
Request:DELETE/redfish/v1/Nodes/1PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201644IntelConfidentialDocumentNumber:332869-005Response:HTTP/1.
1204NoContentPSMEresourcesPodMaggregatesandexposesPSMEresourcessuchas:ComputerSystemProcessorDimmConfigMemoryChunkStorageAdapterDevice(storage)NetworkInterfaceVLAN(PODMonlysupportsGEToperationsonthatresource.
Creating/removingVLANsisdoneautomaticallyduringassemblyprocess.
)ManagerEthernetSwitchSwitchPortEventService–notimplementedincurrentreleaseEventSubscription–notimplementedincurrentreleaseEvent–notimplementedincurrentreleaseForaboveresourcesseePSMEAPISpecification.
StorageServicesresourcesPodMaggregatesandexposesStorageServicesresourcessuchas:StorageServiceRemoteTargetLogicalDrivePhysicalDriveFortheaboveresourcesseeStorageServicesspecification.
SimpleStoragecollectionTable24SimplestoragecollectionattributesNameSimplestorageTypeURI/redfish/v1/Systems/System1/SimpleStorageAttributeTypeRequiredDescriptionNameStringYesNameofcollectionMembers@odata.
countNumberNoCollectionmemberscountMembersArrayNoContainsthemembersofthiscollection.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential45OperationsGETRequest:GET/redfish/v1/Systems/System1/SimpleStorageContent-Type:application/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#SimpleStorageCollection.
SimpleStorageCollection","@odata.
id":"/redfish/v1/Systems/System1/SimpleStorage","@odata.
type":"#SimpleStorageCollection.
SimpleStorageCollection","Name":"SimpleStorageCollection","Members@odata.
count":1,"Members":[{"@odata.
id":"/redfish/v1/Systems/System1/SimpleStorage/Storage1"}]}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
SimplestorageSimplestoragedevicesassociatedwiththissystem.
Table25SimplestorageattributesNameSimplestorageTypeURI/redfish/v1/Systems/System1/SimpleStorage/{chassisId}AttributeTypeRedfishRequiredIntelRackScaleDesignRequiredNullableDescriptionIdStringNoNoResourceidentifierNameStringYesNoNameofservicerootDescriptionNoProvidesadescriptionofthisresourceandisusedforcommonalityintheschemadefinitionsUefiDevicePathStringNoTheUEFIdevicepathusedtoaccessthisstoragecontroller.
PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerAPISpecificationSeptember201646IntelConfidentialDocumentNumber:332869-005DevicesObjectNoNoThestoragedevicesassociatedwiththisresourceAttributeTypeRequiredDescriptionNameStringNoThenameoftheresourceManufacturerString,nullNoThenameofthemanufacturerofthisdeviceModelString,nullNoTheproductmodelnumberofthisdeviceStatusObject,nullNoSeechapter5.
1forstatusofresource.
CapacityBytesNumber,nullNoThesizeofthestoragedeviceOemObjectNoOemdefinedobjectStatusObjectNoSeechapter5.
1forstatusofresource.
OemObjectNoOemextensionobjectOperationsGETRequest:GET/redfish/v1/Systems/System1/SimpleStorage/Storage1Content-Type:applicaton/jsonResponse:{"@odata.
context":"/redfish/v1/$metadata#SimpleStorage.
SimpleStorage","@odata.
id":"/redfish/v1/Systems/System1/SimpleStorage/Storage1","@odata.
type":"#SimpleStorage.
1.
1.
0.
SimpleStorage","Id":"Storage1","Name":"SimpleStorageController","Description":"SystemSATA","UEFIDevicePath":"UEFIDevicePath","Status":{"State":"Enabled","Health":"OK","HealthRollup":"OK"},"Devices":[{"Name":"Drive1","Manufacturer":"ACME","Model":"DriveModelstring","CapacityBytes":322122547200,"Status":{"State":"Enabled",PODMRESTAPIDefinitionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential47"Health":"OK"}},{"Name":"Drive2","Manufacturer":"SuperDuperSSD","Model":"DriveModelstring","CapacityBytes":68719476736,"Status":{"State":"Enabled","Health":"OK"}},{"Name":"Drive3","Status":{"State":"Absent"}},{"Name":"Drive4","Status":{"State":"Absent"}}]}PUTOperationisnotallowedonthisresource.
PATCHOperationisnotallowedonthisresource.
POSTOperationisnotallowedonthisresource.
DELETEOperationisnotallowedonthisresource.
CommonPropertyDescriptionIntelRackScaleDesignPodManagerAPISpecificationSeptember201648IntelConfidentialDocumentNumber:332869-005StatusAttributeTypeNullableDescriptionStateStringYesThisindicatestheknownstateoftheresource,suchasifitisenabled.
Allowedvalues:Seechapter5.
1.
HealthStringYesThisrepresentsthehealthstateofthisresourceintheabsenceofitsdependentresources.
Allowedvalues:Seechapter5.
3.
HealthRollupStringYesThisrepresentstheoverallhealthstatefromtheviewofthisresource.
Allowedvalues:Seechapter5.
3.
Status->StateEnabled:ThisfunctionorresourcehasbeenenabledDisabled:ThisfunctionorresourcehasbeendisabledStandbyOffline:Thisfunctionorresourceisenabled,butawaitinganexternalactiontoactivateitInTest:ThisfunctionorresourceisundergoingtestingStarting:ThisfunctionorresourceisstartingAbsent:ThisfunctionorresourceisnotinstalledUnavailableOffline-ThisfunctionorresourceispresentbutcannotbeusedStandbySpare-ThisfunctionorresourceispartofaredundancysetandisawaitingafailoverorotherexternalactiontoactivateitStatus->HealthOK:NormalWarning:AconditionexiststhatrequiresattentionCritical:AcriticalconditionexiststhatrequiresimmediateattentionComputerSystem.
ResetOn:TurnthesystemonForceOff:Turnthesystemoffimmediately(nongraceful)shutdownGracefulRestart:PerformagracefulsystemshutdownfollowedbyarestartofthesystemForceRestart:Performanimmediate(non-graceful)shutdown,followedbyarestartofthesystemNmi:GenerateanonmaskableinterrupttocauseanimmediatesystemhaltForceOn:TurnthesystemonimmediatelyPushPowerButton:SimulatethepressingofthephysicalpowerbuttononthissystemBootSourceOverrideTarget/SupportedNone:BootfromthenormalbootdevicePxe:Bootfromtheprebootexecution(PXE)environmentFloppy:BootfromthefloppydiskdriveCd:BootfromtheCD/DVDdiscUsb:BootfromaUSBdeviceasspecifiedbythesystemBIOSHdd:BootfromaharddriveCommonPropertyDescriptionIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential49BiosSetup-BoottotheBIOSSetupUtilityUtilities:Bootthemanufacturer'sUtilitiesprogramsDiags:Bootthemanufacturer'sDiagnosticsprogramUefiShell:BoottotheUEFIShellUefiTarget:BoottotheUEFIDevicespecifiedintheUefiTargetBootSourceOverridepropertyAppendixIntelRackScaleDesignPodManagerAPISpecificationSeptember201650IntelConfidentialDocumentNumber:332869-005CreatingnewComposedNode-explanationCreatingComposedNodeusingJSONtemplateTocreateaComposedNodeusingPodManagerRESTAPI,itisnecessarytocreateaJSONtemplatedescribingrequestedresources.
ItneedstobesuppliedtoPodManagerbyperformingaHTTPPOSTrequestonComposedNodeCollectionActionURIlocatedat"/redfish/v1/Nodes/Actions/Allocate"onPodManagerservice.
TheJSONtemplatemaycontainvariousdetailsofresourcestobeusedinComposedNode.
AllJSONtemplateelementsareoptional,buteachrequirementshouldbecoherentitself.
ItispossibletosupplyPodManagerwithaJSONtemplatecontainingnospecificrequirements(e.
g.
{}–apairofemptycurlybracesinHTTPrequestbody)thusallowingPodManagertoproposeaComposedNodecontainingresourceschosenarbitrarilybyPodManager.
SpecifyingrequirementsforaComposedNodeTheJSONtemplatecontainsrequirementsforasingleComposedNode.
Basiccustomizationcoverssettinga"Name"and"Description"ofsuchSystem(bothbeingoftypeString).
As"Name"parameterisrequiredbyRedfishforallresources,ifit'snotsupportedPodManagerwilluseadefaultname.
TheexamplebelowwillallocateasingleComposedNodewithrequestednameanddescription:{"Name":"CustomizedComposedNodename","Description":"DescriptionofacustomizedComposedNode"}TheJSONtemplatemaycontainrequirementsfor:Processors,Memory,RemoteDrives,LocalDrivesandEthernetInterfaces.
Tospecifyrequirementsforthoseresources,apropersectionmustappearintheJSONtemplate.
GeneralassumptionsforallocationRequirementsaretreatedasaminimalrequiredvalue,sotheresultingComposedNodemayhavebetterparametersthanrequested.
ComposedNodecustomizationandresourcecustomizationsectionsdescribedbelowcanbeusedjointly.
Eachresourcetypedescriptionhasanassociatedtablewhichcontainsdetailsaboutspecificrequirements.
KeyistheJSONobjectfield.
JSONtypecontainsdatatypeasdefinedbyjson.
org,AllowedvaluescontainsadditionalrestrictionstoJSONtypeorhints(e.
g.
forenumerationsorBooleanvalues),Nullableindicatesifanullvaluecanbepassedforaspecifiedkey.
Notes,limitationsprovideadditionalhintsaboutaspecificrequirement.
LocationrequirementsProcessor,Memory,LocalDriveandEthernetInterfacesectionsmaycontainResourceandChassisobjects.
ResourcemustcontainaPodManagerURI(presentedas"@odata.
id")ofdiscoveredresource(Processor'sURIinProcessorsection,URItoMemoryresourceinMemorysectionandsoon).
ChassismustcontainaPodManagerURIofdiscoveredChassisinwhichapplicableresourceswillbelookedfor.
SpecifyingprocessorrequirementsTheJSONtemplatemaycontainrequirementsformultipleProcessors.
TheexamplebelowspecifiesrequirementsforasingleProcessortobeusedinComposedNode.
{"Processors":[{AppendixIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential51"Model":"Multi-CoreIntel(R)Xeon(R)processor7xxxSeries","TotalCores":2,"AchievableSpeedMHz":3700,"InstructionSet":"x86-64","Oem":{"Brand":"X7"},"Resource":{"@odata.
id":"/redfish/v1/Systems/1/Processors/1"},"Chassis":{"@odata.
id":"/redfish/v1/Chassis/1"}}]}AttributeTypeAllowedvaluesNullableDescriptionModelStringYesStringrepresentingProcessormodel.
TotalCoresNumberYesPositiveintegervalueexpectedAchievableSpeedMHzNumberYesPositiveintegervalueexpectedInstructionSetString"x86","x86-64","IA-64","ARM-A32","ARM-A64","MIPS32","MIPS64","OEM"YesOneofallowed,enumeratedvaluesOemObjectYesOemBrandString"E3","E5","E7","X3","X5","X7","I3","I5","I7","Unknown"YesOneofallowed,enumeratedvaluesResourceObjectExactlocationofasingleProcessor.
YesSeeLocationrequirementssectionChassisObjectExactlocationofasinglechassis.
YesSeeLocationrequirementssectionAllocationassumptions:WhichProcessorswillmeetsuppliedrequirementslocatedonthesamecomputersystemasotherresourceswithexactmatchonModelwithexactmatchonBrandwithatleastTotalCoreswithatleastAchievableSpeedMHzwithexactmatchonInstructionSetSpecifyingmemoryrequirementsTheJSONtemplatemaycontainrequirementsformultipleMemoryModules.
TheexamplebelowspecifiesrequirementsforasingleMemoryModuletobeusedinComposedNode.
{"Memory":[{"CapacityMiB":16000,"DimmDeviceType":"DDR3","SpeedMHz":1600,AppendixIntelRackScaleDesignPodManagerAPISpecificationSeptember201652IntelConfidentialDocumentNumber:332869-005"Manufacturer":"Intel","DataWidthBits":64,"Resource":{"@odata.
id":"/redfish/v1/Systems/1/DimmConfig/1"},"Chassis":{"@odata.
id":"/redfish/v1/Chassis/1"}}]}AttributeTypeAllowedvaluesNullableNotes,limitationsCapacityMiBNumberYesPositivevalueexpectedDimmDeviceTypeString"DDR","DDR2","DDR3","DDR4","DDR4_SDRAM","DDR4E_SDRAM","LPDDR4_SDRAM","DDR3_SDRAM","LPDDR3_SDRAM","DDR2_SDRAM","DDR2_SDRAM_FB_DIMM","DDR2_SDRAM_FB_DIMM_PROBE","DDR_SGRAM","DDR_SDRAM","ROM","SDRAM","EDO","FastPageMode","PipelinedNibble"YesOneofallowed,enumeratedvaluesSpeedMHzNumberYesPositiveintegervalueexpectedManufacturerStringYesStringrepresentingMemoryModulemanufacturernameDataWidthBitsNumberYesPositiveintegervalueexpected.
ResourceObjectExactlocationofasingleMemoryModule.
YesSeeLocationrequirementssectionChassisObjectExactlocationofasinglechassis.
YesSeeLocationrequirementssectionAllocationassumptions:WhichMemoryModules(representedbyDimmConfigresource)willmeetsuppliedrequirementslocatedonthesamecomputersystemasotherresourceswithexactmatchonDimmDeviceTypewithatleastSpeedMHzwithexactmatchonManufacturerwithatleastDataWidthBitsIfacomputersystemcontainsMemoryModulesoftotalsizeatleastCapacityMiB,itwillmeettherequirements.
SpecifyingRemoteDriverequirementsTheJSONtemplatemaycontainrequirementsformultipleRemoteDrives,butcurrentlyonlyonesetofrequirementsissupported.
TheexamplebelowspecifiesrequirementsforasingleRemoteDrivetobeusedinComposedNode.
{"RemoteDrives":[{"CapacityGiB":80,AppendixIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential53"iSCSIAddress":"iqn.
oem.
com:fedora21","Master":{"Type":"Snapshot","Resource":{"@odata.
id":"/redfish/v1/Services/1/LogicalDrives/1"}}}]}AttributeTypeAllowedvaluesNullableDescriptionCapacityGiBNumberYesPositivevalueexpected,requiredifMasterDrivesupplied.
ShouldbeatleastthesizeofLogicalDriveusedasMasterDrive.
iSCSIAddressStringNoRequired.
DefinesTargetIQNofRemoteTarget.
WhennoMasterDrivesupplied–itdefinesIQNofanexistingtarget.
OtherwisedefinesIQNtobesetfornewRemoteTarget(shouldbeuniqueinPodManager).
MasterObjectYesMasterTypeString"Snapshot","Clone"NoOneofallowed,enumeratedvalues.
RequiredifMasterDrivesuppliedMasterAddressObjectNoPodManagerURIofdiscoveredLogicalVolume.
RequiredifMasterDrivesupplied.
UsingexistingRemoteDriveTouseanexistingDriveitisnecessaryto:setiSCSIAddresstoTargetIQNofexistingtarget,donotprovideMaster,orsetittonull{"RemoteDrives":[{"iSCSIAddress":"iqn.
oem.
com:fedora21"}]}UsingaMasterDriveforfreshRemoteDrivecreationTouseafreshDrivecreatedfromMasterDriveitisnecessaryto:setCapacityGiBtodefinecapacityofthenewRemoteDrivethatisatleastofMasterDrive'ssize,setAddresstoIQNthatisuniqueinPodManagersetMasterTypeto"Snapshot"or"Clone"setMasterResourcetovalidPodManagerURIofLogicalDrivetobeusedassourceDrive{"RemoteDrives":[{"CapacityGiB":80,"iSCSIAddress":"iqn.
oem.
com:fedora21",AppendixIntelRackScaleDesignPodManagerAPISpecificationSeptember201654IntelConfidentialDocumentNumber:332869-005"Master":{"Type":"Snapshot","Resource":{"@odata.
id":"/redfish/v1/Services/1/LogicalDrives/1"}}}]}SpecifyingLocalDriverequirementsTheJSONtemplatemaycontainrequirementsformultipleLocalDrives(representedbyDeviceresourceunderSystemAdapters).
TheexamplebelowspecifiesrequirementsforasingleLocalDrivetobeusedinComposedNode.
{"LocalDrives":[{"CapacityGiB":100,"Type":"HDD","MinRPM":5400,"SerialNumber":"12345678","Interface":"SATA","Resource":{"@odata.
id":"/redfish/v1/Systems/1/Adapters/1/Devices/1"},"Chassis":{"@odata.
id":"/redfish/v1/Chassis/1"}}]}AttributeTypeAllowedvaluesNullableDescriptionCapacityGiBNumberYesPositivevalueexpectedTypeString"HDD","SSD",NVMe"YesOneofallowed,enumeratedvaluesMinRPMNumberYesPositiveintegervalueexpectedSerialNumberStringYesInterfaceString"PCIe","SAS","SATA"YesOneofallowed,enumeratedvaluesResourceObjectExactlocationofasingleDevice.
YesSeeLocationrequirementssectionChassisObjectExactlocationofasingleChassis.
YesSeeLocationrequirementssectionAllocationassumptions:WhichLocalDriveswillmeetsuppliedrequirementslocatedonthesamecomputersystemasotherresourceswithatleastCapacityGiBwithexactmatchonTypewithatleastMinRPMwithexactSerialNumberAppendixIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential55withexactInterfaceSpecifyingEthernetinterfacerequirementsTheJSONtemplatemaycontainrequirementsformultipleEthernetInterfaces.
TheexamplebelowspecifiesrequirementsforasingleEthernetInterfacetobeusedinComposedNode.
{"EthernetInterfaces":[{"SpeedMbps":1000,"PrimaryVLAN":100,"VLANs":[{"VLANId":100,"Tagged":false}],"Resource":{"@odata.
id":"/redfish/v1/Systems/1/EthernetInterfaces/1"},"Chassis":{"@odata.
id":"/redfish/v1/Chassis/1"}}]}AttributeTypeAllowedvaluesNullableDescriptionSpeedMbpsNumberYesPositiveintegervalueexpectedPrimaryVLANNumberYesPositiveintegervalueexpectedVLANsArray[Object]YesNullvaluewillbeinterpretedasabsenceofthiskey.
Emptyarray[]willclearallexistingvlans,excludingReservedVLANs.
VLANsVLANIdNumberNoPositiveintegervalueexpectedVLANsTaggedBooleantrue,falseNoBooleanvalueResourceObjectExactlocationofasingleEthernetInterface.
YesSeeLocationrequirementssectionChassisObjectExactlocationofasingleChassis.
YesSeeLocationrequirementssectionAllocationassumptions:WhichEthernetInterfaceswillmeetsuppliedrequirementslocatedonthesameComputerSystemasotherresourceswithatleastSpeedMbpsonesthatareconnectedwithSwitchPorts(whenVLANssectionisprovided)ReservedVLANsThereisapossibilitytorestrictusageofsomevlansbychangingtheconfigurationfilelocatedin/etc/pod-manager/allocation.
json.
Theexamplefilelookslike:{"ReservedVlanIds":[1,170,4088,4091,4094]AppendixIntelRackScaleDesignPodManagerAPISpecificationSeptember201656IntelConfidentialDocumentNumber:332869-005}Where1,170,4088,4091,4094areVLANswhicharereserved.
ReservedVLANshavethefollowingimplications:AllocationJSONcannotcontainsuchVLANsandsuchrequestsresultinanerrorReservedVLANsarenotdeletedduringallocationReservedVLANsarenotdeletedduringdisassemblyAllocationalgorithmNodecompositionstartswithanHTTPPOSTrequestofJSONtemplateon"/redfish/v1/Nodes/Actions/Allocate"ComposedNodeCollectionActionURIonPodManagerservice.
IftheJSONtemplateiswell-formedandcontainsasupportedsetofrequirements,theallocationprocessstarts.
Fourmajorscenariosarecurrentlysupported:AllocatingresourcesforComposedNodetobebootedfromaLocalDriveAllocatingresourcesforComposedNodetobebootedfromanexistingRemoteDriveAllocatingresourcesforComposedNodetobebootedfromaRemoteDrivethatneedtobecreatedAllocatingresourcesforComposedNodewithVLANrequirementsspecified.
ThisscenarioisusedwithoneoftheotherthreeTheallocationprocessisprecededbyageneralverificationofJSONtemplatethatchecksiftherequestednodecanberealizedbyavailableresourcesandconsistsof:SelectingandallocatingaComputerSystemthatcontainsresourcesmatchingtemplaterequirementsforProcessors,Memory,LocalDrivesandEthernetInterfaces.
SelectingorcreatingRemoteDrivetobeusedwithpreviouslyselectedComputerSystemandallocatingit.
DetailedprocessofselectingandallocatingaComputerSystemforaComposedNodeFindallComputerSystemsthatarenotyetallocated(notusedbyanyotherallocatedComposedNode)withStatusEnabledandHealthOKFilterComputerSystemsbyspecifiedResourceandChassis(ifsuppliedintemplate)FilterComputerSystemsbyProcessors:returnallComputerSystemsthatcontainatleasttherequestedquantityofProcessorsthatmeetrequirements(ifsuppliedintemplate):ExactlymatchingrequestedmodelExactlymatchingrequestedbrandWithatleastrequestednumberofcoresWithatleastrequestedfrequencyExactlymatchingrequestedinstructionsetFilterComputerSystemsbyMemory:returnallComputerSystemswithatleasttotalrequestedsizeofmemorylocatedonMemoryModulesthateachofthemmeetrequirements(ifsuppliedintemplate):MemoryofexactlyrequesteddimmdevicetypeWithatleastrequestedspeedMHzWithexactrequestedmanufacturerWithatleastrequesteddatawidthbitsFilterComputerSystemsbyLocalDrives:returnallComputerSystemsthatcontainforeachrequestedDriveonedistinctDevicemeetingrequirements(ifsuppliedintemplate):WithatleastrequestedcapacityspecifiedExactlymatchingrequestedDrivetypeWithatleastrequestedminRPMWithexactrequestedserialnumberWithexactInterfaceAppendixIntelRackScaleDesignPodManagerSeptember2016APISpecificationDocumentNumber:332869-005IntelConfidential57FilterComputerSystemsbyEthernetInterfaces:returnallComputerSystemsthatcontainforeachrequestedEthernetInterfaceonedistinctEthernetInterfacemeetingrequirements(ifsuppliedintemplate):WithatleastrequestedspeedIfVLANssectionisprovided,thenComputerSystemswithEthernetInterfaceswhicharenotconnectedwithEthernetSwitchPortsarefilteredout(asdescribedbelow)AfirstComputerSystemfromresultingfilteredcollectionisthenallocatedtobeusedinComposedNode.
Connectionbetweencomputersystem'sEthernetInterfaceandEthernetSwitchPortInordertoenableparticularVLANusageonComposedNode,thereisaneedtomapEthernetSwitchPortandComputerSystem'sEthernetinterface.
ThismappingisdoneusingtheMACaddressasanidentifier.
Fieldsusedforthismapping:NeighborMAConEthernetSwitchPortresourceMacAddressonEthernetInterfaceresourceIfthosetwopropertiescontainthesamevalue,ComputerSystem'sEthernetInterfaceandEthernetSwitchPortaretreatedasconnected.
OnlyComputerSystemswithEthernetInterfaceswhichareconnectedtoEthernetSwitchPortscouldbeusedinallocationwithspecifiedVLANsrequirement.
DetailedprocessofselectingRemoteDrivesDeterminewhattypeofRemoteDriveisrequestedWhenrequestingexistingRemoteDrive:FindallTargetsthatarenotyetallocated(notusedbyanyallocatedComposedNode)FindfirstTargetthatexactlymatchesrequestedIQNandallocatesittobeusedinComposedNodeWhenrequestinganewRemoteDriveCheckifTargetdoesnotexistwithrequestedIQNtobesetfornewlycreatedtargetCheckifLogicalDriverequestedasMasterDriveexistsonStorageServicehandledbyPodManager,andselectthisStorageServicetohandlenewTargetcreationFindallLogicalVolumeGroupsmeetingrequirements:LocatedonselectedStorageServiceHavingfreespaceofatleastrequestedcapacityforanewRemoteDriveAfirstLogicalVolumeGroupfromresultingfilteredcollectionisselectedasaplacementfornewLogicalVolume,whichwillbeexposedasanewTarget(RemoteDrive)AnewLogicalVolumeiscreatedonselectedLogicalVolumeGroup(asasnapshotorasaclone)AnewTargetiscreatedontopofnewlycreatedLogicalVolumeNewlycreatedTargetisallocatedtobeusedinComposedNodePost-allocationscenariosAComposedNodeiscreatedasnewRESTresourceat/redfish/v1/Nodes/{NodeId}whenaproperComputerSystemwasfoundandwassuccessfullyallocated.
StateofComposedNodeissetto"Allocated".
An"Allocated"ComposedNodeisaPodManagerpropositionthatcanbeeitheracceptedorrejected.
Ifaccepted,userhastosendaHTTPPOSTrequestonComposedNode.
AssembleactionoftheproposedComposedNodetoassembleit:IfnoRemoteDrivewasrequested,aComposedNode'sstateissetto"PoweredOff".
WhenRemoteDriveisrequested,ComposedNoderemains"Assembling"untilTargetcreationfinishes.
WhenTargetissuccessfullyassembledtobeusedwiththeComposedNode,node'sstateissetto"PoweredOff"Assemblyprocessdoesn'tendwithsendingpoweronrequest,soit'snecessarytoperformComposedNode.
ResetactiontopoweronaComposedNodeafterassembly.
AppendixIntelRackScaleDesignPodManagerAPISpecificationSeptember201658IntelConfidentialDocumentNumber:332869-005Ifrejected,theusercancontinuesendingHTTPPOSTrequestsofJSONtemplateon/redfish/v1/Nodes/Actions/Allocatetocreatemoreproposalstopickfrom.
Whenfindingtherightpick,itisrecommendedtosendHTTPDELETEonallrejectedproposalsofComposedNodestofreetheresourcesallocatedbythem.