diff --git a/xCAT-client-2.0/pods/man1/lsmon.1.pod b/xCAT-client-2.0/pods/man1/lsmon.1.pod new file mode 100644 index 000000000..781239bd2 --- /dev/null +++ b/xCAT-client-2.0/pods/man1/lsmon.1.pod @@ -0,0 +1,87 @@ +=head1 NAME + +B - Lists monitoring plug-in modules that can be used to monitor the xCAT cluster. + + + +=head1 SYNOPSIS + +I + +I + +I [-d|--description]> + +I + + +=head1 DESCRIPTION + +This command is used to list the status, desctiption and the settings of one or all of the monitoring plug-in modules. + + +=head1 Parameters + +I is the name of the monitoring plug-in module. + + +=head1 OPTIONS + + +B<-a | --all> Searches the I directory and reports all the monitoring plug-in modules. If nothing is specified, the list is read from the I tabel. + +B<-d | --description> Display the description of the plug-in modules. The description ususally contains the possible settings. + +B<-h | --help> Display usage message. + +B<-v | -version > Command Version. + +B<-V | -verbose> Verbose output. + + +=head1 RETURN VALUE + +0 The command completed successfully. + +1 An error has occurred. + +=head1 EXAMPLES + +1. To list the status of all the monitoring plug-in modules from the I table, enter: + + lsmon + +The output looks like this: + xcatmon monitored node-status-monitored + snmpmon not-monitored + +2. To list the status of all the monitoring plug-in modules including the ones that are not in the monitoring table, enter + + lsmon -a + +The output looks like this: + xcatmon monitored node-status-monitored + snmpmon not-monitored + gangliamon not-monitored + rmcmon monitored + nagiosmon not-monitored + + +3. To list the status and the desciption for I module, enter: + + lsmon snmpmon -d + + +=head1 FILES + +/opt/xcat/bin/lsmon + + +=head1 NOTES + +See stopmon startmon + +This command is part of the xCAT software product. + + + diff --git a/xCAT-client-2.0/pods/man1/startmon.1.pod b/xCAT-client-2.0/pods/man1/startmon.1.pod index eb41ffb38..0602e21eb 100644 --- a/xCAT-client-2.0/pods/man1/startmon.1.pod +++ b/xCAT-client-2.0/pods/man1/startmon.1.pod @@ -11,7 +11,7 @@ I I -I [-n|--nodestatmon] [-s|--settings item=value[,item=value]...]> +I [-n|--nodestatmon] [-s|--settings settings]> =head1 DESCRIPTION @@ -21,8 +21,10 @@ This command is used to register a monitoring plug-in module and invoke it to mo =head1 Parameters -I is the name of the monitoring plug-in module. For example, if the the I is called I, then the actual file name that the xcatd looks for is I. - +I is the name of the monitoring plug-in module. For example, if the the I is called I, then the actual file name that the xcatd looks for is I. Use I command to list all the monitoring plug-in modules that can be used. + +I is the monitoring plug-in specific settings. It is used to customize the behavior of the plug-in or configure the 3rd party software. Format: I<[key-value],[key=value]...> Please note that the square brackets are needed here. Use I command to look for the possbile setting keys for a plug-in module. + =head1 OPTIONS @@ -30,7 +32,7 @@ B<-h | -help> Display usage message. B<-n | -nodestatmon> Indicate that this monitoring plug-in will be used for feeding the node liveness status to the xCAT I table. -B<-s | -settings> Specifies the plug-in specific settings. These settings will be used by the plug-in to customize certain entities for the plug-in or the third party monitoring software. e.g. mon_interval=10,toggle=1. +B<-s | -settings> Specifies the plug-in specific settings. These settings will be used by the plug-in to customize certain entities for the plug-in or the third party monitoring software. e.g. [mon_interval=10],[toggle=1]. B<-v | -version > Command Version. @@ -51,11 +53,11 @@ B<-V | -verbose> Verbose output. 2. To start rmcmon plug-in module (which interacts with IBM's RSCT monitoring software) to monitor the xCAT cluster and have it feed the node liveness status to xCAT's I table, enter: - startmon rmcmon -n + startmon rmcmon -n 3. To start xcatmon plug-in module to feed the node liveness status to xCAT's I table, enter: - startmon rmcmon -n -s ping-interval=2 + startmon rmcmon -n -s [ping-interval=2] where 2 is the number of minutes between the pings. @@ -67,7 +69,7 @@ where 2 is the number of minutes between the pings. =head1 NOTES -See stopmon +See stopmon lsmon This command is part of the xCAT software product.