The ironic_inspector_client.client Module

Shorthand client functions using V1 API.

All these functions are deprecated, and ironic_inspector_client.v1.ClientV1 should be used instead.

ironic_inspector_client.client.introspect(uuid, base_url=None, auth_token=None, new_ipmi_password=None, new_ipmi_username=None, api_version=(1, 0), session=None, **kwargs)[source]

Start introspection for a node.

This function is deprecated. Please use ClientV1.introspect().

Parameters:
  • uuid – node uuid
  • base_url – Ironic Inspector URL in form: http://host:port[/ver], defaults to http://<current host>:5050/v1.
  • auth_token – deprecated, use session instead.
  • new_ipmi_password – if set, Ironic Inspector will update IPMI password to this value. DEPRECATED.
  • new_ipmi_username – if new_ipmi_password is set, this values sets new IPMI user name. Defaults to one in driver_info. DEPRECATED.
  • api_version – requested Ironic Inspector API version, defaults to DEFAULT_API_VERSION attribute.
  • session – keystone session.
  • kwargs – keyword arguments to pass to the ClientV1 constructor.
Raises:

ClientError on error reported from a server
Raises:

VersionNotSupported if requested api_version is not supported
Raises:

requests library exception on connection problems.
ironic_inspector_client.client.get_status(uuid, base_url=None, auth_token=None, api_version=(1, 0), session=None, **kwargs)[source]

Get introspection status for a node.

This function is deprecated. Please use ClientV1.get_status().

New in Ironic Inspector version 1.0.0.

Parameters:
  • uuid – node uuid.
  • base_url – Ironic Inspector URL in form: http://host:port[/ver], defaults to http://<current host>:5050/v1.
  • auth_token – deprecated, use session instead.
  • api_version – requested Ironic Inspector API version, defaults to DEFAULT_API_VERSION attribute.
  • session – keystone session.
  • kwargs – keyword arguments to pass to the ClientV1 constructor.
Raises:

ClientError on error reported from a server
Raises:

VersionNotSupported if requested api_version is not supported
Raises:

requests library exception on connection problems.
ironic_inspector_client.client.server_api_versions(base_url=None, session=None, **kwargs)[source]

Get minimum and maximum supported API versions from a server.

This function is deprecated. Please use ClientV1.server_api_versions().

Parameters:
  • base_url – Ironic Inspector URL in form: http://host:port[/ver], defaults to http://<current host>:5050/v1.
  • session – keystone session (authentication is not required).
  • kwargs – keyword arguments to pass to the BaseClient constructor.
Returns:

tuple (minimum version, maximum version) each version is returned as a tuple (X, Y)
Raises:

requests library exception on connection problems.
Raises:

ValueError if returned version cannot be parsed