ironicclient.v1.client module

ironicclient.v1.client module

class ironicclient.v1.client.Client(endpoint=None, endpoint_override=None, *args, **kwargs)[source]

Bases: object

Client for the Ironic v1 API.

Parameters:
  • endpoint (string) – A user-supplied endpoint URL for the ironic service. DEPRECATED, use endpoint_override instead.
  • endpoint_override (string) – A user-supplied endpoint URL for the ironic service.
  • token (function) – Provides token for authentication.
  • timeout (integer) – Allows customization of the timeout for client http requests. (optional)
current_api_version

Return the current API version in use.

This returns the version of the REST API that the API client is presently set to request. This value may change as a result of API version negotiation.

is_api_version_negotiated

Returns True if microversion negotiation has occured.

negotiate_api_version()[source]

Triggers negotiation with the remote API endpoint.

Returns:the negotiated API version.
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.