Available

Returns a list of available hosts

Changed on
get/available/

Request

  • Base URL
    https://quads.example.com/api/v3
  • URL
    https://quads.example.com/api/v3/available/
  • Auth
    none declared

Query parameters

startstring

Start date

endstring

End date

cloudstring

Cloud

modelstring

Filter by host model

host_typestring

Filter by host type

Response

Hosts

idinteger
namestring
modelstring
host_typestring
buildboolean
validatedboolean
switch_config_appliedboolean
brokenboolean
retiredboolean
can_self_scheduleboolean
overcloudboolean
rackstring
ulocstring
bladestring
bootmodestring
last_buildstring
cloud_idinteger
default_cloud_idinteger

Example response

[
  {
    "id": 12,
    "name": "host.example.com",
    "model": "r640",
    "host_type": "vendor",
    "build": true,
    "validated": true,
    "switch_config_applied": true,
    "broken": true,
    "retired": true,
    "overcloud": true,
    "rack": "A1",
    "uloc": "U10",
    "blade": "blade1",
    "bootmode": "uefi",
    "last_build": "2022-02-02",
    "cloud_id": 12,
    "default_cloud_id": 1,
    "interfaces": [
      {
        "id": 12,
        "name": "em1",
        "bios_id": "nic1",
        "mac_address": "aa:00:bb:11:cc:22",
        "switch_ip": "10.1.1.18",
        "switch_port": "xt-0-0/1",
        "speed": 1000,
        "vendor": "Intel",
        "pxe_boot": true,
        "host_id": 10
      }
    ],
    "disks": [
      {
        "disk_id": 1,
        "disk_type": "nvme",
        "size_gb": 2000,
        "count": 10,
        "host_id": 10
      }
    ],
    "memory": [
      {
        "id": 12,
        "size_gb": 2000,
        "handle": "MMD",
        "host_id": 10
      }
    ],
    "processors": [
      {
        "id": 12,
        "handle": "CoreI7",
        "vendor": "Intel",
        "product": "i7",
        "cores": 20,
        "threads": 20,
        "processor_type": "x86",
        "host_id": 10
      }
    ]
  }
]

Changes

  • f6728f2d9024Revision changes
    • info

      added the new optional query request parameter host_type

    • info

      added the new optional query request parameter model

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • a060ee3d649dRevision changes
    • warning

      deleted the query request parameter host_type

    • warning

      deleted the query request parameter model

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status