#include <crm/stonith-ng.h>
#include <crm/common/output_internal.h>

Include dependency graph for pcmki_fence.h:

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

Enumerations
enum	pcmk__fence_history { pcmk__fence_history_none, pcmk__fence_history_reduced, pcmk__fence_history_full }
	Control how much of the fencing history is output. More...

Functions
int	pcmk__request_fencing (stonith_t st, const char target, const char action, const char name, unsigned int timeout, unsigned int tolerance, int delay, char **reason)
	Ask the cluster to perform fencing. More...

int	pcmk__fence_history (pcmk__output_t out, stonith_t st, char *target, unsigned int timeout, int verbose, bool broadcast, bool cleanup)
	List the fencing operations that have occurred for a specific node. More...

int	pcmk__fence_installed (pcmk__output_t out, stonith_t st, unsigned int timeout)
	List all installed STONITH agents. More...

int	pcmk__fence_last (pcmk__output_t out, const char target, bool as_nodeid)
	When was a device last fenced? More...

int	pcmk__fence_list_targets (pcmk__output_t out, stonith_t st, const char *device_id, unsigned int timeout)
	List nodes that can be fenced. More...

int	pcmk__fence_metadata (pcmk__output_t out, stonith_t st, char *agent, unsigned int timeout)
	Get metadata for a resource. More...

int	pcmk__fence_registered (pcmk__output_t out, stonith_t st, char *target, unsigned int timeout)
	List registered fence devices. More...

int	pcmk__fence_register_level (stonith_t st, char target, int fence_level, stonith_key_value_t *devices)
	Register a fencing level for a specific node, node regex, or attribute. More...

int	pcmk__fence_unregister_level (stonith_t st, char target, int fence_level)
	Unregister a fencing level for a specific node, node regex, or attribute. More...

int	pcmk__fence_validate (pcmk__output_t out, stonith_t st, const char agent, const char id, stonith_key_value_t *params, unsigned int timeout)
	Validate a STONITH device configuration. More...

int	pcmk__get_fencing_history (stonith_t st, stonith_history_t *stonith_history, enum pcmk__fence_history fence_history)
	Fetch STONITH history, optionally reducing it. More...

Enumeration Type Documentation

◆ pcmk__fence_history

enum pcmk__fence_history

Control how much of the fencing history is output.

Enumerator
pcmk__fence_history_none
pcmk__fence_history_reduced
pcmk__fence_history_full

Definition at line 18 of file pcmki_fence.h.

Function Documentation

◆ pcmk__fence_history()

int pcmk__fence_history	(	pcmk__output_t *	out,
		stonith_t *	st,
		char *	target,
		unsigned int	timeout,
		int	verbose,
		bool	broadcast,
		bool	cleanup
	)

List the fencing operations that have occurred for a specific node.

Note: This is the internal version of pcmk_fence_history(). External users of the pacemaker API should use that function instead.; out should be initialized with pcmk__output_new() before calling this function and destroyed with out->finish and pcmk__output_free() before reusing it with any other functions in this library.

Parameters

[in,out]	out	The output functions structure.
[in]	st	A connection to the STONITH API.
[in]	target	The node to get history for.
[in]	timeout	How long to wait for the operation to complete (in ms).
[in]	verbose	Include additional output.
[in]	broadcast	Gather fencing history from all nodes.
[in]	cleanup	Clean up fencing history after listing.

Returns: Standard Pacemaker return code

Definition at line 229 of file pcmk_fence.c.

◆ pcmk__fence_installed()

int pcmk__fence_installed	(	pcmk__output_t *	out,
		stonith_t *	st,
		unsigned int	timeout
	)

List all installed STONITH agents.

Note: This is the internal version of pcmk_fence_installed(). External users of the pacemaker API should use that function instead.; out should be initialized with pcmk__output_new() before calling this function and destroyed with out->finish and pcmk__output_free() before reusing it with any other functions in this library.

Parameters

