obmcutil: Add recoverystatus option

It is desired to know a systems current recovery status during any
issue debug. Hence a new option is added to obmcutil command to know the
recovery status.

Fixe

obmcutil: Add recoverystatus option

It is desired to know a systems current recovery status during any
issue debug. Hence a new option is added to obmcutil command to know the
recovery status.

Fixes openbmc/phosphor-state-manager#26

Tested: Set individual settings to On/Off and then verified that
the overall recovery status shows On/Off/Undefined as intended.

Sample output:

recovery: Off
hostReboot : Off
bmcReboot : Off
hostTimeout: Off
hostCrash : Off

Change-Id: Ib66a4fa6d0baa288aa2119d31f782c71f35901e4
Signed-off-by: Anusha Dathatri <anusha.dathatri@gmail.com>

show more ...

obmcutil: correct new shellcheck warnings

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: Icbbe5680ef3c95aa3fea6aa5048b4e4524c8e7fa

beautysh: re-format

beautysh is enabled in the openbmc-build-scripts on Bash/Zsh/POSIX-sh
files to have a consistent formatting. Re-run the formatter on the
whole repository.

Signed-off-by: Patric

beautysh: re-format

beautysh is enabled in the openbmc-build-scripts on Bash/Zsh/POSIX-sh
files to have a consistent formatting. Re-run the formatter on the
whole repository.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I8c4f46426087652161d7cbeab489bfe32d25f17e

show more ...

obmcutil: add a positional argument to select instance id

add a positional argument to select instance id:

-i,--id instance id, default 0

Tested on Bletchley:

[Host1 Power On]
root@bletchley:~

obmcutil: add a positional argument to select instance id

add a positional argument to select instance id:

-i,--id instance id, default 0

Tested on Bletchley:

[Host1 Power On]
root@bletchley:~# obmcutil --id=1 poweron
root@bletchley:~# obmcutil --id=1 hoststate
CurrentHostState : xyz.openbmc_project.State.Host.HostState.Running
root@bletchley:~# obmcutil --id=1 chassisstate
CurrentPowerState : xyz.openbmc_project.State.Chassis.PowerState.On
root@bletchley:~# obmcutil --id=1 state
CurrentBMCState : xyz.openbmc_project.State.BMC.BMCState.Ready
CurrentPowerState : xyz.openbmc_project.State.Chassis.PowerState.On
CurrentHostState : xyz.openbmc_project.State.Host.HostState.Running
BootProgress : xyz.openbmc_project.State.Boot.Progress.ProgressStages.Unspecified
OperatingSystemState: xyz.openbmc_project.State.OperatingSystem.Status.OSStatus.Inactive

[Host1 Power Off]
root@bletchley:~# obmcutil --id=1 poweroff
root@bletchley:~# obmcutil --id=1 hoststate
CurrentHostState : xyz.openbmc_project.State.Host.HostState.Off
root@bletchley:~# obmcutil --id=1 chassisstate
CurrentPowerState : xyz.openbmc_project.State.Chassis.PowerState.Off
root@bletchley:~# obmcutil --id=1 state
CurrentBMCState : xyz.openbmc_project.State.BMC.BMCState.Ready
CurrentPowerState : xyz.openbmc_project.State.Chassis.PowerState.Off
CurrentHostState : xyz.openbmc_project.State.Host.HostState.Off
BootProgress : xyz.openbmc_project.State.Boot.Progress.ProgressStages.Unspecified
OperatingSystemState: xyz.openbmc_project.State.OperatingSystem.Status.OSStatus.Inactive

Signed-off-by: Potin Lai <potin.lai@quantatw.com>
Change-Id: I39688f762dc3d6c764c3631716298a9d2b35e176

show more ...

obmcutil: option to stop power off targets

As noted in the previous commit, IBM has a use case to be able to stop
the openbmc host stop and power off targets to ensure a proper power off
when utiliz

obmcutil: option to stop power off targets

As noted in the previous commit, IBM has a use case to be able to stop
the openbmc host stop and power off targets to ensure a proper power off
when utilizing tools outside of phosphor-state-manager to boot a system.

