Client module documentation

This module provides access to the API of a foreman server

class foreman.client.Foreman(url, auth=None, version=None, api_version=None, use_cache=True, strict_cache=True, timeout=60, timeout_post=600, timeout_delete=600, timeout_put=None, verify=False)

Main client class. It’s methods will be autogenerated, check the API docs for your foreman version here.

do_delete(url, kwargs)

Parameters:

• url – relative url to resource
• kwargs – parameters for the api call

do_get(url, kwargs)

Parameters:

• url – relative url to resource
• kwargs – parameters for the api call

do_post(url, kwargs)

Parameters:

• url – relative url to resource
• kwargs – parameters for the api call

do_put(url, kwargs)

Parameters:

• url – relative url to resource
• kwargs – parameters for the api call

get_foreman_version()

Even if we have an api method that returns the foreman version, we need the version first to know its path, so instead of that we get the main page and extract the version from the footer.

get_timeout(method=None)

Get timeout for given request method

Parameters:method – Request method (eg. GET, POST, ..). If None, return default timeout.

set_timeout(timeout, method='DEFAULT')

Set the timeout for any connection, the timeout is the requests module timeout (for conneciton inactivity rather than request total time)

Parameters:

• timeout – Timeout in seconds for the connection inactivity
• method – Request method (eg. GET, POST, ..). By default, set default timeout.

unset_timeout(method)

Ensure timeout for given method is not set.

Parameters:method – Request method (eg. GET, POST, ..)

exception foreman.client.ForemanException(res, msg)

exception foreman.client.ForemanVersionException

class foreman.client.MetaForeman

static convert_plugin_def(http_method, funcs)

This function parses one of the elements of the definitions dict for a plugin and extracts the relevant information

Parameters:

• http_method – HTTP method that uses (GET, POST, DELETE, ...)
• funcs – functions related to that HTTP method

class foreman.client.MethodAPIDescription(resource, method, api)

classmethod create_param_doc(param, prefix=None)

Generate documentation for single parameter of function :param param: dict contains info about parameter :param sub: prefix string for recursive purposes

exclude_html_reg = <_sre.SRE_Pattern object>

generate_func(as_global=False)

Generate function for specific method and using specific api

Parameters:as_global – if set, will use the global function name, instead of the class method (usually {resource}_{class_method}) when defining the function

get_global_method_name()

parse_resource_from_url(url)

Returns the appropriate resource name for the given URL.

Parameters:url – API URL stub, like: ‘/api/hosts’ Returns:Resource name, like ‘hosts’, or None if not found

resource_pattern = <_sre.SRE_Pattern object>

exception foreman.client.ObjectNotFound(res, msg)

class foreman.client.Resource(foreman)

Provides entry point for specific resource.

class foreman.client.ResourceMeta

This type composes methods for resource class

exception foreman.client.Unacceptable(res, msg)

foreman.client.parse_resource_definition(resource_name, resource_dct)

Returns all the info extracted from a resource section of the apipie json

Parameters:

• resource_name – Name of the resource that is defined by the section
• resrouce_dict – Dictionary as generated by apipie of the resource definition

foreman.client.parse_version(version_string)

Parameters:version_string – Version string to parse, like ‘1.2.3’

Passing to int as many of the elements as possible to support comparing ints of different number of chars (2<10 but ‘2’>‘10’). So we just accept that any element with chars will be considered lesser to any int element.

foreman.client.res_to_str(res)

Parameters:res – requests.Response object

Parse the given request and generate an informative string from it

foreman.client.set_loglevel(level)

Sets the loglevel for the python-foreman module.

Parameters:loglevel – a loglevel constant from the logging module.

foreman.client.try_int(what)