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

Data Fields
int(*	free )(stonith_t *st)
	Destroy the stonith api structure. More...

int(*	connect )(stonith_t st, const char name, int *stonith_fd)
	Connect to the local stonith daemon. More...

int(*	disconnect )(stonith_t *st)
	Disconnect from the local stonith daemon. More...

int(*	remove_device )(stonith_t st, int options, const char name)
	Remove a registered stonith device with the local stonith daemon. More...

int(*	register_device )(stonith_t st, int options, const char id, const char provider, const char agent, stonith_key_value_t *params)
	Register a stonith device with the local stonith daemon. More...

int(*	remove_level )(stonith_t st, int options, const char node, int level)
	Remove a fencing level for a specific node. More...

int(*	register_level )(stonith_t st, int options, const char node, int level, stonith_key_value_t *device_list)
	Register a fencing level containing the fencing devices to be used at that level for a specific node. More...

int(*	metadata )(stonith_t st, int options, const char device, const char provider, char *output, int timeout)
	Get the metadata documentation for a resource. More...

int(*	list_agents )(stonith_t stonith, int call_options, const char provider, stonith_key_value_t **devices, int timeout)
	Retrieve a list of installed stonith agents. More...

int(*	list )(stonith_t st, int options, const char id, char **list_output, int timeout)
	Retrieve string listing hosts and port assignments from a local stonith device. More...

int(*	monitor )(stonith_t st, int options, const char id, int timeout)
	Check to see if a local stonith device is reachable. More...

int(*	status )(stonith_t st, int options, const char id, const char *port, int timeout)
	Check to see if a local stonith device's port is reachable. More...

int(*	query )(stonith_t st, int options, const char node, stonith_key_value_t **devices, int timeout)
	Retrieve a list of registered stonith devices. More...

int(*	fence )(stonith_t st, int options, const char node, const char *action, int timeout, int tolerance)
	Issue a fencing action against a node. More...

int(*	confirm )(stonith_t st, int options, const char node)
	Manually confirm that a node is down. More...

int(*	history )(stonith_t st, int options, const char node, stonith_history_t **output, int timeout)
	Retrieve a list of fencing operations that have occurred for a specific node. More...

int(*	register_notification )(stonith_t st, const char event, void(notify)(stonith_t st, stonith_event_t *e))

int(*	remove_notification )(stonith_t st, const char event)

int(*	register_callback )(stonith_t st, int call_id, int timeout, int options, void userdata, const char callback_name, void(callback)(stonith_t st, stonith_callback_data_t data))
	Register a callback to receive the result of an asynchronous call. More...

int(*	remove_callback )(stonith_t *st, int call_id, bool all_callbacks)
	Remove a registered callback for a given call id. More...

int(*	remove_level_full )(stonith_t st, int options, const char node, const char pattern, const char attr, const char *value, int level)
	Remove fencing level for specific node, node regex or attribute. More...

int(*	register_level_full )(stonith_t st, int options, const char node, const char pattern, const char attr, const char value, int level, stonith_key_value_t device_list)
	Register fencing level for specific node, node regex or attribute. More...

int(*	validate )(stonith_t st, int call_options, const char rsc_id, const char namespace_s, const char agent, stonith_key_value_t params, int timeout, char output, char *error_output)
	Validate an arbitrary stonith device configuration. More...

int(*	fence_with_delay )(stonith_t st, int options, const char node, const char *action, int timeout, int tolerance, int delay)
	Issue a fencing action against a node with requested fencing delay. More...

Detailed Description

Definition at line 138 of file stonith-ng.h.

Field Documentation

◆ confirm

int(* stonith_api_operations_s::confirm) (stonith_t *st, int options, const char *node)

Manually confirm that a node is down.

Return values

0	success
negative	error code on failure.

Definition at line 287 of file stonith-ng.h.

◆ connect

int(* stonith_api_operations_s::connect) (stonith_t *st, const char *name, int *stonith_fd)

Connect to the local stonith daemon.

Return values

0,success
negative	error code on failure

Definition at line 151 of file stonith-ng.h.

◆ disconnect

int(* stonith_api_operations_s::disconnect) (stonith_t *st)

Disconnect from the local stonith daemon.

Return values

0,success
negative	error code on failure

Definition at line 159 of file stonith-ng.h.

◆ fence

int(* stonith_api_operations_s::fence) (stonith_t *st, int options, const char *node, const char *action, int timeout, int tolerance)

Issue a fencing action against a node.

Note: Possible actions are, 'on', 'off', and 'reboot'.

Parameters

