modified man pages for startmon and stopmon
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@296 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
linggao
parent
5c5b04570f
commit
5319502b14
@ -1,6 +1,6 @@
|
||||
=head1 NAME
|
||||
|
||||
B<startmon> - Starts a list of plug-in modules to monitor the xCAT cluster.
|
||||
B<startmon> - Starts a plug-in module to monitor the xCAT cluster.
|
||||
|
||||
|
||||
|
||||
@ -11,21 +11,23 @@ I<startmon [-h| --help]>
|
||||
I<startmon [-v| --version]>
|
||||
|
||||
|
||||
I<startmon I<name>[,I<name>...]>
|
||||
I<startmon I<name> [-n|--nodestatmon]>
|
||||
|
||||
|
||||
=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.
|
||||
This command is used to register a monitoring plug-in module and invoke it 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 module will be registered in the xCAT I<monitoring> database table. A registered plug-in module is automatically started by the I<xcatd>.
|
||||
|
||||
|
||||
=head1 Parameters
|
||||
|
||||
I<name> is the name of the monitoring plug-in module in the monitoring table.
|
||||
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>.
|
||||
|
||||
=head1 OPTIONS
|
||||
|
||||
|
||||
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<-h | -help> Display usage message.
|
||||
|
||||
B<-v | -version > Command Version.
|
||||
@ -41,11 +43,14 @@ B<-V | -verbose> Verbose output.
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
1. To start gangliamon plug-in module (which interacts with Ganglia monitoring software)to monitor xCAT cluster, enter:
|
||||
1. To start gangliamon plug-in module (which interacts with Ganglia monitoring software) to monitor the 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.
|
||||
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
|
||||
|
||||
|
||||
=head1 FILES
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
=head1 NAME
|
||||
|
||||
B<stopmon> - stops a list of monitoring plug-in modules to monitor the xCAT cluster.
|
||||
B<stopmon> - Stops a monitoring plug-in module to monitor the xCAT cluster.
|
||||
|
||||
|
||||
=head1 SYNOPSIS
|
||||
@ -10,16 +10,16 @@ I<stopmon [-h| --help]>
|
||||
I<stopmon [-v| --version]>
|
||||
|
||||
|
||||
I<stopmon name[,name...]>
|
||||
I<stopmon 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.
|
||||
This command is used to unregister a monitoring plug-in module from the I<monitoring> table. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. Once unregistered, xCAT will ask the monitoring plug-in to stop the 3rd party software to monitor the xCAT cluster.
|
||||
|
||||
=head1 Parameters
|
||||
|
||||
I<name> name is the name of the monitoring plug-in module in the monitoring table.
|
||||
I<name> is the name of the monitoring plug-in module in the I<monitoring> table.
|
||||
|
||||
=head1 OPTIONS
|
||||
|
||||
@ -39,11 +39,12 @@ B<-V | -verbose> Verbose output.
|
||||
|
||||
=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:
|
||||
1.To stop gangliamon plug-in module (which interacts with Ganglia monitoring software) to monitor the xCAT cluster, enter:
|
||||
|
||||
stopmon gangliamon,rmcmon
|
||||
stopmon gangliamon
|
||||
|
||||
Please note that gangliamon must have been registered in the xCAT I<monitoring> table. For a list of registered plug-in modules, use command I<tabdump monitoring>.
|
||||
|
||||
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
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
.\" Automatically generated by Pod::Man version 1.02
|
||||
.\" Tue Jan 15 09:10:17 2008
|
||||
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
|
||||
.\"
|
||||
.\" Standard preamble:
|
||||
.\" ======================================================================
|
||||
.\" ========================================================================
|
||||
.de Sh \" Subsection heading
|
||||
.br
|
||||
.if t .Sp
|
||||
@ -15,12 +14,6 @@
|
||||
.if t .sp .5v
|
||||
.if n .sp
|
||||
..
|
||||
.de Ip \" List item
|
||||
.br
|
||||
.ie \\n(.$>=3 .ne \\$3
|
||||
.el .ne 3
|
||||
.IP "\\$1" \\$2
|
||||
..
|
||||
.de Vb \" Begin verbatim text
|
||||
.ft CW
|
||||
.nf
|
||||
@ -28,15 +21,14 @@
|
||||
..
|
||||
.de Ve \" End verbatim text
|
||||
.ft R
|
||||
|
||||
.fi
|
||||
..
|
||||
.\" Set up some character translations and predefined strings. \*(-- will
|
||||
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
||||
.\" double quote, and \*(R" will give a right double quote. | will give a
|
||||
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
|
||||
.\" to do unbreakable dashes and therefore won't be available. \*(C` and
|
||||
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
|
||||
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
|
||||
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
|
||||
.\" expand to `' in nroff, nothing in troff, for use with C<>.
|
||||
.tr \(*W-|\(bv\*(Tr
|
||||
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
||||
.ie n \{\
|
||||
@ -46,8 +38,8 @@
|
||||
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
||||
. ds L" ""
|
||||
. ds R" ""
|
||||
. ds C` `
|
||||
. ds C' '
|
||||
. ds C` ""
|
||||
. ds C' ""
|
||||
'br\}
|
||||
.el\{\
|
||||
. ds -- \|\(em\|
|
||||
@ -56,26 +48,25 @@
|
||||
. ds R" ''
|
||||
'br\}
|
||||
.\"
|
||||
.\" If the F register is turned on, we'll generate index entries on stderr
|
||||
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
|
||||
.\" index entries marked with X<> in POD. Of course, you'll have to process
|
||||
.\" the output yourself in some meaningful fashion.
|
||||
.\" If the F register is turned on, we'll generate index entries on stderr for
|
||||
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
|
||||
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
||||
.\" output yourself in some meaningful fashion.
|
||||
.if \nF \{\
|
||||
. de IX
|
||||
. tm Index:\\$1\t\\n%\t"\\$2"
|
||||
. .
|
||||
..
|
||||
. nr % 0
|
||||
. rr F
|
||||
.\}
|
||||
.\"
|
||||
.\" For nroff, turn off justification. Always turn off hyphenation; it
|
||||
.\" makes way too many mistakes in technical documents.
|
||||
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||||
.\" way too many mistakes in technical documents.
|
||||
.hy 0
|
||||
.if n .na
|
||||
.\"
|
||||
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
||||
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
||||
.bd B 3
|
||||
. \" fudge factors for nroff and troff
|
||||
.if n \{\
|
||||
. ds #H 0
|
||||
@ -135,29 +126,29 @@
|
||||
. ds Ae AE
|
||||
.\}
|
||||
.rm #[ #] #H #V #F C
|
||||
.\" ======================================================================
|
||||
.\" ========================================================================
|
||||
.\"
|
||||
.IX Title "STARTMON.1 1"
|
||||
.TH STARTMON.1 1 "perl v5.6.0" "2008-01-15" "User Contributed Perl Documentation"
|
||||
.UC
|
||||
.TH STARTMON.1 1 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
|
||||
.SH "NAME"
|
||||
\&\fBstartmon\fR \- Starts a list of plug-in modules to monitor the xCAT cluster.
|
||||
\&\fBstartmon\fR \- Starts a plug\-in module to monitor the xCAT cluster.
|
||||
.SH "SYNOPSIS"
|
||||
.IX Header "SYNOPSIS"
|
||||
\&\fIstartmon [\-h| \-\-help]\fR
|
||||
.PP
|
||||
\&\fIstartmon [\-v| \-\-version]\fR
|
||||
.PP
|
||||
\&\fIstartmon \fIname\fI[,\fIname\fI...]\fR
|
||||
\&\fIstartmon \fIname\fI [\-n|\-\-nodestatmon]\fR
|
||||
.SH "DESCRIPTION"
|
||||
.IX Header "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 \fImonitoring\fR 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 \fIstopmon\fR command and would like to restart it again.
|
||||
This command is used to register a monitoring plug-in module and invoke it 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 module will be registered in the xCAT \fImonitoring\fR database table. A registered plug-in module is automatically started by the \fIxcatd\fR.
|
||||
.SH "Parameters"
|
||||
.IX Header "Parameters"
|
||||
\&\fIname\fR is the name of the monitoring plug-in module in the monitoring table.
|
||||
\&\fIname\fR is the name of the monitoring plug-in module. For example, if the the \fIname\fR is called \fIxxx\fR, then the actual file name that the xcatd looks for is \fI/opt/xcat/lib/perl/xCAT_monitoring/xxx.pm\fR.
|
||||
.SH "OPTIONS"
|
||||
.IX Header "OPTIONS"
|
||||
\&\fB\-n | \-nodestatmon\fR Indicate that this monitoring plug-in will be used for feeding the node liveness status to the xCAT \fInodelist\fR table.
|
||||
.PP
|
||||
\&\fB\-h | \-help\fR Display usage message.
|
||||
.PP
|
||||
\&\fB\-v | \-version \fR Command Version.
|
||||
@ -170,12 +161,17 @@ This command is used only when the user stopped it manually using the \fIstopmon
|
||||
1 An error has occurred.
|
||||
.SH "EXAMPLES"
|
||||
.IX Header "EXAMPLES"
|
||||
1. To start gangliamon plug-in module (which interacts with Ganglia monitoring software)to monitor xCAT cluster, enter:
|
||||
1. To start gangliamon plug-in module (which interacts with Ganglia monitoring software) to monitor the xCAT cluster, enter:
|
||||
.PP
|
||||
.Vb 1
|
||||
\& startmon gangliamon
|
||||
.Ve
|
||||
Please note that gangliamon must have been registered in the xCAT \fImonitoring\fR table. For a list of registered the monitoring software, use command tabdump monitoring. Refer to \*(L"monitoring plug-in infrastructure\*(R" in xCAT documents on how to register a 3rd party software to monitor xCAT cluster.
|
||||
.PP
|
||||
2. To start rmcmon plug-in module (which interacts with \s-1IBM\s0's \s-1RSCT\s0 monitoring software) to monitor the xCAT cluster and have it feed the node liveness status to xCAT's \fInodelist\fR table, enter:
|
||||
.PP
|
||||
.Vb 1
|
||||
\& startmon rmcmon -n
|
||||
.Ve
|
||||
.SH "FILES"
|
||||
.IX Header "FILES"
|
||||
/opt/xcat/bin/startmon
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
.\" Automatically generated by Pod::Man version 1.02
|
||||
.\" Tue Jan 15 09:35:28 2008
|
||||
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
|
||||
.\"
|
||||
.\" Standard preamble:
|
||||
.\" ======================================================================
|
||||
.\" ========================================================================
|
||||
.de Sh \" Subsection heading
|
||||
.br
|
||||
.if t .Sp
|
||||
@ -15,12 +14,6 @@
|
||||
.if t .sp .5v
|
||||
.if n .sp
|
||||
..
|
||||
.de Ip \" List item
|
||||
.br
|
||||
.ie \\n(.$>=3 .ne \\$3
|
||||
.el .ne 3
|
||||
.IP "\\$1" \\$2
|
||||
..
|
||||
.de Vb \" Begin verbatim text
|
||||
.ft CW
|
||||
.nf
|
||||
@ -28,15 +21,14 @@
|
||||
..
|
||||
.de Ve \" End verbatim text
|
||||
.ft R
|
||||
|
||||
.fi
|
||||
..
|
||||
.\" Set up some character translations and predefined strings. \*(-- will
|
||||
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
||||
.\" double quote, and \*(R" will give a right double quote. | will give a
|
||||
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
|
||||
.\" to do unbreakable dashes and therefore won't be available. \*(C` and
|
||||
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
|
||||
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
|
||||
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
|
||||
.\" expand to `' in nroff, nothing in troff, for use with C<>.
|
||||
.tr \(*W-|\(bv\*(Tr
|
||||
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
||||
.ie n \{\
|
||||
@ -46,8 +38,8 @@
|
||||
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
||||
. ds L" ""
|
||||
. ds R" ""
|
||||
. ds C` `
|
||||
. ds C' '
|
||||
. ds C` ""
|
||||
. ds C' ""
|
||||
'br\}
|
||||
.el\{\
|
||||
. ds -- \|\(em\|
|
||||
@ -56,26 +48,25 @@
|
||||
. ds R" ''
|
||||
'br\}
|
||||
.\"
|
||||
.\" If the F register is turned on, we'll generate index entries on stderr
|
||||
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
|
||||
.\" index entries marked with X<> in POD. Of course, you'll have to process
|
||||
.\" the output yourself in some meaningful fashion.
|
||||
.\" If the F register is turned on, we'll generate index entries on stderr for
|
||||
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
|
||||
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
||||
.\" output yourself in some meaningful fashion.
|
||||
.if \nF \{\
|
||||
. de IX
|
||||
. tm Index:\\$1\t\\n%\t"\\$2"
|
||||
. .
|
||||
..
|
||||
. nr % 0
|
||||
. rr F
|
||||
.\}
|
||||
.\"
|
||||
.\" For nroff, turn off justification. Always turn off hyphenation; it
|
||||
.\" makes way too many mistakes in technical documents.
|
||||
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||||
.\" way too many mistakes in technical documents.
|
||||
.hy 0
|
||||
.if n .na
|
||||
.\"
|
||||
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
||||
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
||||
.bd B 3
|
||||
. \" fudge factors for nroff and troff
|
||||
.if n \{\
|
||||
. ds #H 0
|
||||
@ -135,26 +126,25 @@
|
||||
. ds Ae AE
|
||||
.\}
|
||||
.rm #[ #] #H #V #F C
|
||||
.\" ======================================================================
|
||||
.\" ========================================================================
|
||||
.\"
|
||||
.IX Title "STOPMON.1 1"
|
||||
.TH STOPMON.1 1 "perl v5.6.0" "2008-01-15" "User Contributed Perl Documentation"
|
||||
.UC
|
||||
.TH STOPMON.1 1 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
|
||||
.SH "NAME"
|
||||
\&\fBstopmon\fR \- stops a list of monitoring plug-in modules to monitor the xCAT cluster.
|
||||
\&\fBstopmon\fR \- Stops a monitoring plug\-in module to monitor the xCAT cluster.
|
||||
.SH "SYNOPSIS"
|
||||
.IX Header "SYNOPSIS"
|
||||
\&\fIstopmon [\-h| \-\-help]\fR
|
||||
.PP
|
||||
\&\fIstopmon [\-v| \-\-version]\fR
|
||||
.PP
|
||||
\&\fIstopmon name[,name...]\fR
|
||||
\&\fIstopmon name\fR
|
||||
.SH "DESCRIPTION"
|
||||
.IX Header "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 \fImonitoring\fR database table. The registered plug-in modules is usually automatically started by xCAT when xcatd starts or when it is first registered.
|
||||
This command is used to unregister a monitoring plug-in module from the \fImonitoring\fR table. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. Once unregistered, xCAT will ask the monitoring plug-in to stop the 3rd party software to monitor the xCAT cluster.
|
||||
.SH "Parameters"
|
||||
.IX Header "Parameters"
|
||||
\&\fIname\fR name is the name of the monitoring plug-in module in the monitoring table.
|
||||
\&\fIname\fR is the name of the monitoring plug-in module in the \fImonitoring\fR table.
|
||||
.SH "OPTIONS"
|
||||
.IX Header "OPTIONS"
|
||||
\&\fB\-h | \-help\fR Display usage message.
|
||||
@ -169,12 +159,13 @@ This command is used to manually stop a list of monitoring plug-in modules to mo
|
||||
1 An error has occurred.
|
||||
.SH "EXAMPLES"
|
||||
.IX Header "EXAMPLES"
|
||||
1.To stop gangliamon plug-in module (which interacts with Ganglia monitoring software) and rmcmon plug-in module (which interacts with \s-1RMC\s0) to monitor xCAT cluster, enter:
|
||||
1.To stop gangliamon plug-in module (which interacts with Ganglia monitoring software) to monitor the xCAT cluster, enter:
|
||||
.PP
|
||||
.Vb 1
|
||||
\& stopmon gangliamon,rmcmon
|
||||
\& stopmon gangliamon
|
||||
.Ve
|
||||
Please note that gangliamon and rmcmon must have been registered in the xCAT \fImonitoring\fR table. For a list of registered plug-in modules, use command \fItabdump monitoring\fR. Refer to \*(L"monitoring plug-in infrastructure\*(R" in xCAT documents on how to register a monitoring plug-in module to monitor xCAT cluster.
|
||||
.PP
|
||||
Please note that gangliamon must have been registered in the xCAT \fImonitoring\fR table. For a list of registered plug-in modules, use command \fItabdump monitoring\fR.
|
||||
.SH "FILES"
|
||||
.IX Header "FILES"
|
||||
/opt/xcat/bin/stopmon
|
||||
|
||||
Loading…
Reference in New Issue
Block a user