summaryrefslogtreecommitdiff
path: root/Redfish.md
AgeCommit message (Collapse)AuthorFilesLines
2019-12-16Update redfish-logging-in-bmcweb.md linkGunnar Mills1-1/+1
redfish-logging-in-bmcweb.md is moving under architecture/ as part of https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/27960 27960 should merge before this is merged. Change-Id: I761c6ad49d1838160371c46d8503b2e33d6bad4c Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2019-10-22Renamed User role name to ReadOnlyAppaRao Puli1-3/+3
As per redfish specification (DSP0266), there are set of predefined privilege roles. In OpenBMC code has "User" as role name instead of "ReadOnly". So corrected the same. Updated Redfish.md accordingly. Spec says: Role Name = "ReadOnly" ▪ AssignedPrivileges = Login, ConfigureSelf Tested: - Role collection shows new role. - GET on /redfish/v1/AccountService/Roles/ReadOnly URI shows correct AssignedPrivileges. - Ran negative test with /redfish/v1/AccountService/Roles/User and observed error(404 - Not Found). - Ran Redfish validator and no new issues observed. Signed-off-by: AppaRao Puli <apparao.puli@linux.intel.com> Change-Id: I7b0132c628fb4950b6ec095269cd1a12e92aea9a
2019-08-30Redfish.md: Fill out Service RootGunnar Mills1-1/+8
curl -k https://${bmc}/redfish/v1/ { "@odata.context": "/redfish/v1/$metadata#ServiceRoot.ServiceRoot", "@odata.id": "/redfish/v1", "@odata.type": "#ServiceRoot.v1_5_0.ServiceRoot", "AccountService": { "@odata.id": "/redfish/v1/AccountService" }, "CertificateService": { "@odata.id": "/redfish/v1/CertificateService" }, "Chassis": { "@odata.id": "/redfish/v1/Chassis" }, "Id": "RootService", "JsonSchemas": { "@odata.id": "/redfish/v1/JsonSchemas" }, "Links": { "Sessions": { "@odata.id": "/redfish/v1/SessionService/Sessions" } }, "Managers": { "@odata.id": "/redfish/v1/Managers" }, "Name": "Root Service", "RedfishVersion": "1.6.1", "Registries": { "@odata.id": "/redfish/v1/Registries" }, "SessionService": { "@odata.id": "/redfish/v1/SessionService" }, "Systems": { "@odata.id": "/redfish/v1/Systems" }, "UUID": "fd4374f1-e080-4a1e-84ae-79871bf954e6", "UpdateService": { "@odata.id": "/redfish/v1/UpdateService" } Change-Id: I672f1559a8d5a48fcb275e8371b9c4243c8beb4e Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2019-08-29Redfish.md: Move to standard paths for resourcesGunnar Mills1-24/+25
Had a mix of <> and {} for the path of the resource. Moved to the path defined in the Redfish schema. https://redfish.dmtf.org/redfish/schema_index E.g. /redfish/v1/AccountService/Accounts/{ManagerAccountId} from https://redfish.dmtf.org/schemas/v1/ManagerAccount_v1.xml Corrected a few schemas which were incorrect. <> does not work since markdown thinks this is an HTML tag. https://github.com/openbmc/bmcweb/blob/master/Redfish.md#redfishv1chassispowerpowersupplies Change-Id: I3434952a8adf1a1221f070c04c8c0752e9077a5d Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2019-08-29Redfish.md: FirmwareInventoryGunnar Mills1-2/+3
curl -k https://${bmc}/redfish/v1/UpdateService/FirmwareInventory/9f75c5ad { "@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory", "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/9f75c5ad", "@odata.type": "#SoftwareInventory.v1_1_0.SoftwareInventory", ... Change-Id: Iaaaa9f3356a16cc5a236c9e75644bb25d7545a05 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2019-08-29Redfish.md: Replace {SystemName} with systemGunnar Mills1-12/+12
curl -k https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog { "@odata.context": "/redfish/v1/$metadata#LogService.LogService", "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog", ... Change-Id: I7bf85fdb4f46a256982a1ac60bdc8f5fecbad74a Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2019-08-29Redfish.md: Correct bmc Manager capitalizationGunnar Mills1-7/+7
curl -k https://${bmc}/redfish/v1/Managers/BMC/EthernetInterfaces Not Found curl -k https://${bmc}/redfish/v1/Managers/bmc/EthernetInterfaces { "@odata.context": "/redfish/v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection", "@odata.id": "/redfish/v1/Managers/bmc/EthernetInterfaces", "@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection", ... Change-Id: Id227e09ad7f596c01dd2e73b476c1b87582a00fa Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2019-07-31redfish-doc: Add details on EventLog implementationsAndrew Geissler1-0/+36
Was struggling a bit reviewing the code and options in the LogServices area so wrote this up quickly. The main goal being to give a brief overview and link to some documentation to help with reviewing the options. Change-Id: I337490157ffdb188be812031311694f6cb83b8fa Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
2019-07-18redfish-doc: Move Redfish doc to its own fileAndrew Geissler1-0/+462
Redfish support has been growing exponentially within bmcweb. Lets get a separate document for it all. Change-Id: Ibe895c7ab4bf4d2e1d51fce7136c0a6f8ca4119d Signed-off-by: Andrew Geissler <geissonator@yahoo.com>