fsp_plms_IsComponentDegraded()

Synopsis:

#include <fsp/plms.h>

fsp_ResultType fsp_plms_IsComponentDegraded( fsp_plms_HandleType *plms_hdl,
                                             char *node_name,
                                             bool *degraded ); 

Arguments:

plms_hdl

The plms handle returned in fsp_plms_Connect().

node_name

The name of the component or module name to get status. This is a NULL-terminated string.

degraded

The status of the component or module that will be returned by PLMS.

Library:

libplms

Use the -l plms option to qcc to link against this library.

Description:

The fsp_plms_IsComponentDegraded() returns degraded to true if the component or any of the component's child nodes isn't in the FSP_PLMS_COMPONENT_STARTED state. The caller must have the plms/query ability to use this call.

Returns:

Returns a valid degraded status and FSP_PLMS_STATUS_EOK on success, or FSP_PLMS_STATUS_FAIL on error and sets errno.

Errors:

EINVAL

Invalid input parameters.

EBADMSG

The resource manager received an invalid or combined client message.

ENOSYS

The resource manager received a client message with an incorrect extended type.

Example:

fsp_plms_GetComponentStatus(plms_hdl, “sshd”, &status);