This section describes how to check the status of a lock, disable reservations, and repair reservations. The disable and repair operations only affect the ability to make reservations on hardware devices.
Some of the common scenarios an admin might encounter when working with the Hardware State Manager (HSM) Locking API are also described.
Use the following command to verify if a component name (xname) is locked or not. The command will show if it is locked (admin), reserved (service command), or reservation disabled (either an EPO or an admin command).
The following shows how to interpret the output:
cray hsm locks lock create command.cray hsm locks status create --component-ids x1003c5s2b1n1
Example output:
NotFound = []
[[Components]]
ID = "x1003c5s2b1n1"
Locked = false
Reserved = false
ReservationDisabled = false
Disabling a lock prevents a service from being able to make a reservation on it, and it releases/ends any current reservations. Even though SMD removes the reservation when disabling a lock, it does not mean that the Firmware Action Service (FAS) is aware that it has lost the reservation. Additionally, if CAPMC has a reservation that is cancelled, disabled, or broken, it will do nothing to the existing CAPMC operation. There are no checks by CAPMC to make sure things are still reserved at any time during a power operation.
This is a way to stop new operations from happening, not a way to prevent currently executing operations.
cray hsm locks disable create --component-ids x1003c5s2b1n1
Example output:
Failure = []
[Counts]
Total = 1
Success = 1
Failure = 0
[Success]
ComponentIDs = [ "x1003c5s2b1n1",]
The following is an example of a when a lock is disabled:
cray hsm locks status create --component-ids x1003c5s2b1n1
Example output:
NotFound = []
[[Components]]
ID = "x1003c5s2b1n1"
Locked = false
Reserved = false
ReservationDisabled = true
Locks must be manually repaired after disabling a component or performing a manual EPO. This prevents the system from automatically re-issuing reservations or giving out lock requests.
cray hsm locks repair create --component-ids x1003c5s2b1n1
Example output:
Failure = []
[Counts]
Total = 1
Success = 1
Failure = 0
[Success]
ComponentIDs = [ "x1003c5s2b1n1",]
To verify if the lock was successfully repaired:
cray hsm locks status create --component-ids x1003c5s2b1n1
Example output:
NotFound = []
[[Components]]
ID = "x1003c5s2b1n1"
Locked = false
Reserved = false
ReservationDisabled = false
disable is Issued?Before issuing a disable command, verify that a lock is already in effect:
cray hsm locks lock create --component-ids x1003c5s2b1n1
Example output:
Failure = []
[Counts]
Total = 1
Success = 1
Failure = 0
[Success]
ComponentIDs = [ "x1003c5s2b1n1",]
cray hsm locks status create --component-ids x1003c5s2b1n1
Example output:
NotFound = []
[[Components]]
ID = "x1003c5s2b1n1"
Locked = true
Reserved = false
ReservationDisabled = false
When attempting to disable, the lock will stay in effect, but the reservation ability will be disabled. For example:
cray hsm locks disable create --component-ids x1003c5s2b1n1
Example output:
Failure = []
[Counts]
Total = 1
Success = 1
Failure = 0
[Success]
ComponentIDs = [ "x1003c5s2b1n1",]
cray hsm locks status create --component-ids x1003c5s2b1n1
Example output:
NotFound = []
[[Components]]
ID = "x1003c5s2b1n1"
Locked = true
Reserved = false
ReservationDisabled = true
lock be Issued to a Currently Locked Component?A lock cannot be issued to a component that is already locked. The following example shows a component that is already locked, and the returned error message when trying to lock the component again.
cray hsm locks status create --component-ids x1003c5s2b1n1
Example output:
NotFound = []
[[Components]]
ID = "x1003c5s2b1n1"
Locked = true <<-- component name (xname) is locked
Reserved = false
ReservationDisabled = true
cray hsm locks lock create --component-ids x1003c5s2b1n1
Example output:
Usage: cray hsm locks lock create [OPTIONS]
Try 'cray hsm locks lock create --help' for help.
Error: Bad Request: Component is Locked