Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / f92af38923c3651d5def0cc60abd5ed2f802fbe7
commitf92af38923c3651d5def0cc60abd5ed2f802fbe7[log] [tgz]
authorJayaprakash Mutyala <mutyalax.jayaprakash@intel.com>Tue Jun 16 23:29:41 2020 +0000
committerJayaprakash Mutyala <mutyalax.jayaprakash@intel.com>Wed Sep 02 04:42:37 2020 +0000
treed358f8480bddf67af47c8489fe52c2c30666934f
parent5b0de033d13a7d7e566477269dca6626fcd704be [diff]
Manager:Add ForceRestart to ResetType

Add ForceRestart in Action/#Manager.Reset/ResetType@AllowableValues,
as it is a mandatory parameter in the OCP Redfish Profile v1.0.

Tested:
1. Verified redfish validator passed
2. Verified details from Redfish
GET: https://<BMC-IP>/redfish/v1/Managers/bmc/ResetActionInfo
Response:
{
  "@odata.id": "/redfish/v1/Managers/bmc/ResetActionInfo",
  "@odata.type": "#ActionInfo.v1_1_2.ActionInfo",
  "Id": "ResetActionInfo",
  "Name": "Reset Action Info",
  "Parameters": [
    {
      "AllowableValues": [
        "GracefulRestart",
        "ForceRestart"
      ],
      "DataType": "String",
      "Name": "ResetType",
      "Required": true
    }
  ]
}

Case 1: ForceRestart:
POST: https://<BMC-IP>/redfish/v1/Managers/bmc/Actions/Manager.Reset
Body:
{
  "ResetType": "ForceRestart"
}
Response:
{
  "@Message.ExtendedInfo": [
    {
      "@odata.type": "#Message.v1_0_0.Message",
      "Message": "Successfully Completed Request",
      "MessageArgs": [],
      "MessageId": "Base.1.4.0.Success",
      "Resolution": "None",
      "Severity": "OK"
    }
  ]
}
Case 2: GracefulRestart:
POST: https://<BMC-IP>/redfish/v1/Managers/bmc/Actions/Manager.Reset
Body:
{
  "ResetType": "GracefulRestart"
}
Response: Success

Case 3: Negative test case
POST: https://<BMC-IP>/redfish/v1/Managers/bmc/Actions/Manager.Reset
Body:
{
  "ResetType": "Test1"
}
Response:
{
  "error": {
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The parameter Test1 for the action ResetType is not
                    supported on the target resource.",
        "MessageArgs": [
          "Test1",
          "ResetType"
        ],
        "MessageId": "Base.1.4.0.ActionParameterNotSupported",
        "Resolution": "Remove the parameter supplied and resubmit the
                       request if the operation failed.",
        "Severity": "Warning"
      }
    "code": "Base.1.4.0.ActionParameterNotSupported",
    "message": "The parameter Test1 for the action ResetType is not
                supported on the target resource."
  }
}

Signed-off-by: Jayaprakash Mutyala <mutyalax.jayaprakash@intel.com>
Change-Id: I84f4942ddabc564a267d7db8e582ad8c11b5399b
1 file changed
tree: d358f8480bddf67af47c8489fe52c2c30666934f
  1. cmake/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. .clang-format
  9. .dockerignore
  10. .gitignore
  11. bmcweb.service.in
  12. bmcweb.socket
  13. build_x86.sh
  14. build_x86_docker.sh
  15. cmake-format.json
  16. CMakeLists.txt
  17. CMakeLists.txt.in
  18. COMMON_ERRORS.md
  19. config.h.in
  20. DEVELOPING.md
  21. Dockerfile
  22. Dockerfile.base
  23. JenkinsFile
  24. LICENCE
  25. MAINTAINERS
  26. pam-webserver
  27. README.md
  28. Redfish.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for openbmc.

Capabilities

At this time, the webserver implements a few interfaces:

  • Authentication middleware that supports cookie and token based authentication, as well as CSRF prevention backed by linux PAM authentication credentials.
  • An (incomplete) attempt at replicating phosphor-dbus-rest interfaces in C++. Right now, a few of the endpoint definitions work as expected, but there is still a lot of work to be done. The portions of the interface that are functional are designed to work correctly for phosphor-webui, but may not yet be complete.
  • Replication of the rest-dbus backend interfaces to allow bmc debug to logged in users.
  • An initial attempt at a read-only redfish interface. Currently the redfish interface targets ServiceRoot, SessionService, AccountService, Roles, and ManagersService. Some functionality here has been shimmed to make development possible. For example, there exists only a single user role.
  • SSL key generation at runtime. See the configuration section for details.
  • Static file hosting. Currently, static files are hosted from the fixed location at /usr/share/www. This is intended to allow loose coupling with yocto projects, and allow overriding static files at build time.
  • Dbus-monitor over websocket. A generic endpoint that allows UIs to open a websocket and register for notification of events to avoid polling in single page applications. (this interface may be modified in the future due to security concerns.

Configuration

BMCWeb is configured by setting -D flags that correspond to options in bmcweb/CMakeLists.txt and then compiling. For example, cmake -DBMCWEB_ENABLE_KVM=NO ... followed by make. The option names become C++ preprocessor symbols that control which code is compiled into the program.

When BMCWeb starts running, it reads persistent configuration data (such as UUID and session data) from a local file. If this is not usable, it generates a new configuration.

When BMCWeb SSL support is enabled and a usable certificate is not found, it will generate a self-sign a certificate before launching the server. The keys are generated by the secp384r1 algorithm. The certificate

  • is issued by C=US, O=OpenBMC, CN=testhost,
  • is valid for 10 years,
  • has a random serial number, and
  • is signed using the SHA-256 algorithm.