High Level API. More...

#include <glib.h>
#include <libxml/tree.h>
#include <crm/cib/cib_types.h>
#include <crm/pengine/pe_types.h>
#include <crm/stonith-ng.h>

Include dependency graph for pacemaker.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	pcmk_injections_t
	Synthetic cluster events that can be injected into the cluster for running simulations. More...

Enumerations
enum	pcmk_sim_flags { pcmk_sim_none = 0, pcmk_sim_all_actions = 1 << 0, pcmk_sim_show_pending = 1 << 1, pcmk_sim_process = 1 << 2, pcmk_sim_show_scores = 1 << 3, pcmk_sim_show_utilization = 1 << 4, pcmk_sim_simulate = 1 << 5, pcmk_sim_sanitized = 1 << 6, pcmk_sim_verbose = 1 << 7 }
	Modify operation of running a cluster simulation. More...

enum	pcmk_rc_disp_flags { pcmk_rc_disp_none = 0, pcmk_rc_disp_code = (1 << 0), pcmk_rc_disp_name = (1 << 1), pcmk_rc_disp_desc = (1 << 2) }
	Bit flags to control which fields of result code info are displayed. More...

Functions
int	pcmk_controller_status (xmlNodePtr xml, const char node_name, unsigned int message_timeout_ms)
	Get and output controller status. More...

int	pcmk_designated_controller (xmlNodePtr *xml, unsigned int message_timeout_ms)
	Get and output designated controller node name. More...

void	pcmk_free_injections (pcmk_injections_t *injections)
	Free a :pcmk_injections_t structure. More...

int	pcmk_query_node_info (xmlNodePtr xml, uint32_t node_id, char node_name, char uuid, char *state, bool have_quorum, bool *is_remote, bool show_output, unsigned int message_timeout_ms)
	Get and optionally output node info corresponding to a node ID from the controller. More...

int	pcmk_pacemakerd_status (xmlNodePtr xml, const char ipc_name, unsigned int message_timeout_ms)
	Get and output `pacemakerd` status. More...

int	pcmk_resource_digests (xmlNodePtr xml, pe_resource_t rsc, const pe_node_t node, GHashTable overrides, pe_working_set_t *data_set)
	Calculate and output resource operation digests. More...

int	pcmk_simulate (xmlNodePtr xml, pe_working_set_t data_set, const pcmk_injections_t injections, unsigned int flags, unsigned int section_opts, const char use_date, const char input_file, const char graph_file, const char *dot_file)
	Simulate a cluster's response to events. More...

int	pcmk_list_nodes (xmlNodePtr xml, const char node_types)
	Get nodes list. More...

int	pcmk_status (xmlNodePtr *xml)
	Output cluster status formatted like `crm_mon --output-as=xml` More...

int	pcmk_check_rules (xmlNodePtr xml, xmlNodePtr input, const crm_time_t date, const char **rule_ids)
	Check whether each rule in a list is in effect. More...

int	pcmk_show_result_code (xmlNodePtr *xml, int code, enum pcmk_result_type type, uint32_t flags)
	Display the name and/or description of a result code. More...

int	pcmk_list_result_codes (xmlNodePtr *xml, enum pcmk_result_type type, uint32_t flags)
	List all valid result codes in a particular family. More...

Detailed Description

High Level API.

Definition in file pacemaker.h.

Enumeration Type Documentation

◆ pcmk_rc_disp_flags

enum pcmk_rc_disp_flags

Bit flags to control which fields of result code info are displayed.

Enumerator
pcmk_rc_disp_none	(Does nothing)
pcmk_rc_disp_code	Display result code number.
pcmk_rc_disp_name	Display result code name.
pcmk_rc_disp_desc	Display result code description.

Definition at line 304 of file pacemaker.h.

◆ pcmk_sim_flags

enum pcmk_sim_flags

Modify operation of running a cluster simulation.

Enumerator
pcmk_sim_none
pcmk_sim_all_actions
pcmk_sim_show_pending
pcmk_sim_process
pcmk_sim_show_scores
pcmk_sim_show_utilization
pcmk_sim_simulate
pcmk_sim_sanitized
pcmk_sim_verbose

Definition at line 34 of file pacemaker.h.

Function Documentation

◆ pcmk_check_rules()