st,stonith	connection
options,call	options
node,The	target node to fence
action,The	fencing action to take
timeout,The	default per device timeout to use with each device capable of fencing the target.

Return values

0	success
negative	error code on failure.

Definition at line 278 of file stonith-ng.h.

◆ fence_with_delay

int(* stonith_api_operations_s::fence_with_delay) (stonith_t *st, int options, const char *node, const char *action, int timeout, int tolerance, int delay)

Issue a fencing action against a node with requested fencing delay.

Note: Possible actions are, 'on', 'off', and 'reboot'.

Parameters

st,stonith	connection
options,call	options
node,The	target node to fence
action,The	fencing action to take
timeout,The	default per device timeout to use with each device capable of fencing the target.
delay,Apply	a fencing delay. Value -1 means disable also any static/random fencing delays from pcmk_delay_base/max

Return values

0	success
negative	error code on failure.

Definition at line 412 of file stonith-ng.h.

◆ free

int(* stonith_api_operations_s::free) (stonith_t *st)

Destroy the stonith api structure.

Definition at line 143 of file stonith-ng.h.

◆ history

int(* stonith_api_operations_s::history) (stonith_t *st, int options, const char *node, stonith_history_t **output, int timeout)

Retrieve a list of fencing operations that have occurred for a specific node.

Return values

0	success
negative	error code on failure.

Definition at line 295 of file stonith-ng.h.

◆ list

int(* stonith_api_operations_s::list) (stonith_t *st, int options, const char *id, char **list_output, int timeout)

Retrieve string listing hosts and port assignments from a local stonith device.

Return values

0	on success
negative	error code on failure

Definition at line 233 of file stonith-ng.h.

◆ list_agents

int(* stonith_api_operations_s::list_agents) (stonith_t *stonith, int call_options, const char *provider, stonith_key_value_t **devices, int timeout)

Retrieve a list of installed stonith agents.

Note: if provider is not provided, all known agents will be returned; list must be freed using stonith_key_value_freeall(); call_options parameter is not used, it is reserved for future use.

Return values

num	items in list on success
negative	error code on failure

Definition at line 224 of file stonith-ng.h.

◆ metadata

int(* stonith_api_operations_s::metadata) (stonith_t *st, int options, const char *device, const char *provider, char **output, int timeout)

Get the metadata documentation for a resource.

Note: Value is returned in output. Output must be freed when set.

Return values

0	success
negative	error code on failure

Definition at line 211 of file stonith-ng.h.

◆ monitor

int(* stonith_api_operations_s::monitor) (stonith_t *st, int options, const char *id, int timeout)

Check to see if a local stonith device is reachable.

Return values

0	on success
negative	error code on failure

Definition at line 241 of file stonith-ng.h.

◆ query

int(* stonith_api_operations_s::query) (stonith_t *st, int options, const char *node, stonith_key_value_t **devices, int timeout)

Retrieve a list of registered stonith devices.

Note: If node is provided, only devices that can fence the node id will be returned.

Return values

num	items in list on success
negative	error code on failure

Definition at line 260 of file stonith-ng.h.

◆ register_callback

int(* stonith_api_operations_s::register_callback) (stonith_t *st, int call_id, int timeout, int options, void *userdata, const char *callback_name, void(*callback)(stonith_t *st, stonith_callback_data_t *data))

Register a callback to receive the result of an asynchronous call.

Parameters

[in]	call_id	The call ID to register callback for
[in]	timeout	Default time to wait until callback expires
[in]	options	Bitmask of `stonith_call_options` (respects `st_opt_timeout_updates` and `st_opt_report_only_success`)
[in]	userdata	Pointer that will be given to callback
[in]	callback_name	Unique name to identify callback
[in]	callback	The callback function to register

Returns: TRUE on success, FALSE if call_id is negative, -errno otherwise

Todo:: This function should return pcmk_ok on success, and call_id when negative, but that would break backward compatibility.

Definition at line 319 of file stonith-ng.h.

◆ register_device

int(* stonith_api_operations_s::register_device) (stonith_t *st, int options, const char *id, const char *provider, const char *agent, stonith_key_value_t *params)

Register a stonith device with the local stonith daemon.

Note: Synchronous, guaranteed to occur in daemon before function returns.

Return values

0,success
negative	error code on failure

Definition at line 180 of file stonith-ng.h.

◆ register_level

int(* stonith_api_operations_s::register_level) (stonith_t *st, int options, const char *node, int level, stonith_key_value_t *device_list)

Register a fencing level containing the fencing devices to be used at that level for a specific node.

Return values

0,success
negative	error code on failure

