LockInspectionEntry

Parameters and properties

The fields below cover all variants; the signature specifies their allowed combinations.

nameRequired
string
Basename of the entry, or the full object key for a transport inventory.
pathRequired
string
Host path of the entry, or the object key for a transport inventory.
ownershipOptional
LockOwnership | undefined
Whether the recorded process still holds the lock, judged by host, boot, PID namespace and process start time. Rely on it rather than on state.
stateRequired
"present" | "absent" | "unknown" | "skipped"
present: a process with the recorded PID exists; absent: none exists; unknown: the file or PID could not be read or probed; skipped: the entry is not a file.
pidVariant-dependent
number | number | undefined
PID read from the lock file, absent when the file or its PID is unreadable.
reasonVariant-dependent
string | "NOT_FILE"
Why the state is unknown (LOCK_READ_FAILED, INVALID_PID, PID_PROBE_FAILED) or skipped (NOT_FILE).

export type LockInspectionEntry = Pick<StorageEntry, "name" | "path"> &
  LockInspectionState;