Site Setup API Parity

View as Markdown

Use the REST API and nicocli for the following site setup operations:

Site setup taskCurrent statusPreferred nicocli command
Approve, list, or remove measured-boot machine trust rulesCoveredApprove once with nicocli measured-boot machine approve --site-id <site-id> --machine-id <machine-id-or-*> --approval-type Oneshot. Use Persist for a persistent approval.

List with nicocli measured-boot machine list --site-id <site-id>.

Remove by Machine ID with nicocli measured-boot machine remove --site-id <site-id> --selector MachineId <machine-id>, or by approval ID with nicocli measured-boot machine remove --site-id <site-id> --selector ApprovalId <approval-id>.
Approve, list, or remove measured-boot profile trust rulesCoveredApprove once with nicocli measured-boot profile approve --site-id <site-id> --profile-id <profile-id> --approval-type Oneshot. Use Persist for a persistent approval.

List with nicocli measured-boot profile list --site-id <site-id>.

Remove by Profile ID with nicocli measured-boot profile remove --site-id <site-id> --selector ProfileId <profile-id>, or by approval ID with nicocli measured-boot profile remove --site-id <site-id> --selector ApprovalId <approval-id>.
Clear a Site Explorer endpoint errorCoveredUse nicocli site-explorer endpoint action --data '{"siteId":"<site-id>","action":"ClearError","target":"EndpointIds","endpointIds":["<bmc-ip>"]}'. To target all endpoints, use nicocli site-explorer endpoint action --data '{"siteId":"<site-id>","action":"ClearError","target":"All"}'.

action accepts ClearError or ReExplore.

target accepts All or EndpointIds. endpointIds is required for EndpointIds, must contain BMC IP addresses, and must be omitted for All.
Queue a Site Explorer endpoint for re-explorationCoveredUse nicocli site-explorer endpoint action --data '{"siteId":"<site-id>","action":"ReExplore","target":"EndpointIds","endpointIds":["<bmc-ip>"]}'.

To target all endpoints, use nicocli site-explorer endpoint action --data '{"siteId":"<site-id>","action":"ReExplore","target":"All"}'. action accepts ClearError or ReExplore.

target accepts All or EndpointIds; endpointIds is required for EndpointIds, must contain BMC IP addresses, and must be omitted for All.
Register an Expected MachineCoveredUse nicocli expected-machine create --data-file - with the password-safe stdin workflow in Add Expected Machines Table.
Register Expected Machines in a batchCoverednicocli expected-machine batch-create --data-file expected-machines.json
Store the site-default DPU UEFI credentialCoveredUse nicocli uefi-credential create --data-file - with the password-safe stdin workflow in Store Host and DPU UEFI Passwords.
Store the site-default host UEFI credentialCoveredUse nicocli uefi-credential create --data-file - with the password-safe stdin workflow in Store Host and DPU UEFI Passwords.
Store the site-wide BMC root credentialCoveredUse nicocli bmc-credential create --data-file - with the password-safe stdin workflow in Store Host and DPU BMC Password.

Implementation links: #2801 covers measured-boot trust rules, #2802 covers Site Explorer endpoint actions, and #2803 covers site-default UEFI credentials.