xcat-core/xCAT-client/pods/man1/monls.1.pod

=head1 NAME

B<monls> - Lists monitoring plug-in modules that can be used to monitor the xCAT cluster.



=head1 SYNOPSIS

I<monls [-h| --help]>

I<monls  [-v| --version]>

I<monls I<name> [-d|--description]>

I<monls [-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:

  monls

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

  monls -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:

  monls snmpmon -d


=head1 FILES

/opt/xcat/bin/monls


=head1 SEE ALSO

L<monstart(1)|monstart.1>, L<monstop(1)|monstop.1>