int pcmk_check_rules	(	xmlNodePtr *	xml,
		xmlNodePtr	input,
		const crm_time_t *	date,
		const char **	rule_ids
	)

Check whether each rule in a list is in effect.

Parameters

[in,out]	xml	The destination for the result, as an XML tree
[in]	input	The CIB XML to check (if `NULL`, use current CIB)
[in]	date	Check whether the rule is in effect at this date and time (if `NULL`, use current date and time)
[in]	rule_ids	The IDs of the rules to check, as a `NULL`- terminated list.

Returns: Standard Pacemaker return code

Definition at line 279 of file pcmk_rule.c.

◆ pcmk_controller_status()

int pcmk_controller_status	(	xmlNodePtr *	xml,
		const char *	node_name,
		unsigned int	message_timeout_ms
	)

Get and output controller status.

Parameters

[in,out]	xml	Destination for the result, as an XML tree
[in]	node_name	Name of node whose status is desired (`NULL` for DC)
[in]	message_timeout_ms	How long to wait for a reply from the `pacemaker-controld` API. If 0, `pcmk_ipc_dispatch_sync` will be used. Otherwise, `pcmk_ipc_dispatch_poll` will be used.

Returns: Standard Pacemaker return code

Definition at line 497 of file pcmk_cluster_queries.c.

◆ pcmk_designated_controller()

int pcmk_designated_controller	(	xmlNodePtr *	xml,
		unsigned int	message_timeout_ms
	)

Get and output designated controller node name.

Parameters

[in,out]	xml	Destination for the result, as an XML tree
[in]	message_timeout_ms	How long to wait for a reply from the `pacemaker-controld` API. If 0, `pcmk_ipc_dispatch_sync` will be used. Otherwise, `pcmk_ipc_dispatch_poll` will be used.

Returns: Standard Pacemaker return code

Definition at line 566 of file pcmk_cluster_queries.c.

◆ pcmk_free_injections()

void pcmk_free_injections ( pcmk_injections_t * injections )

Free a :pcmk_injections_t structure.

Parameters

[in,out] injections The structure to be freed

Definition at line 765 of file pcmk_injections.c.

◆ pcmk_list_nodes()

int pcmk_list_nodes	(	xmlNodePtr *	xml,
		const char *	node_types
	)

Get nodes list.

Parameters

[in,out]	xml	The destination for the result, as an XML tree
[in]	node_types	Node type(s) to return (default: all)

Returns: Standard Pacemaker return code

Definition at line 885 of file pcmk_cluster_queries.c.

◆ pcmk_list_result_codes()

int pcmk_list_result_codes	(	xmlNodePtr *	xml,
		enum pcmk_result_type	type,
		uint32_t	flags
	)

List all valid result codes in a particular family.

Parameters

[in,out]	xml	The destination for the result, as an XML tree
[in]	type	The family of result codes to list. Supported values: `pcmk_result_legacy`, `pcmk_result_rc`, `pcmk_result_exitcode`.
[in]	flags	Group of `pcmk_rc_disp_flags`

Returns: Standard Pacemaker return code

Definition at line 151 of file pcmk_result_code.c.

◆ pcmk_pacemakerd_status()

int pcmk_pacemakerd_status	(	xmlNodePtr *	xml,
		const char *	ipc_name,
		unsigned int	message_timeout_ms
	)

Get and output pacemakerd status.

Parameters

[in,out]	xml	Destination for the result, as an XML tree
[in]	ipc_name	IPC name for request
[in]	message_timeout_ms	How long to wait for a reply from the `pacemakerd` API. If 0, `pcmk_ipc_dispatch_sync` will be used. Otherwise, `pcmk_ipc_dispatch_poll` will be used.

Returns: Standard Pacemaker return code

Definition at line 785 of file pcmk_cluster_queries.c.

◆ pcmk_query_node_info()

int pcmk_query_node_info	(	xmlNodePtr *	xml,
		uint32_t *	node_id,
		char **	node_name,
		char **	uuid,
		char **	state,
		bool *	have_quorum,
		bool *	is_remote,
		bool	show_output,
		unsigned int	message_timeout_ms
	)

Get and optionally output node info corresponding to a node ID from the controller.

Parameters

