pmgetchildrenstatus(3) [centos man page]

PMGETCHILDRENSTATUS(3)					     Library Functions Manual					    PMGETCHILDRENSTATUS(3)

NAME

       pmGetChildrenStatus - return the descendent nodes of a PMNS node and their respective status

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmGetChildrenStatus(const char *name, char ***offspring, int **status);

       cc ... -lpcp

DESCRIPTION

       Given a fully qualified pathname to a node in the current Performance Metrics Name Space (PMNS), as identified by name, pmGetChildrenStatus
       returns via offspring a list of the relative names of all of the immediate descendent nodes of name in the current PMNS.

       As a special case, if name is an empty string (i.e.""), the immediate descendants of the root node in the PMNS will be returned.

       If status is not NULL, then pmGetChildrenStatus will also return the status of each child via status.  The status will refer  to  either  a
       leaf node (with value PMNS_LEAF_STATUS ) or a non-leaf node (with value PMNS_NONLEAF_STATUS ).

       Normally,  pmGetChildrenStatus  will return the number of descendent names discovered, else a value less than zero for an error.  The value
       zero indicates that name is a valid metric name, i.e. is associated with a leaf node in the PMNS.

       The resulting list of pointers offspring and the values (the relative names) that the  pointers	reference  will  have  been  allocated	by
       pmGetChildrenStatus  with a single call to malloc(3C), and it is the responsibility of the pmGetChildrenStatus caller to free(offspring) to
       release the space when it is no longer required.  The same holds true for the status array.

       When an error occurs, or name is a leaf node (i.e. the result of pmGetChildrenStatus is less than one), both offspring and status are unde-
       fined (no space will have been allocated, and so calling free(3C) is a singularly bad idea).

PCP ENVIRONMENT

       Environment  variables  with  the prefix PCP_ are used to parameterize the file and directory names used by PCP.  On each installation, the
       file /etc/pcp.conf contains the local values for these variables.  The $PCP_CONF variable may be used to specify an alternative	configura-
       tion file, as described in pcp.conf(5).	Values for these variables may be obtained programmatically using the pmGetConfig(3) function.

SEE ALSO

       PMAPI(3),   pmGetChildren(3),  pmGetConfig(3),  pmLoadASCIINameSpace(3),  pmLoadNameSpace(3),  pmLookupName(3),	pmNameID(3),  pcp.conf(5),
       pcp.env(5) and pmns(5).

DIAGNOSTICS

       PM_ERR_NOPMNS
	      Failed to access a PMNS for operation.  Note that if the application hasn't a priori called pmLoadNameSpace(3) and wants to use  the
	      distributed PMNS, then a call to pmGetChildrenStatus must be made inside a current context.

       PM_ERR_NAME
	      The pathname name is not valid in the current PMNS

       PM_ERR_*
	      Other diagnostics are for protocol failures when accessing the distributed PMNS.

Performance Co-Pilot							PCP						    PMGETCHILDRENSTATUS(3)

Check Out this Related Man Page

PMNSDEL(1)						      General Commands Manual							PMNSDEL(1)

NAME

       pmnsdel - delete a subtree of names from the Performance Co-Pilot PMNS

SYNOPSIS

       $PCP_BINADM_DIR/pmnsdel [-d] [-n namespace] metricpath [ ... ]

DESCRIPTION

       pmnsdel	removes  subtrees  of  names  from  a Performance Metrics Name Space (PMNS), as used by the components of the Performance Co-Pilot
       (PCP).

       Normally pmnsdel operates on the default Performance Metrics Namespace (PMNS), however if the -n option is specified an alternative  names-
       pace is used from the file namespace.

       The  default  PMNS is found in the file $PCP_VAR_DIR/pmns/root unless the environment variable PMNS_DEFAULT is set, in which case the value
       is assumed to be the pathname to the file containing the default PMNS.

       The metric names to be deleted are all those for which one of the metricpath arguments is a prefix in the PMNS, see pmns(5).

       All of the files defining the PMNS must be located within the directory that contains the root of the PMNS, and	this  would  typically	be
       $PCP_VAR_DIR/pmns for the default PMNS, and this would typically imply running pmnsdel as root.

       Provided  some  initial	integrity  checks are satisfied, pmnsdel will update the necessary PMNS files.	Should an error be encountered the
       original namespace is restored.	Note that any PMNS files that are no longer referenced by the modified namespace will not be removed, even
       though their contents are not part of the new namespace.

       The  -d option allows the resultant PMNS to optionally contain duplicate PMIDs with different names in the PMNS.  By default this condition
       is considered an error.

CAVEAT

       Once the writing of the new namespace file has begun, the signals SIGINT, SIGHUP and SIGTERM will be ignored to protect	the  integrity	of
       the new files.

FILES

       $PCP_VAR_DIR/pmns/root	the default PMNS, when then environment variable PMNS_DEFAULT is unset

PCP ENVIRONMENT

       Environment  variables  with  the prefix PCP_ are used to parameterize the file and directory names used by PCP.  On each installation, the
       file /etc/pcp.conf contains the local values for these variables.  The $PCP_CONF variable may be used to specify an alternative	configura-
       tion file, as described in pcp.conf(5).

SEE ALSO

       pmnsadd(1), pmnsmerge(1), pcp.conf(5), pcp.env(5) and pmns(5).

Performance Co-Pilot							PCP								PMNSDEL(1)

Linux and UNIX Man Pages

pmgetchildrenstatus(3) [centos man page]

Check Out this Related Man Page