Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

crm_mon(8) [debian man page]

PACEMAKER(8)						  System Administration Utilities					      PACEMAKER(8)

NAME

       Pacemaker - Part of the Pacemaker cluster resource manager

SYNOPSIS

       crm_mon mode [options]

DESCRIPTION

       crm_mon - Provides a summary of cluster's current state.

       Outputs varying levels of detail in a number of different formats.

OPTIONS

       -?, --help
	      This text

       -$, --version
	      Version information

       -V, --verbose
	      Increase debug output

       -Q, --quiet
	      Display only essential output

   Modes:
       -h, --as-html=value
	      Write cluster status to the named html file

       -X, --as-xml
	      Write cluster status as xml to stdout.

       -w, --web-cgi
	      Web mode with output suitable for cgi

       -s, --simple-status
	      Display the cluster status once as a simple one line output (suitable for nagios)

       -S, --snmp-traps=value Send SNMP traps to this station

       -C, --snmp-community=value
	      Specify community for SNMP traps(default is NULL)

       -T, --mail-to=value
	      Send Mail alerts to this user.  See also --mail-from, --mail-host, --mail-prefix

   Display Options:
       -n, --group-by-node
	      Group resources by node

       -r, --inactive
	      Display inactive resources

       -f, --failcounts
	      Display resource fail counts

       -o, --operations
	      Display resource operation history

       -t, --timing-details
	      Display resource operation history with timing details

       -A, --show-node-attributes
	      Display node attributes

       -c, --tickets
	      Display cluster tickets

   Additional Options:
       -i, --interval=value
	      Update frequency in seconds

       -1, --one-shot
	      Display the cluster status once on the console and exit

       -N, --disable-ncurses
	      Disable the use of ncurses

       -d, --daemonize
	      Run in the background as a daemon

       -p, --pid-file=value
	      (Advanced) Daemon pid file location

       -F, --mail-from=value
	      Mail alerts should come from the named user

       -H, --mail-host=value
	      Mail alerts should be sent via the named host

       -P, --mail-prefix=value
	      Subjects for mail alerts should start with this string

       -E, --external-agent=value
	      A program to run when resource operations take place.

       -e, --external-recipient=value A recipient for your program (assuming you want the program to send something to someone).

EXAMPLES

       Display the cluster status on the console with updates as they occur:

	      # crm_mon

       Display the cluster status on the console just once then exit:

	      # crm_mon -1

       Display your cluster status, group resources by node, and include inactive resources in the list:

	      # crm_mon --group-by-node --inactive

       Start crm_mon as a background daemon and have it write the cluster status to an HTML file:

	      # crm_mon --daemonize --as-html /path/to/docroot/filename.html

       Start crm_mon and export the current cluster status as xml to stdout, then exit.:

	      # crm_mon --one-shot --as-xml

       Start crm_mon as a background daemon and have it send email alerts:

	      # crm_mon --daemonize --mail-to user@example.com --mail-host mail.example.com

       Start crm_mon as a background daemon and have it send SNMP alerts:

	      # crm_mon --daemonize --snmp-traps snmptrapd.example.com

AUTHOR

       Written by Andrew Beekhof

REPORTING BUGS

       Report bugs to pacemaker@oss.clusterlabs.org

Pacemaker 1.1.7 						    April 2012							      PACEMAKER(8)

Check Out this Related Man Page

OCF_HEARTBEAT_CLUSTE(7) 					OCF resource agents					   OCF_HEARTBEAT_CLUSTE(7)

NAME

       ocf_heartbeat_ClusterMon - Runs crm_mon in the background, recording the cluster status to an HTML file

SYNOPSIS

       ClusterMon [start | stop | monitor | meta-data | validate-all]

DESCRIPTION

       This is a ClusterMon Resource Agent. It outputs current cluster status to the html.

SUPPORTED PARAMETERS

       user
	   The user we want to run crm_mon as (optional, string, default root)

       update
	   How frequently should we update the cluster status (optional, integer, default 15)

       extra_options
	   Additional options to pass to crm_mon. Eg. -n -r (optional, string, no default)

       pidfile
	   PID file location to ensure only one instance is running (optional, string, default /tmp/ClusterMon_default.pid)

       htmlfile
	   Location to write HTML output to. (optional, string, default /tmp/ClusterMon_default.html)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
	   Starts the resource. Suggested minimum timeout: 20.

       stop
	   Stops the resource. Suggested minimum timeout: 20.

       monitor
	   Performs a detailed status check. Suggested minimum timeout: 20. Suggested interval: 10.

       meta-data
	   Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5.

       validate-all
	   Performs a validation of the resource configuration. Suggested minimum timeout: 30.

EXAMPLE

       The following is an example configuration for a ClusterMon resource using the crm(8) shell:

	   primitive example_ClusterMon ocf:heartbeat:ClusterMon 

	     op monitor depth="0" timeout="20" interval="10"

SEE ALSO

       http://www.linux-ha.org/wiki/ClusterMon_(resource_agent)

AUTHOR

       Linux-HA contributors (see the resource agent source for information about individual authors)

resource-agents 1.0.3						    07/05/2010						   OCF_HEARTBEAT_CLUSTE(7)
Man Page