I went back and forth between putting this in a separate script, or even
in a IBM-specific repository but there doesn't seem to be any obvious
reason to not just put this in obmcutil. If some other company comes
upon a similar use case then they will have everything they need to
solve the power off scenario.

Tested:
- Verified new obmcutil command runs without error
- Ran new obmcutil command after istep boot and verified power off was
correctly synchronized

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: I0fd2c45181128e0d7a20244b2ecf5968d02e81c3

show more ...

obmcutil: fix shellcheck issues

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ic6f112cb3a32b22f06dcb09c0dfccab72bb9f41e

autoreboot: add one-time support to obmcutil

Since this is a one-time property and is cleared on a host stop, no need
to provide an option to set it back to true in obmcutil.

Te

autoreboot: add one-time support to obmcutil

Since this is a one-time property and is cleared on a host stop, no need
to provide an option to set it back to true in obmcutil.

Tested:
root@witherspoon:/lib/systemd/system# obmcutil hostrebootoffonetime
root@witherspoon:/lib/systemd/system# busctl get-property xyz.openbmc_project.Settings /xyz/openbmc_project/control/host0/auto_reboot/one_time xyz.openbmc_project.Control.Boot.RebootPolicy AutoReboot
b false

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: I8a18bd60bde038825344120b94c1ab327900ae41

show more ...

obmcutil: fix optional param regression

When adding support for "showlog", it regressed the support for the
optional parameters. That new option required all of the command line
para

obmcutil: fix optional param regression

When adding support for "showlog", it regressed the support for the
optional parameters. That new option required all of the command line
parameters be passed on to handle_cmd().

handle_cmd() does not handle optional parameters though. Add some logic
to shift the optional parameters out before calling handle_cmd().

Tested:
Verified -v and -w/--wait now work as expected

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: I81a66bdf32cab5f13f6acf0cabd5dca267029353

show more ...

logs: provide option to delete all logs