[in,out]	xml	Destination for the result, as an XML tree
[in,out]	node_id	ID of node whose name to get. If `NULL` or 0, get the local node name. If not `NULL`, store the true node ID here on success.
[out]	node_name	If not `NULL`, where to store the node name
[out]	uuid	If not `NULL`, where to store the node UUID
[out]	state	If not `NULL`, where to store the membership state
[out]	is_remote	If not `NULL`, where to store whether the node is a Pacemaker Remote node
[out]	have_quorum	If not `NULL`, where to store whether the node has quorum
[in]	show_output	Whether to output the node info
[in]	message_timeout_ms	How long to wait for a reply from the `pacemaker-controld` API. If 0, `pcmk_ipc_dispatch_sync` will be used. Otherwise, `pcmk_ipc_dispatch_poll` will be used.

Returns: Standard Pacemaker return code

Note: The caller is responsible for freeing *node_name, *uuid, and *state using free().

Definition at line 689 of file pcmk_cluster_queries.c.

◆ pcmk_resource_digests()

int pcmk_resource_digests	(	xmlNodePtr *	xml,
		pe_resource_t *	rsc,
		const pe_node_t *	node,
		GHashTable *	overrides,
		pe_working_set_t *	data_set
	)

Calculate and output resource operation digests.

Parameters

[out]	xml	Where to store XML with result
[in,out]	rsc	Resource to calculate digests for
[in]	node	Node whose operation history should be used
[in]	overrides	Hash table of configuration parameters to override
[in]	data_set	Cluster working set (with status)

Returns: Standard Pacemaker return code

Definition at line 158 of file pcmk_resource.c.

◆ pcmk_show_result_code()

int pcmk_show_result_code	(	xmlNodePtr *	xml,
		int	code,
		enum pcmk_result_type	type,
		uint32_t	flags
	)

Display the name and/or description of a result code.

Parameters

[in,out]	xml	The destination for the result, as an XML tree
[in]	code	The result code
[in]	type	Interpret `code` as this type of result code. Supported values: `pcmk_result_legacy`, `pcmk_result_rc`, `pcmk_result_exitcode`.
[in]	flags	Group of `pcmk_rc_disp_flags`

Returns: Standard Pacemaker return code

Definition at line 62 of file pcmk_result_code.c.

◆ pcmk_simulate()

int pcmk_simulate	(	xmlNodePtr *	xml,
		pe_working_set_t *	data_set,
		const pcmk_injections_t *	injections,
		unsigned int	flags,
		unsigned int	section_opts,
		const char *	use_date,
		const char *	input_file,
		const char *	graph_file,
		const char *	dot_file
	)

Simulate a cluster's response to events.

This high-level function essentially implements crm_simulate(8). It operates on an input CIB file and various lists of events that can be simulated. It optionally writes out a variety of artifacts to show the results of the simulation. Output can be modified with various flags.

Parameters

[in,out]	xml	The destination for the result, as an XML tree
[in,out]	data_set	Working set for the cluster
[in]	injections	A structure containing cluster events (node up/down, tickets, injected operations)
[in]	flags	A bitfield of :pcmk_sim_flags to modify operation of the simulation
[in]	section_opts	Which portions of the cluster status output should be displayed?
[in]	use_date	Date to set the cluster's time to (may be NULL)
[in]	input_file	The source CIB file, which may be overwritten by this function (may be NULL)
[in]	graph_file	Where to write the XML-formatted transition graph (may be NULL, in which case no file will be written)
[in]	dot_file	Where to write the dot(1) formatted transition graph (may be NULL, in which case no file will be written)

Returns: Standard Pacemaker return code

Definition at line 978 of file pcmk_simulate.c.

◆ pcmk_status()

int pcmk_status ( xmlNodePtr * xml )

Output cluster status formatted like crm_mon --output-as=xml

Parameters

[in,out] xml The destination for the result, as an XML tree

Returns: Standard Pacemaker return code

Definition at line 152 of file pcmk_status.c.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ pcmk_rc_disp_flags

◆ pcmk_sim_flags

Function Documentation

◆ pcmk_check_rules()

◆ pcmk_controller_status()

◆ pcmk_designated_controller()

◆ pcmk_free_injections()

◆ pcmk_list_nodes()

◆ pcmk_list_result_codes()

◆ pcmk_pacemakerd_status()

◆ pcmk_query_node_info()

◆ pcmk_resource_digests()

◆ pcmk_show_result_code()

◆ pcmk_simulate()

◆ pcmk_status()