Nodes and node

nodes

Module for jenkinsapi nodes

class jenkinsapi.nodes.Nodes(baseurl: str, jenkins_obj: Jenkins)

Bases: JenkinsBase

Class to hold information on a collection of nodes

create_node(name: str, node_dict: dict) → Node

Create a new slave node

Parameters:

• name (str) – name of slave

• node_dict (dict) – node dict (See Node class)

Returns:

node obj

create_node_with_config(name: str, config: dict) → Node | None

Create a new slave node with specific configuration. Config should be resemble the output of node.get_node_attributes() :param str name: name of slave :param dict config: Node attributes for Jenkins API request

to create node (See function output Node.get_node_attributes())

Returns:

node obj

get_jenkins_obj() → Jenkins

items() → list[tuple[str, Node]]

Return a copy of the container’s list of (name, node) pairs.

iteritems() → Iterator[tuple[str, Node]]

Return an iterator over the container’s (name, node) pairs.

Using iteritems() while creating nodes may raise a RuntimeError or fail to iterate over all entries.

iterkeys() → Iterator[str]

Return an iterator over the container’s node names.

Using iterkeys() while creating nodes may raise a RuntimeError or fail to iterate over all entries.

itervalues() → Iterator[Node]

Return an iterator over the container’s nodes.

Using itervalues() while creating nodes may raise a RuntimeError or fail to iterate over all entries.

keys() → list[str]

Return a copy of the container’s list of node names.

values() → list[Node]

Return a copy of the container’s list of nodes.

node

Module for jenkinsapi Node class

class jenkinsapi.node.Node(jenkins_obj: Jenkins, baseurl: str, nodename: str, node_dict, poll: bool = True)

Bases: JenkinsBase

Class to hold information on nodes that are attached as slaves to the master jenkins instance

block_until_idle(timeout: int, poll_time: int = 5) → None

Blocks until the node become idle. :param timeout: Time in second when the wait is aborted. :param poll_time: Interval in seconds between each check. :@raise TimeOut

get_architecture() → str

Returns the system architecture of the node eg. “Linux (amd64)”.

get_available_physical_memory() → int

Returns the node’s available physical memory in bytes.

get_available_swap_space() → int

Returns the node’s available swap space in bytes.

get_clock_difference() → int

Returns the difference between the node’s clock and the master Jenkins clock. Used to detect out of sync clocks.

get_config() → str

Returns the config.xml from the node.

get_config_element(el_name: str) → str

Returns simple config element.

Better not to be used to return “nodeProperties” or “launcher”

get_jenkins_obj() → Jenkins

get_labels() → str | None

Returns the labels for a slave as a string with each label separated by the ‘ ‘ character.

get_monitor(monitor_name: str, poll_monitor=True) → str

Polls the node returning one of the monitors in the monitorData branch of the returned node api tree.

get_node_attributes() → dict

Gets node attributes as dict

Used by Nodes object when node is created

Returns:

Node attributes dict formatted for Jenkins API request to create node

get_num_executors() → str

get_response_time() → int

Returns the node’s average response time.

get_temp_path() → str

Returns the local path to the node’s temp directory.

get_temp_size() → int

Returns the size in bytes of the node’s temp directory.

get_total_physical_memory() → int

Returns the node’s total physical memory in bytes.

get_total_swap_space() → int

Returns the node’s total swap space in bytes.

get_workspace_path() → str

Returns the local path to the node’s Jenkins workspace directory.

get_workspace_size() → int

Returns the size in bytes of the node’s Jenkins workspace directory.

is_idle() → bool

is_jnlpagent() → bool

is_online() → bool

is_temporarily_offline() → bool

launch() → None

Tries to launch a connection with the slave if it is currently disconnected. Because launching a connection with the slave does not mean it is online (a slave can be launched, but set offline), this function does not check if the launch was successful.

load_config() → None

Loads the config.xml for the node allowing it to be re-queried without generating new requests.

offline_reason() → str

set_config_element(el_name: str, value: str) → None

Sets simple config element

set_num_executors(value: int | str) → None

Sets number of executors for node

Warning! Setting number of executors on master node will erase all other settings

set_offline(message='requested from jenkinsapi') → None

Set node offline. If after run node state has not been changed raise AssertionError. : param message: optional string explain why you are taking this

node offline

set_online() → None

Set node online. Before change state verify client state: if node set ‘offline’ but ‘temporarilyOffline’ is not set - client has connection problems and AssertionError raised. If after run node state has not been changed raise AssertionError.

toggle_temporarily_offline(message='requested from jenkinsapi') → None

Switches state of connected node (online/offline) and set ‘temporarilyOffline’ property (True/False) Calling the same method again will bring node status back. :param message: optional string can be used to explain why you

are taking this node offline

update_offline_reason(reason: str) → None

Update offline reason on a temporary offline clsuter

upload_config(config_xml: str) → None

Uploads config_xml to the config.xml for the node.