Skip to main content

GET /nodes/{uuid}/systemGuardSetting

Use this method to return the System Guard settings for a specific managed servers with XCC2 only.

Note
This REST API requires Lenovo XClarity Administrator v4.0.0 or later.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://<management_server_IP>/nodes/{uuid}/systemGuardSetting

where {uuid} is the UUID of the server. To obtain the server UUIDs, use GET /nodes.

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response header​

The URI and ID of the root job are returned in the Location field, for example:
Location: /tasks/34

Response body​

AttributesTypeDescription
lockDownPolicyStringIndicates the behavior when System Guard is enabled. This can be one of the following values.
  • GenerateEventOnly. When any inventory change is detected, an event is raised, but no other action is taken. This is default behavior on devices.
  • PreventOSBooting. When a processor or memory inventory change is detected, an event is raised.

    If you attempt to boot into the OS, you are warned if System Guard detects configuration changes. In this case, you are prompted to log into the baseboard management controller if the changes are unexpected; otherwise, you can continue the boot or shutdown process.

osBootPreventingBooleanIndicates whether to prevent booting the OS when processor or memory deviations are detected between the snapshot and the current inventory (when the status is noncompliant). This can be one of the following values.
  • true. Rebooting the OS is prevented when processor or memory deviations are detected.
  • false. Rebooting the OS is allowed when processor or memory deviations are detected.
statusStringCompliance status. This can be one of the following values.
  • Compliant. The snapshot matches the current inventory for the device.
  • Noncompliant. The snapshot does not match the current inventory for the device.
systemGuardEnabledBooleanIndicates whether System Guard is enabled. This can be one of the following values.
  • true. System Guard is enabled.
  • false. System Guard is disabled.
The following example is returned if the request is successful.
{
   "lockDownPolicy": "PreventOSBooting",
   "osBootPreventing" : true,
   "status" : "Noncompliant",
   "systemGuardEnabled": true
}