Tested:
root@witherspoon:~# obmcutil listlogs
{
"type" : "as",
"data" : [
[

logs: provide option to delete all logs

Tested:
root@witherspoon:~# obmcutil listlogs
{
"type" : "as",
"data" : [
[
"/xyz/openbmc_project/logging/entry/1",
"/xyz/openbmc_project/logging/entry/2",
"/xyz/openbmc_project/logging/entry/3",
"/xyz/openbmc_project/logging/entry/4",
]
]
}
root@witherspoon:~# obmcutil deletelogs
root@witherspoon:~# obmcutil listlogs
{
"type" : "as",
"data" : [
[]
]
}

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: Ifd9b0222515bf95d831e09cbf91784452cbd1b7e

show more ...

logs: provide option to display log

This is a very basic display that just dumps the formatted json data of
the xyz.openbmc_project.Logging.Entry interface. There is much more that
c

logs: provide option to display log

This is a very basic display that just dumps the formatted json data of
the xyz.openbmc_project.Logging.Entry interface. There is much more that
could be done here but this is 100% more then what we have and could be
built upon later if found useful.

Tested:
root@witherspoon:~# obmcutil showlog /xyz/openbmc_project/logging/entry/54
{
"type" : "a{sv}",
"data" : [
{
"Id" : {
"type" : "u",
"data" : 54
},
"Timestamp" : {
"type" : "t",
"data" : 1589483560788
},
"Severity" : {
"type" : "s",
"data" : "xyz.openbmc_project.Logging.Entry.Level.Error"
},
"Message" : {
"type" : "s",
"data" : "xyz.openbmc_project.Common.Error.Timeout"
},
"AdditionalData" : {
"type" : "as",
"data" : [
"CALLOUT_INVENTORY_PATH=/xyz/openbmc_project/inventory/system/chassis/motherboard",
"TIMEOUT_IN_MSEC=5"
]
},
"Resolved" : {
"type" : "b",
"data" : false
},
"UpdateTimestamp" : {
"type" : "t",
"data" : 1589483560788
}
}
]
}

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: I1f47093ec3b24fd21bbf7c693a2e89bdf83feeda

show more ...

logs: add option to list logging entries

Remembering the busctl commands is a bit onerous so provide a wrapper
to quickly see the logging entries in the system

Tested:
root@

logs: add option to list logging entries

Remembering the busctl commands is a bit onerous so provide a wrapper
to quickly see the logging entries in the system

Tested:
root@witherspoon:~# obmcutil listlogs
{
"type" : "as",
"data" : [
[
"/xyz/openbmc_project/logging/entry/1",
"/xyz/openbmc_project/logging/entry/2",
"/xyz/openbmc_project/logging/entry/3",
"/xyz/openbmc_project/logging/entry/4",
]
]
}

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: Ib1e4bb45c20ea487b64b59a8b440f35e0732ce72

show more ...

boot-block: inform user if blocking error present

If a boot blocking error is present then be sure the user is notified
when try a boot operation.

Tested:
root@witherspoon:~

boot-block: inform user if blocking error present

If a boot blocking error is present then be sure the user is notified
when try a boot operation.

Tested:
root@witherspoon:~# obmcutil poweron
!!!!!!!!!!
WARNING! System has blocking errors that will prevent boot
Blocking Error: /xyz/openbmc_project/logging/entry/21
Blocking Error: /xyz/openbmc_project/logging/entry/24
!!!!!!!!!!

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: Id856c809e4cd6b6d0621d682d29aec8d72f4b563

show more ...

boot-block: add option to query blocking errors

Being able to easily see if any blocking errors are present in the
system is a useful feature. A future commit will use this new interface

boot-block: add option to query blocking errors

Being able to easily see if any blocking errors are present in the
system is a useful feature. A future commit will use this new interface
to tell the user if any blocking errors are present when they request a
boot of the system.

See the following design for more details:
https://github.com/openbmc/docs/blob/master/designs/fail-boot-on-hw-error.md

Tested:
- Verify blocking errors are printed
root@witherspoon:~# obmcutil bootblock
Blocking Error: /xyz/openbmc_project/logging/entry/19
Blocking Error: /xyz/openbmc_project/logging/entry/20

- Verify after resolving them, they are not printed
root@witherspoon:~# busctl set-property xyz.openbmc_project.Logging /xyz/openbmc_project/logging/entry/19 xyz.openbmc_project.Logging.Entry Resolved b 1
root@witherspoon:~# busctl set-property xyz.openbmc_project.Logging /xyz/openbmc_project/logging/entry/20 xyz.openbmc_project.Logging.Entry Resolved b 1
root@witherspoon:~# obmcutil bootblock
No blocking errors present

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: I25e9a398a914372a4f051ad2034f2945c776901e

show more ...

Add support for bmcrebootoff and bmcrebooton

In the view of having the system available in fail state, it would be a
necessity to have BMC stay in error state and not take reset due to a

Add support for bmcrebootoff and bmcrebooton

In the view of having the system available in fail state, it would be a
necessity to have BMC stay in error state and not take reset due to any
recovery policy that is specified in the service files. This patch puts the
override for reboot, poweroff and halt requests to make those, a NO-OP

If the user needs to reboot the BMC, then "bmcrebooton" must be executed prior
to doing the reset.

Tested:

root@witherspoon:/tmp# cd /run/systemd/system/
root@witherspoon:/run/systemd/system# ls

root@witherspoon:/run/systemd/system# /tmp/obmcutil bmcrebootoff

root@witherspoon:/run/systemd/system# ls -l
drwxr-xr-x 2 root root 60 Nov 13 08:32 halt.target.d
drwxr-xr-x 2 root root 60 Nov 13 08:32 poweroff.target.d
drwxr-xr-x 2 root root 60 Nov 13 08:32 reboot.target.d
------------------------------------------------------------------

root@witherspoon:/run/systemd/system# uptime
08:33:41 up 2:19, load average: 0.33, 0.40, 0.31

root@witherspoon:/run/systemd/system# reboot

root@witherspoon:/run/systemd/system# uptime
08:35:21 up 2:21, load average: 0.20, 0.31, 0.28

root@witherspoon:/run/systemd/system#
------------------------------------------------------------------
root@witherspoon:/run/systemd/system# halt

root@witherspoon:/run/systemd/system# uptime
08:40:16 up 2:26, load average: 0.23, 0.19, 0.23

root@witherspoon:/run/systemd/system#
-----------------------------------------------------------------
root@witherspoon:/run/systemd/system# /tmp/obmcutil bmcrebooton

root@witherspoon:/run/systemd/system# ls -l halt.target.d/*
ls: halt.target.d/*: No such file or directory

root@witherspoon:/run/systemd/system#
-----------------------------------------------------------------
root@witherspoon:/etc/systemd/system# /tmp/obmcutil recoveryoff
Created symlink /etc/systemd/system/obmc-host-timeout@0.target → /dev/null.
Created symlink /etc/systemd/system/obmc-host-crash@0.target → /dev/null.

root@witherspoon:/etc/systemd/system# ls -l /run/systemd/system/
halt.target.d/ poweroff.target.d/ reboot.target.d/

root@witherspoon:/etc/systemd/system# ls -l
/run/systemd/system/halt.target.d/reboot-guard.conf
-rw-r--r-- 1 root root 29 Nov 13 08:41
/run/systemd/system/halt.target.d/reboot-guard.conf
root@witherspoon:/etc/systemd/system#
-----------------------------------------------------------------
root@witherspoon:/etc/systemd/system# /tmp/obmcutil recoveryon
Removed /etc/systemd/system/obmc-host-timeout@0.target.
Removed /etc/systemd/system/obmc-host-crash@0.target.

root@witherspoon:/etc/systemd/system#

root@witherspoon:/run/systemd/system# ls -l halt.target.d/reboot-guard.conf
ls: halt.target.d/reboot-guard.conf: No such file or directory
-----------------------------------------------------------------

Change-Id: Ic43eeb8517859ae6dbf3b83d053b33758e5ae1b0
Signed-off-by: Vishwanatha Subbanna <vishwa@linux.vnet.ibm.com>

show more ...

obmcutil: Silence kill error message by quoting test variable

Similar to the last fix, avoid an always-true test result with proper
variable quoting.

Change-Id: I90d79efcc92e61b

obmcutil: Silence kill error message by quoting test variable

Similar to the last fix, avoid an always-true test result with proper
variable quoting.

Change-Id: I90d79efcc92e61bf5d4989c5675de8dc1928aaff
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

show more ...

Add support to mask and unmask host crash target

When the host crashes, BMC gets to know about that and causes a
transition to Quiesce state as part of executing a target.
Doing so,

Add support to mask and unmask host crash target

When the host crashes, BMC gets to know about that and causes a
transition to Quiesce state as part of executing a target.
Doing so, makes the system move out of fail state.
This patch set masks and unmasks the target on recoveryoff
and recoveryon respectively

Tested:

:/tmp# ./obmcutil recoveryoff
Created symlink /etc/systemd/system/obmc-host-timeout@0.target → /dev/null.
Created symlink /etc/systemd/system/obmc-host-crash@0.target → /dev/null.

:/tmp# ./obmcutil recoveryon
Removed /etc/systemd/system/obmc-host-timeout@0.target.
Removed /etc/systemd/system/obmc-host-crash@0.target.

Change-Id: I49dff827b78a6fc2a35d2dd0d79b5c05c20eb39b
Signed-off-by: Vishwanatha Subbanna <vishwa@linux.vnet.ibm.com>

show more ...

Add support for recoveryoff and recoveron

During early stages of system bringup, it is beneficial to have the system in
fail state, so that the issue can be debugged faster, instead of g

Add support for recoveryoff and recoveron

During early stages of system bringup, it is beneficial to have the system in
fail state, so that the issue can be debugged faster, instead of getting into
recovery mode.

Disabling the automatic reboot from Quiesce state and not handling the boot
watchdog timeout would help with this.

When phosphor-watchdog times out, it starts obmc-host-timeout@0.target
to get the BMC through recovery process. This patchset adds mask and unmask
on that target to support recoveryoff and recoveryon respectively

Tested:
.......

Scenario-1: Disable recovery, start Watchdog and enable it:

/tmp# ./obmcutil recoveryoff
Created symlink /etc/systemd/system/obmc-host-timeout@0.target → /dev/null.

/lib/systemd/system/obmc-host-startmin@0.target.wants# obmcutil state
CurrentBMCState : xyz.openbmc_project.State.BMC.BMCState.Ready
CurrentPowerState : xyz.openbmc_project.State.Chassis.PowerState.Off
CurrentHostState : xyz.openbmc_project.State.Host.HostState.Off

phosphor-watchdog --continue --service=xyz.openbmc_project.Watchdog
--path=/xyz/openbmc_project/watchdog/host0 --target=obmc-host-timeout@0.target &

busctl call `mapper get-service /xyz/openbmc_project/watchdog/host0`
/xyz/openbmc_project/watchdog/host0 org.freedesktop.DBus.Properties Set ssv
xyz.openbmc_project.State.Watchdog Enabled b true

phosphor-watchdog[2050]: watchdog: enabled and started

phosphor-watchdog[2050]: watchdog: Timed out

phosphor-watchdog[2050]: watchdog: Failed to start unit

phosphor-watchdog[2050]: watchdog: disabled

CurrentBMCState : xyz.openbmc_project.State.BMC.BMCState.Ready
CurrentPowerState : xyz.openbmc_project.State.Chassis.PowerState.Off
CurrentHostState : xyz.openbmc_project.State.Host.HostState.Off

....................................

Scenario-2: Enable recovery and enable watchdog:

/tmp# ./obmcutil recoveryon
Removed /etc/systemd/system/obmc-host-timeout@0.target.

CurrentBMCState : xyz.openbmc_project.State.BMC.BMCState.Ready
CurrentPowerState : xyz.openbmc_project.State.Chassis.PowerState.Off
CurrentHostState : xyz.openbmc_project.State.Host.HostState.Off

busctl call `mapper get-service /xyz/openbmc_project/watchdog/host0`
/xyz/openbmc_project/watchdog/host0 org.freedesktop.DBus.Properties Set ssv
xyz.openbmc_project.State.Watchdog Enabled b true

Oct 31 10:50:45 phosphor-watchdog[2050]: watchdog: enabled and started

Oct 31 10:51:15 phosphor-watchdog[2050]: watchdog: Timed out
Oct 31 10:51:15 systemd[1]: unit_file_find_fragment: obmc-host-timeout@.target+0 →
obmc-host-timeout@0.target

Oct 31 10:51:15 phosphor-watchdog[2050]: watchdog: disabled

Oct 31 10:51:15 systemd[1]: Stopped target Power0 Host Off.
Oct 31 10:51:16 systemd[1]: Stopped target Chassis0 (Power Off).

Oct 31 10:51:16 watchdog_timeout[2249]: Host watchdog timed out

Oct 31 10:51:16 systemd[1]: Reached target Quiesce Target.
Oct 31 10:51:17 systemd[1]: Started Reboot host0.
-------------------------------------------------

Change-Id: I3ea030666c6198f9638efd7201805dcecf41b6a6
Signed-off-by: Vishwanatha Subbanna <vishwa@linux.vnet.ibm.com>

show more ...

Add support for rebootoff and rebooton

This patchset adds support to Enable/Disable Automatic reboot from Quiesce state

Tested:

obmcutil rebooton : AutoReboot was set to

Add support for rebootoff and rebooton

This patchset adds support to Enable/Disable Automatic reboot from Quiesce state

Tested:

obmcutil rebooton : AutoReboot was set to true
obmcutil rebootoff : AutoReboot was set to false

D-Bus object: /xyz/openbmc_project/control/host0/auto_reboot

Change-Id: I934cdac434b4321d0226b71a1593b1e696b4759c
Signed-off-by: Vishwanatha Subbanna <vishwa@linux.vnet.ibm.com>

show more ...

obmcutil: Quote variable in non-zero test to avoid always true result

Currently adding `--wait` invokes verbose output even if `--verbose` is
not supplied.

Change-Id: Ib14d0cc7e

obmcutil: Quote variable in non-zero test to avoid always true result

Currently adding `--wait` invokes verbose output even if `--verbose` is
not supplied.

Change-Id: Ib14d0cc7e6f0bf31d147537b58f1a65b7d99450a
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

show more ...

obmcutil: Implement --verbose

The python implementation had a --verbose option that printed the
journal to the console if --wait was also supplied (doesn't make sense
if we're not wa

obmcutil: Implement --verbose

The python implementation had a --verbose option that printed the
journal to the console if --wait was also supplied (doesn't make sense
if we're not waiting). This was dropped when reimplementing obmcutil in
shell, so add it back.

Change-Id: I06145d5b55473c0791c8f6b6dd8105eb27953835
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

show more ...

obmcutil: add more info to state subcommand

Adds new subcommand to request the OS state.
Adds bootprogress and osstate to the output of state/status subcommands.

Tested: The out

obmcutil: add more info to state subcommand

Adds new subcommand to request the OS state.
Adds bootprogress and osstate to the output of state/status subcommands.

Tested: The output of `obmcutil state` must look like:
```
CurrentBMCState : xyz.openbmc_project.State.BMC.BMCState.Ready
CurrentPowerState : xyz.openbmc_project.State.Chassis.PowerState.Off
CurrentHostState : xyz.openbmc_project.State.Host.HostState.Off
BootProgress : xyz.openbmc_project.State.Boot.Progress.ProgressStages.Unspecified
OperatingSystemState: xyz.openbmc_project.State.OperatingSystem.Status.OSStatus.Inactive
```

Change-Id: I59937986317fe2ac487d355a627de1070ba813f8
Signed-off-by: Alexander Filippov <a.filippov@yadro.com>

show more ...

obmcutil: Add chassiskill option

Change-Id: I9b8289e433bfcf918d430c012ec8879b58e523b0
Signed-off-by: Anthony Wilson <wilsonan@us.ibm.com>

obmcutil: Add wait/timeout option

The option to block/wait for a state transition to complete has
been added. The transition is expected to occur within a set
timeout window and will

obmcutil: Add wait/timeout option

The option to block/wait for a state transition to complete has
been added. The transition is expected to occur within a set
timeout window and will terminate if the desired state has not
been observed within that window. It may be possible for the
state transition to complete outside this window, but it is
assumed to be a failure.

Change-Id: Icb9ff29f51b8712469fd9957b7e4b287704cb314
Signed-off-by: Anthony Wilson <wilsonan@us.ibm.com>

show more ...

obmcutil: Update argument handling

In anticipation of new options being added to the program,
this change should make it easier and cleaner to integrate
those options.

Chang

obmcutil: Update argument handling

In anticipation of new options being added to the program,
this change should make it easier and cleaner to integrate
those options.

Change-Id: Ie996c34ef9c8493d68bc17d6e7a6d39a537ba2cd
Signed-off-by: Anthony Wilson <wilsonan@us.ibm.com>

show more ...

obmcutil: Added {power,chassis}{on,off} options

The base functions of these options have been implemented, so
power ons/offs can be performed. However, the 'verbose' and
'wait' funct

obmcutil: Added {power,chassis}{on,off} options

The base functions of these options have been implemented, so
power ons/offs can be performed. However, the 'verbose' and
'wait' functionality associated with them from the python
version of the script has not been implemented here (yet).
So there is no error checking in the case of on/off failures
at this moment.

'chassiskill' has also not been implemented here and is planned
to be implemented in its own script. The option may be added to
this script as a call to the other script when that gets
implemented.

Change-Id: I739f0a74e90fb4727fd3333d2a601da1dc49799c
Signed-off-by: Anthony Wilson <wilsonan@us.ibm.com>

show more ...