Get Machine System Status (v2.1)

GET 
/sdwan/v2.1/api/machines/:machine_id/machinesystemstatus

Get the machine system status for a tenant.

Request

Path Parameters

machine_id stringrequired

The machine ID.

Responses

200

Successful Operation

application/json

Schema

Schema

boot_mode string

Possible values: [BIOS, UEFI_ONLY, UEFI_SECURE]

The possible values in the boot mode.

disk_status DiskPartitionStatus[]
The status details of the disk.
Array [
encryption_status string
Possible values: [ON, OFF]
The disk partition status. Max size = 128.
mount_point string
The partition state mount point.
size int64
The size of the partition status.
]
fips_mode string

Possible values: [none, fips, non_fips]

The possible values in the FIPs.

hardware_id stringrequired

The machine hardware ID.

id string

The machine ID.

tpm_status string

The TPM status.

trusted_boot string

Possible values: [PASSED, FAILED]

The possible values in trusted boot.

Example (from schema)

{
  "boot_mode": "BIOS",
  "disk_status": [
    {
      "encryption_status": "ON",
      "mount_point": "string",
      "size": 0
    }
  ],
  "fips_mode": "none",
  "hardware_id": "string",
  "id": "string",
  "tpm_status": "string",
  "trusted_boot": "PASSED"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "MACHINE_UNKNOWN"
      },
      {
        "code": "MACHINE_STATUS_UNKNOWN"
      }
    ]
  }
}

Loading...