arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added man page for lsmon command, updated man page for startmon command

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@698 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
linggao 2008-03-05 21:38:03 +00:00
parent c9165b744e
commit 0fedb40406
2 changed files with 96 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
xCAT-client-2.0/pods/man1/lsmon.1.pod Normal file
View File

@ -0,0 +1,87 @@
=head1 NAME
B<lsmon> - Lists monitoring plug-in modules that can be used to monitor the xCAT cluster.
=head1 SYNOPSIS
I<lsmon [-h| --help]>
I<lsmon [-v| --version]>
I<lsmon I<name> [-d|--description]>
I<lsmon [-a|--all] [-d|--description]>
=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<name> is the name of the monitoring plug-in module.
=head1 OPTIONS
B<-a | --all> Searches the I<XCATROOT/lib/perl/xCAT_monitoring> directory and reports all the monitoring plug-in modules. If nothing is specified, the list is read from the I<monitoring> 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<monitoring> 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<snmpmon> 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.

16
xCAT-client-2.0/pods/man1/startmon.1.pod
View File

@ -11,7 +11,7 @@ I<startmon [-h| --help]>
I<startmon [-v| --version]>
I<startmon I<name> [-n|--nodestatmon] [-s|--settings item=value[,item=value]...]>
I<startmon I<name> [-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<name> is the name of the monitoring plug-in module. For example, if the the I<name> is called I<xxx>, then the actual file name that the xcatd looks for is I</opt/xcat/lib/perl/xCAT_monitoring/xxx.pm>.
I<name> is the name of the monitoring plug-in module. For example, if the the I<name> is called I<xxx>, then the actual file name that the xcatd looks for is I</opt/xcat/lib/perl/xCAT_monitoring/xxx.pm>. Use I<lsmon -a> command to list all the monitoring plug-in modules that can be used.
I<settings> 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<lsmon name -d> 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<nodelist> 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<nodelist> 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<nodelist> 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.