Definition at line 200 of file stonith-ng.h.

◆ register_level_full

int(* stonith_api_operations_s::register_level_full) (stonith_t *st, int options, const char *node, const char *pattern, const char *attr, const char *value, int level, stonith_key_value_t *device_list)

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

Parameters

[in]	st	Fencer connection to use
[in]	options	Bitmask of stonith_call_options to pass to fencer
[in]	node	If not NULL, target level by this node name
[in]	pattern	If not NULL, target by node name using this regex
[in]	attr	If not NULL, target by this node attribute
[in]	value	If not NULL, target by this node attribute value
[in]	level	Index number of level to add
[in]	device_list	Devices to use in level

Returns: 0 on success, negative error code otherwise

Note: The caller should set only one of node, pattern or attr/value.

Definition at line 367 of file stonith-ng.h.

◆ register_notification

int(* stonith_api_operations_s::register_notification) (stonith_t *st, const char *event, void(*notify)(stonith_t *st, stonith_event_t *e))

Definition at line 297 of file stonith-ng.h.

◆ remove_callback

int(* stonith_api_operations_s::remove_callback) (stonith_t *st, int call_id, bool all_callbacks)

Remove a registered callback for a given call id.

Definition at line 330 of file stonith-ng.h.

◆ remove_device

int(* stonith_api_operations_s::remove_device) (stonith_t *st, int options, const char *name)

Remove a registered stonith device with the local stonith daemon.

Note: Synchronous, guaranteed to occur in daemon before function returns.

Return values

0,success
negative	error code on failure

Definition at line 169 of file stonith-ng.h.

◆ remove_level

int(* stonith_api_operations_s::remove_level) (stonith_t *st, int options, const char *node, int level)

Remove a fencing level for a specific node.

Return values

0,success
negative	error code on failure

Definition at line 190 of file stonith-ng.h.

◆ remove_level_full

int(* stonith_api_operations_s::remove_level_full) (stonith_t *st, int options, const char *node, const char *pattern, const char *attr, const char *value, int level)

Remove fencing level for specific node, node regex or attribute.

Parameters

[in]	st	Fencer connection to use
[in]	options	Bitmask of stonith_call_options to pass to the fencer
[in]	node	If not NULL, target level by this node name
[in]	pattern	If not NULL, target by node name using this regex
[in]	attr	If not NULL, target by this node attribute
[in]	value	If not NULL, target by this node attribute value
[in]	level	Index number of level to remove

Returns: 0 on success, negative error code otherwise

Note: The caller should set only one of node, pattern or attr/value.

Definition at line 347 of file stonith-ng.h.

◆ remove_notification

int(* stonith_api_operations_s::remove_notification) (stonith_t *st, const char *event)

Definition at line 300 of file stonith-ng.h.

◆ status

int(* stonith_api_operations_s::status) (stonith_t *st, int options, const char *id, const char *port, int timeout)

Check to see if a local stonith device's port is reachable.

Return values

0	on success
negative	error code on failure

Definition at line 249 of file stonith-ng.h.

◆ validate

int(* stonith_api_operations_s::validate) (stonith_t *st, int call_options, const char *rsc_id, const char *namespace_s, const char *agent, stonith_key_value_t *params, int timeout, char **output, char **error_output)

Validate an arbitrary stonith device configuration.

Parameters

[in]	st	Stonithd connection to use
[in]	call_options	Bitmask of stonith_call_options to use with fencer
[in]	rsc_id	ID used to replace CIB secrets in params
[in]	namespace_s	Namespace of fence agent to validate (optional)
[in]	agent	Fence agent to validate
[in]	params	Configuration parameters to pass to fence agent
[in]	timeout	Fail if no response within this many seconds
[out]	output	If non-NULL, where to store any agent output
[out]	error_output	If non-NULL, where to store agent error output

Returns: pcmk_ok if validation succeeds, -errno otherwise

Note: If pcmk_ok is returned, the caller is responsible for freeing the output (if requested).

Definition at line 390 of file stonith-ng.h.

The documentation for this struct was generated from the following file:

include/crm/stonith-ng.h

Data Fields

Detailed Description

Field Documentation

◆ confirm

◆ connect

◆ disconnect

◆ fence

◆ fence_with_delay

◆ free

◆ history

◆ list

◆ list_agents

◆ metadata

◆ monitor

◆ query

◆ register_callback

◆ register_device

◆ register_level

◆ register_level_full

◆ register_notification

◆ remove_callback

◆ remove_device

◆ remove_level

◆ remove_level_full

◆ remove_notification

◆ status

◆ validate