Pods for new monitoring commands

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@267 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd

xCAT-client-2.0/pods/man1/regnotif.1.pod

@@ -0,0 +1,65 @@
+=head1 NAME
+ 
+B<regnotif> - Registers a Perl module or a command that will get called when changes occur in the desired xCAT database tables.
+  
+ 
+=head1 SYNOPSIS
+ 
+I<regnotif [-h| --help]>
+
+I<regnotif  [-v| --version]>
+
+
+I<regnotif I<filename tablename>[,tablename]... [-o|--operation actions]>
+
+
+=head1 DESCRIPTION
+
+This command is used to register a Perl module or a command to the xCAT notification table. Once registered, the module or the command will get called when changes occur in the xCAT database tables indicated by tablename. The changes can be row addition, deletion and update which are specified by actions.
+
+
+=head1 Parameters
+
+I<filename> is the full path name of the Perl module or command to be registered. 
+I<tablename> is the name of the table that the user is interested in. 
+
+=head1 OPTIONS
+
+
+B<-h | -help>          Display usage message.
+
+B<-v | -version >      Command Version. 
+
+B<-V | -verbose>       Verbose output. 
+
+B<-o | -operation>     specifies the database table actions that the user is interested in. It is a comma separated list. 'a' for row addition, 'd' for row deletion and 'u' for row update. 
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+1. To register a Perl module that gets invoked when rows get added or deleted.  in the nodelist and the nodehm tables, enter:
+
+ regnotif /opt/xcat/lib/perl/xCAT_monitoring/mycode.pm nodelist,nodhm -o a,d
+										   
+2. To register a command that gets invoked when rows get updated in the switch table, enter:
+
+regnotif /usr/bin/mycmd switch  -o u
+
+=head1 FILES
+ 
+/opt/xcat/bin/regnotif
+
+
+=head1 NOTES
+
+See unregnotif
+
+This command is part of the xCAT software product.
+
+
+ 

xCAT-client-2.0/pods/man1/startmon.1.pod

@@ -0,0 +1,62 @@
+=head1 NAME
+ 
+B<startmon> - Starts a list of plug-in modules  to monitor the xCAT cluster.
+
+  
+ 
+=head1 SYNOPSIS
+ 
+I<startmon [-h| --help]>
+
+I<startmon  [-v| --version]>
+
+
+I<startmon I<name>[,I<name>...]>
+
+
+=head1 DESCRIPTION
+
+This command is used to manually start a list of monitoring plug-in modules to monitor the xCAT cluster.  A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. The plug-in modules must have been registered in the xCAT I<monitoring> database table. A registered plug-in module is usually automatically started by xCAT when xcatd starts or when it is first registered.  
+This command is used only when the user stopped it manually using the I<stopmon> command and would like to restart it again.       
+
+=head1 Parameters
+
+I<name> is the name of the monitoring plug-in module in the monitoring table.
+
+=head1 OPTIONS
+
+
+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 start gangliamon plug-in module (which interacts with Ganglia monitoring software)to monitor xCAT cluster, enter:
+
+  startmon gangliamon
+
+Please note that gangliamon  must have been registered in the xCAT I<monitoring> table. For a list of registered the monitoring software, use command tabdump monitoring. Refer to "monitoring plug-in infrastructure" in xCAT documents on how to register a 3rd party software to monitor xCAT cluster. 
+
+=head1 FILES 
+ 
+/opt/xcat/bin/startmon
+
+
+=head1 NOTES
+
+See stopmon
+
+This command is part of the xCAT software product.
+
+
+ 

xCAT-client-2.0/pods/man1/stopmon.1.pod

@@ -0,0 +1,61 @@
+=head1 NAME
+ 
+B<stopmon> -  stops a list of monitoring plug-in modules to monitor the xCAT cluster.
+
+ 
+=head1 SYNOPSIS
+ 
+I<stopmon [-h| --help]>
+
+I<stopmon  [-v| --version]>
+
+
+I<stopmon name[,name...]>
+
+
+=head1 DESCRIPTION
+
+This command is used to manually stop a list of monitoring plug-in modules to monitor the xCAT cluster. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. The plug-in modules must have been registered in the xCAT I<monitoring> database table.  The registered plug-in modules is usually automatically started by xCAT when xcatd starts or when it is first registered.       
+
+=head1 Parameters
+
+I<name> name is the name of the monitoring plug-in module in the monitoring table. 
+
+=head1 OPTIONS
+
+
+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 stop gangliamon plug-in module (which interacts with Ganglia monitoring software) and rmcmon plug-in module (which interacts with RMC) to monitor xCAT cluster, enter:
+
+  stopmon gangliamon,rmcmon
+
+Please note that gangliamon and rmcmon must have been registered in the xCAT I<monitoring> table. For a list of registered plug-in modules, use command I<tabdump monitoring>. Refer to "monitoring plug-in infrastructure" in xCAT documents on how to register a monitoring plug-in module to monitor xCAT cluster. 
+
+
+=head1 FILES 
+ 
+/opt/xcat/bin/stopmon
+
+
+=head1 NOTES
+
+See startmon
+
+This command is part of the xCAT software product.
+
+
+ 

xCAT-client-2.0/pods/man1/unregnotif.1.pod

@@ -0,0 +1,62 @@
+=head1 NAME
+ 
+B<unregnotif> - unregister a Perl module or a command that was watching for the changes of  the desired xCAT database tables.
+  
+ 
+=head1 SYNOPSIS
+ 
+I<unregnotif [-h| --help]>
+
+I<unregnotif  [-v| --version]>
+
+
+I<unregnotif  I<filename>>
+
+
+=head1 DESCRIPTION
+
+This command is used to unregistered a Perl module or a command that was watching for the changes of the desired xCAT database tables. 
+
+
+=head1 Parameters
+
+I<filename> is the full path name of the Perl module or command to be registered. 
+
+=head1 OPTIONS
+
+
+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 unregistered a Perl module, enter:
+
+  unregnotif /opt/xcat/lib/perl/xCAT_monitoring/mycode.pm 
+							
+2. To register a command, enter:
+
+  unregnotif /usr/bin/mycmd 
+
+=head1 FILES
+ 
+/opt/xcat/bin/unregnotif
+
+
+=head1 NOTES
+
+See regnotif
+
+This command is part of the xCAT software product.
+
+
+