[in,out]	out	The output functions structure.
[in]	st	A connection to the STONITH API.
[in]	timeout	How long to wait for the operation to complete (in ms).

Returns: Standard Pacemaker return code

Definition at line 319 of file pcmk_fence.c.

◆ pcmk__fence_last()

int pcmk__fence_last	(	pcmk__output_t *	out,
		const char *	target,
		bool	as_nodeid
	)

When was a device last fenced?

Note: This is the internal version of pcmk_fence_last(). External users of the pacemaker API should use that function instead.; out should be initialized with pcmk__output_new() before calling this function and destroyed with out->finish and pcmk__output_free() before reusing it with any other functions in this library.

Parameters

[in,out]	out	The output functions structure.
[in]	target	The node that was fenced.
[in]	as_nodeid

Returns: Standard Pacemaker return code

Definition at line 359 of file pcmk_fence.c.

◆ pcmk__fence_list_targets()

int pcmk__fence_list_targets	(	pcmk__output_t *	out,
		stonith_t *	st,
		const char *	device_id,
		unsigned int	timeout
	)

List nodes that can be fenced.

Note: This is the internal version of pcmk_fence_list_targets(). External users of the pacemaker API should use that function instead.; out should be initialized with pcmk__output_new() before calling this function and destroyed with out->finish and pcmk__output_free() before reusing it with any other functions in this library.

Parameters

[in,out]	out	The output functions structure
[in]	st	A connection to the STONITH API
[in]	device_id	Resource ID of fence device to check
[in]	timeout	How long to wait for the operation to complete (in ms)

Returns: Standard Pacemaker return code

Definition at line 395 of file pcmk_fence.c.

◆ pcmk__fence_metadata()

int pcmk__fence_metadata	(	pcmk__output_t *	out,
		stonith_t *	st,
		char *	agent,
		unsigned int	timeout
	)

Get metadata for a resource.

Note: This is the internal version of pcmk_fence_metadata(). External users of the pacemaker API should use that function instead.; out should be initialized with pcmk__output_new() before calling this function and destroyed with out->finish and pcmk__output_free() before reusing it with any other functions in this library.

Parameters

[in,out]	out	The output functions structure.
[in]	st	A connection to the STONITH API.
[in]	agent	The fence agent to get metadata for.
[in]	timeout	How long to wait for the operation to complete (in ms).

Returns: Standard Pacemaker return code

Definition at line 440 of file pcmk_fence.c.

◆ pcmk__fence_register_level()

int pcmk__fence_register_level	(	stonith_t *	st,
		char *	target,
		int	fence_level,
		stonith_key_value_t *	devices
	)

Register a fencing level for a specific node, node regex, or attribute.

Note: This is the internal version of pcmk_fence_register_level(). External users of the pacemaker API should use that function instead.

target can take three different forms:

name=value, in which case target is an attribute.
, in which case target is a node regex.
Otherwise, target is a node name.

Parameters

[in]	st	A connection to the STONITH API.
[in]	target	The object to register a fencing level for.
[in]	fence_level	Index number of level to add.
[in]	devices	Devices to use in level.

Returns: Standard Pacemaker return code

Definition at line 522 of file pcmk_fence.c.

◆ pcmk__fence_registered()

int pcmk__fence_registered	(	pcmk__output_t *	out,
		stonith_t *	st,
		char *	target,
		unsigned int	timeout
	)

List registered fence devices.

Note: This is the internal version of pcmk_fence_metadata(). External users of the pacemaker API should use that function instead.; out should be initialized with pcmk__output_new() before calling this function and destroyed with out->finish and pcmk__output_free() before reusing it with any other functions in this library.

Parameters

[in,out]	out	The output functions structure.
[in]	st	A connection to the STONITH API.
[in]	target	If not NULL, only return devices that can fence this node.
[in]	timeout	How long to wait for the operation to complete (in ms).

Returns: Standard Pacemaker return code

Definition at line 476 of file pcmk_fence.c.

