nodeupdown_is_node_up man page

nodeupdown_is_node_up, nodeupdown_is_node_down — test if a node is up or down

Synopsis

#include <nodeupdown.h>

int nodeupdown_is_node_up(nodeupdown_t handle, const char *node); q.sp int nodeupdown_is_node_down(nodeupdown_t handle, const char *node);

Description

nodeupdown_is_node_up() tests if the node pointed to by node is up.

nodeupdown_is_node_down() tests if the node pointed to by node is down.

The node name passed into these functions must be the shortened name of the hostname.

Return Values

For nodeupdown_is_node_up(), 1 is returned if the node is up, 0 is returned if the node is down. For nodeupdown_is_node_down(), 1 is returned if the node is down, 0 is returned if the node is up. On error, both return -1, and an error code is returned in handle. The error code can be retrieved via nodeupdown_errnum(3) , and a description of the error code can be retrieved via nodeupdown_strerror(3). Error codes are defined in nodeupdown.h.

Errors

NODEUPDOWN_ERR_NULLHANDLE
The handle parameter is NULL. The nodeupdown handle must be created with nodeupdown_handle_create(3).
NODEUPDOWN_ERR_NOTLOADED
nodeupdown_load_data(3) has not been called and no data has been retrieved.
NODEUPDOWN_ERR_PARAMETERS
An incorrect parameter has been passed in.
NODEUPDOWN_ERR_OUTMEM
malloc(3) has failed internally.
NODEUPDOWN_ERR_NOTFOUND
The node pointed to by node is not known.
NODEUPDOWN_ERR_CLUSTERLIST_MODULE
Internal error with the clusterlist module
NODEUPDOWN_ERR_HOSTLIST
Hostlist API has failed internally.
NODEUPDOWN_ERR_MAGIC
handle has an incorrect magic number. handle does not point to a nodeupdown handle or handle has been destroyed by nodeupdown_handle_destroy(3).

Files

/usr/include/nodeupdown.h

See Also

libnodeupdown(3), nodeupdown_handle_create(3), nodeupdown_load_data(3), nodeupdown_errnum(3), nodeupdown_strerror(3)

Referenced By

libnodeupdown(3).

nodeupdown_is_node_down(3) is an alias of nodeupdown_is_node_up(3).

August 2003 LLNL LIBNODEUPDOWN