HTTP API

By default ironic-inspector listens on 0.0.0.0:5050, port can be changed in configuration. Protocol is JSON over HTTP.

Start Introspection

POST /v1/introspection/<UUID> initiate hardware introspection for node <UUID>. All power management configuration for this node needs to be done prior to calling the endpoint (except when Setting IPMI Credentials).

Requires X-Auth-Token header with Keystone token for authentication.

Optional parameters:

• new_ipmi_password if set, ironic-inspector will try to set IPMI password on the machine to this value. Power credentials validation will be skipped and manual power on will be required. See Setting IPMI Credentials for details.
• new_ipmi_username provides new IPMI user name in addition to password set by new_ipmi_password. Defaults to current ipmi_username in node driver_info field.

Response:

• 202 - accepted introspection request
• 400 - bad request
• 401, 403 - missing or invalid authentication
• 404 - node cannot be found

Get Introspection Status

GET /v1/introspection/<UUID> get hardware introspection status.

Requires X-Auth-Token header with Keystone token for authentication.

Response:

• 200 - OK
• 400 - bad request
• 401, 403 - missing or invalid authentication
• 404 - node cannot be found

Response body: JSON dictionary with keys:

• finished (boolean) whether introspection is finished (true on introspection completion or if it ends because of an error)
• error error string or null; Canceled by operator in case introspection was aborted

Abort Running Introspection

POST /v1/introspection/<UUID>/abort abort running introspection.

Requires X-Auth-Token header with Keystone token for authentication.

Response:

• 202 - accepted
• 400 - bad request
• 401, 403 - missing or invalid authentication
• 404 - node cannot be found
• 409 - inspector has locked this node for processing

Get Introspection Data

GET /v1/introspection/<UUID>/data get stored data from successful introspection.

Requires X-Auth-Token header with Keystone token for authentication.

Response:

• 200 - OK
• 400 - bad request
• 401, 403 - missing or invalid authentication
• 404 - data cannot be found or data storage not configured

Response body: JSON dictionary with introspection data

Note

We do not provide any backward compatibility guarantees regarding the format and contents of the stored data. Notably, it depends on the ramdisk used and plugins enabled both in the ramdisk and in inspector itself.

Introspection Rules

See Introspection Rules for details.

All these API endpoints require X-Auth-Token header with Keystone token for authentication.

• POST /v1/rules create a new introspection rule.

  Request body: JSON dictionary with keys:

  • conditions rule conditions, see Introspection Rules
  • actions rule actions, see Introspection Rules
  • description (optional) human-readable description
  • uuid (optional) rule UUID, autogenerated if missing

  Response

  • 200 - OK
  • 400 - bad request

  Response body: JSON dictionary with introspection rule representation (the same as above with UUID filled in).

• GET /v1/rules list all introspection rules.

  Response

  • 200 - OK

  Response body: JSON dictionary with key rules - list of short rule representations. Short rule representation is a JSON dictionary with keys:

  • uuid rule UUID
  • description human-readable description
  • links list of HTTP links, use one with rel=self to get the full rule details

• DELETE /v1/rules delete all introspection rules.

  Response

  • 204 - OK

• GET /v1/rules/<UUID> get one introspection rule by its <UUID>.

  Response

  • 200 - OK
  • 404 - not found

  Response body: JSON dictionary with introspection rule representation (see POST /v1/rules above).

• DELETE /v1/rules/<UUID> delete one introspection rule by its <UUID>.

  Response

  • 204 - OK
  • 404 - not found

Ramdisk Callback

POST /v1/continue internal endpoint for the ramdisk to post back discovered data. Should not be used for anything other than implementing the ramdisk. Request body: JSON dictionary with at least these keys:

• inventory full hardware inventory from the ironic-python-agent with at least the following keys:
  • memory memory information containing at least key physical_mb - physical memory size as reported by dmidecode,
  • cpu CPU infromation containing at least keys count (CPU count) and architecture (CPU architecture, e.g. x86_64),
  • bmc_address IP address of the node’s BMC,
  • interfaces list of dictionaries with the following keys:
    • name interface name,
    • ipv4_address IPv4 address of the interface,
    • mac_address MAC (physical) address of the interface.
• root_disk default deployment root disk as calculated by the ironic-python-agent algorithm.
• boot_interface MAC address of the NIC that the machine PXE booted from either in standard format 11:22:33:44:55:66 or in PXELinux BOOTIF format 01-11-22-33-44-55-66. Strictly speaking, this key is optional, but some features will now work as expected, if it is not provided.

Optionally the following keys might be provided:

• error error happened during ramdisk run, interpreted by ramdisk_error plugin.
• logs base64-encoded logs from the ramdisk.

The following keys are supported for backward compatibility with the old bash-based ramdisk, when inventory is not provided:

• cpus number of CPU
• cpu_arch architecture of the CPU
• memory_mb RAM in MiB
• local_gb hard drive size in GiB
• ipmi_address IP address of BMC, may be missing on VM
• block_devices block devices information for the raid_device plugin, dictionary with one key: serials list of serial numbers of block devices.

Note

This list highly depends on enabled plugins, provided above are expected keys for the default set of plugins. See Plugins for details.

Note

This endpoint is not expected to be versioned, though versioning will work on it.

Response:

• 200 - OK
• 400 - bad request
• 403 - node is not on introspection
• 404 - node cannot be found or multiple nodes found

Response body: JSON dictionary. If Setting IPMI Credentials is requested, body will contain the following keys:

• ipmi_setup_credentials boolean True
• ipmi_username new IPMI user name
• ipmi_password new IPMI password

Error Response

If an error happens during request processing, Ironic Inspector returns a response with an appropriate HTTP code set, e.g. 400 for bad request or 404 when something was not found (usually node in cache or node in ironic). The following JSON body is returned:

{
    "error": {
        "message": "Full error message"
    }
}

This body may be extended in the future to include details that are more error specific.

API Versioning

The API supports optional API versioning. You can query for minimum and maximum API version supported by the server. You can also declare required API version in your requests, so that the server rejects request of unsupported version.

Note

Versioning was introduced in Ironic Inspector 2.1.0.

All versions must be supplied as string in form of X.Y, where X is a major version and is always 1 for now, Y is a minor version.

• If X-OpenStack-Ironic-Inspector-API-Version header is sent with request, the server will check if it supports this version. HTTP error 406 will be returned for unsupported API version.
• All HTTP responses contain X-OpenStack-Ironic-Inspector-API-Minimum-Version and X-OpenStack-Ironic-Inspector-API-Maximum-Version headers with minimum and maximum API versions supported by the server.

API Discovery

The API supports API discovery. You can query different parts of the API to discover what other endpoints are avaliable.

• GET / List API Versions

  Response:

  • 200 - OK

  Response body: JSON dictionary containing a list of versions, each version contains:

  • status Either CURRENT or SUPPORTED
  • id The version identifier
  • links A list of links to this version endpoint containing:
    • href The URL
    • rel The relationship between the version and the href

• GET /v1 List API v1 resources

  Response:

  • 200 - OK

  Response body: JSON dictionary containing a list of resources, each resource contains:

  • name The name of this resources
  • links A list of link to this resource containing:
    • href The URL
    • rel The relationship between the resource and the href

Version History

• 1.0 version of API at the moment of introducing versioning.
• 1.1 adds endpoint to retrieve stored introspection data.
• 1.2 endpoints for manipulating introspection rules.
• 1.3 endpoint for canceling running introspection