◆ pcmk__fence_unregister_level()

int pcmk__fence_unregister_level	(	stonith_t *	st,
		char *	target,
		int	fence_level
	)

Unregister a fencing level for a specific node, node regex, or attribute.

Note: This is the internal version of pcmk_fence_unregister_level(). External users of the pacemaker API should use that function instead.

target can take three different forms:

name=value, in which case target is an attribute.
, in which case target is a node regex.
Otherwise, target is a node name.

Parameters

[in]	st	A connection to the STONITH API.
[in]	target	The object to unregister a fencing level for.
[in]	fence_level	Index number of level to remove.

Returns: Standard Pacemaker return code

Definition at line 536 of file pcmk_fence.c.

◆ pcmk__fence_validate()

int pcmk__fence_validate	(	pcmk__output_t *	out,
		stonith_t *	st,
		const char *	agent,
		const char *	id,
		stonith_key_value_t *	params,
		unsigned int	timeout
	)

Validate a STONITH device configuration.

Note: This is the internal version of pcmk_stonith_validate(). External users of the pacemaker API should use that function instead.; out should be initialized with pcmk__output_new() before calling this function and destroyed with out->finish and pcmk__output_free() before reusing it with any other functions in this library.

Parameters

[in,out]	out	The output functions structure.
[in]	st	A connection to the STONITH API.
[in]	agent	The agent to validate (for example, "fence_xvm").
[in]	id	STONITH device ID (may be NULL).
[in]	params	STONITH device configuration parameters.
[in]	timeout	How long to wait for the operation to complete (in ms).

Returns: Standard Pacemaker return code

Definition at line 548 of file pcmk_fence.c.

◆ pcmk__get_fencing_history()

int pcmk__get_fencing_history	(	stonith_t *	st,
		stonith_history_t **	stonith_history,
		enum pcmk__fence_history	fence_history
	)

Fetch STONITH history, optionally reducing it.

Parameters

[in]	st	The STONITH API object
[out]	stonith_history	Destination for storing the history
[in]	fence_history	How much of the fencing history to display?

Returns: Standard Pacemaker return code

Definition at line 583 of file pcmk_fence.c.

◆ pcmk__request_fencing()

int pcmk__request_fencing	(	stonith_t *	st,
		const char *	target,
		const char *	action,
		const char *	name,
		unsigned int	timeout,
		unsigned int	tolerance,
		int	delay,
		char **	reason
	)

Ask the cluster to perform fencing.

Note: This is the internal version of pcmk_request_fencing(). External users of the pacemaker API should use that function instead.

Parameters

[in]	st	A connection to the fencer API
[in]	target	The node that should be fenced
[in]	action	The fencing action (on, off, reboot) to perform
[in]	name	Who requested the fence action?
[in]	timeout	How long to wait for the operation to complete (in ms)
[in]	tolerance	If a successful action for `target` happened within this many milliseconds, return success without performing the action again
[in]	delay	Apply this delay (in milliseconds) before initiating the fencing action (a value of -1 applies no delay and also disables any fencing delay from pcmk_delay_base and pcmk_delay_max)
[out]	reason	If not NULL, where to put descriptive failure reason

Returns: Standard Pacemaker return code

Note: If reason is not NULL, the caller is responsible for freeing its returned value.

Todo:: delay is eventually used with g_timeout_add() and should be guint

Definition at line 182 of file pcmk_fence.c.

Enumerations

Functions

Enumeration Type Documentation

◆ pcmk__fence_history

Function Documentation

◆ pcmk__fence_history()

◆ pcmk__fence_installed()

◆ pcmk__fence_last()

◆ pcmk__fence_list_targets()

◆ pcmk__fence_metadata()

◆ pcmk__fence_register_level()

◆ pcmk__fence_registered()

◆ pcmk__fence_unregister_level()

◆ pcmk__fence_validate()

◆ pcmk__get_fencing_history()

◆ pcmk__request_fencing()