Add HostWatchdogTimer attribute in redfish

Add HostWatchdogTimer attribute in redfish

Based on redfish spec, add HostWatchdogTimer property in
redfish/v1/Systems/system.

This object describes the Host Watchdog Timer functionality,
including FunctionEnabled, Status and TimeoutActionproperties:
"HostWatchdogTimer": {
        "FunctionEnabled": false,
        "Status": {
            "State": "Enabled"
        },
        "TimeoutAction": "None"
    }

Tested:
Validator checking for HostWatchdogTimer in below test cases:
  Set different timeout actions reset|poweroff|cycle|none:
  ipmitool mc watchdog set action=reset timeout=1000 int=msg use=oem
  Start watchdog: ipmitool mc watchdog reset

ComputerSystem.v1_5_0.ComputerSystem:HostWatchdogTimer
	value: OrderedDict([('FunctionEnabled', False),
	('Status', OrderedDict([('State', 'Enabled')])),
	('TimeoutAction', 'None')]) <class 'collections.OrderedDict'>
	has Type: ComputerSystem.v1_5_0.WatchdogTimer complex
	is Optional
	***going into Complex
ComputerSystem.v1_5_0.WatchdogTimer:FunctionEnabled
	value: False <class 'bool'>
	has Type: Edm.Boolean Edm.Boolean
	Mandatory Test: OK
	permission OData.Permission/ReadWrite
	Success
ComputerSystem.v1_5_0.WatchdogTimer:WarningAction
	value: n/a <class 'str'>
	has Type: ComputerSystem.v1_5_0.WatchdogWarningActions enum
	is Optional
	prop Does not exist, skip...
ComputerSystem.v1_5_0.WatchdogTimer:TimeoutAction
	value: None <class 'str'>
	has Type: ComputerSystem.v1_5_0.WatchdogTimeoutActions enum
	Mandatory Test: OK
	permission OData.Permission/ReadWrite
	Success
ComputerSystem.v1_5_0.WatchdogTimer:Status
	value: OrderedDict([('State', 'Enabled')])
	<class 'collections.OrderedDict'>
	has Type: Resource.Status complex
	is Optional
	***going into Complex
Resource.Status:State
	value: Enabled <class 'str'>
	has Type: Resource.State enum
	is Optional
	permission OData.Permission/Read
	Success

HostWatchdogTimer.FunctionEnabled                        PASS
HostWatchdogTimer.WarningAction                      Optional
HostWatchdogTimer.TimeoutAction                          PASS
HostWatchdogTimer.Status                             complex
HostWatchdogTimer.Status.State                           PASS

Watchdog service is stopped, no such property in redfish

Change-Id: I883e4b739a3fe525080ed486d2ca8e461fddf212
Signed-off-by: Yong Li <yong.b.li@linux.intel.com>
1 file changed
tree: fa8e06d1151ea3769073cd2ebd37b07cff95fd58
  1. cmake/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. .clang-format
  9. .gitignore
  10. bmcweb.service.in
  11. bmcweb.socket
  12. build_x86.sh
  13. cmake-format.json
  14. CMakeLists.txt
  15. CMakeLists.txt.in
  16. DEVELOPING.md
  17. JenkinsFile
  18. LICENCE
  19. MAINTAINERS
  20. pam-webserver
  21. README.md
  22. 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 prime256v1 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.