Reference
Arcane.machine.status()
Gets machine readiness/status.
This focused page is derived from the mechanically checked full member inventory.
Syntax
Arcane.machine.status()
Parameters
None
Return value
Promise<status>
Description
Gets machine readiness/status.
Overview
Arcane.machine.status() returns the Provisioner's combined machine-readiness
view. It requires provisioning.manage, an application of type provisioner,
and a Core host. It performs bounded status and verification reads but makes no
machine change and emits no event.
This result contains local account, filesystem-location, and installation details. Keep it inside the trusted Provisioner UI; do not send or persist the whole object as telemetry.
Result
The exact top-level fields are version, protocol, application, os,
nativeAdapter, identity, protectedUsername, protectedUsernames,
usernamePolicy, installation, requirements, permissions, renderer,
securityMode, publisherTrustSource, revocationStatus,
installedSecurityMode, paths, simulation, execution, and bundleRoot.
installation, requirements, permissions, and execution use the same
shapes documented by their focused methods. securityMode and its evidence
describe the active host release; installedSecurityMode describes the
installed release or "not-installed". Simulation remains labeled in both
simulation and execution.
Errors and recovery
METHOD_NOT_ALLOWED means the caller is not the admitted Provisioner or lacks
provisioning.manage. Status can also fail closed on invalid installation,
account, or filesystem evidence. Preserve the error's diagnostic id and follow
its repair guidance; do not remove failing fields and reinterpret the remainder
as ready.
Example
const machine = await Arcane.machine.status();
console.log(machine.os.displayName, machine.installation.disposition);
console.log('Simulation', machine.execution.simulation);
console.log('Required work', machine.requirements.filter(
function findBlockingRequirement(requirement) {
return requirement.blocking;
}
));