mirror of
https://git.proxmox.com/git/mirror_corosync
synced 2025-11-04 03:16:00 +00:00
7162e75dcf
The _overview manpages are not actually commands and hence do not belong
into manpage section 8. Move corosync_overview to section 7
("Miscellaneous") and the other *_overview pages to section 3 as they
contain API documentation (cf. string(3) for precedence of
multi-function manpages).
Signed-off-by: Christoph Berg <myon@debian.org>
Reviewed-by: Jan Friesse <jfriesse@redhat.com>
93 lines
3.7 KiB
Groff
93 lines
3.7 KiB
Groff
.\"
|
|
.\" * Copyright (C) 2010 Red Hat, Inc.
|
|
.\" *
|
|
.\" * All rights reserved.
|
|
.\" *
|
|
.\" * Author: Angus Salkeld <asalkeld@redhat.com>
|
|
.\" *
|
|
.\" * This software licensed under BSD license, the text of which follows:
|
|
.\" *
|
|
.\" * Redistribution and use in source and binary forms, with or without
|
|
.\" * modification, are permitted provided that the following conditions are met:
|
|
.\" *
|
|
.\" * - Redistributions of source code must retain the above copyright notice,
|
|
.\" * this list of conditions and the following disclaimer.
|
|
.\" * - Redistributions in binary form must reproduce the above copyright notice,
|
|
.\" * this list of conditions and the following disclaimer in the documentation
|
|
.\" * and/or other materials provided with the distribution.
|
|
.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
|
|
.\" * contributors may be used to endorse or promote products derived from this
|
|
.\" * software without specific prior written permission.
|
|
.\" *
|
|
.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
|
.\" * THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\" */
|
|
.TH "COROSYNC-CFGTOOL" "8" "2010-05-30" "" ""
|
|
.SH "NAME"
|
|
corosync-cfgtool \- An administrative tool for corosync.
|
|
.SH "SYNOPSIS"
|
|
.B corosync\-cfgtool [[\-i IP_address] [\-b] \-s] [\-R] [\-k nodeid] [\-a nodeid] [\-h] [\-H]
|
|
.SH "DESCRIPTION"
|
|
.B corosync\-cfgtool
|
|
A tool for displaying and configuring active parameters within corosync.
|
|
.SH "OPTIONS"
|
|
.TP
|
|
.B -i
|
|
Finds only information about the specified interface IP address with -s.
|
|
.TP
|
|
.B -s
|
|
Displays the status of the current links on this node for UDP/UDPU, while extended status
|
|
for KNET. If any interfaces are faulty, 1 is returned by the binary. If all interfaces are
|
|
active 0 is returned to the shell.
|
|
After each link, the nodes on that link are displayed in order with their status,
|
|
for example there are 3 nodes with KNET transportation:
|
|
LINK ID 0:
|
|
id = 192.168.100.80
|
|
status:
|
|
node 0: link enabled: 1 link connected: 1
|
|
node 1: link enabled: 1 link connected: 1
|
|
node 2: link enabled: 1 link connected: 1
|
|
.TP
|
|
.B -b
|
|
Displays the brief status of the current links on this node (KNET only) when used
|
|
with "-s". If any interfaces are faulty, 1 is returned by the binary. If all interfaces
|
|
are active 0 is returned to the shell.
|
|
After each link, the nodes on that link are displayed in order with their status
|
|
encoded into a single digit. 1=link enabled, 2=link connected, So a 3 in
|
|
a node position indicates that the link is both enabled and connected.
|
|
The local link (which will only ever be enabled on link 0) shows as enabled but
|
|
not connected for internal reasons.
|
|
The output will be:
|
|
LINK ID 0:
|
|
id = 192.168.100.80
|
|
status = 333
|
|
.TP
|
|
.B -R
|
|
Tell all instances of corosync in this cluster to reload corosync.conf.
|
|
.TP
|
|
.B -k
|
|
Kill a node identified by node id.
|
|
.TP
|
|
.B -a
|
|
Display the IP address(es) of a node.
|
|
.TP
|
|
.B -h
|
|
Print basic usage.
|
|
.TP
|
|
.B -H
|
|
Shutdown corosync cleanly on this node.
|
|
.SH "SEE ALSO"
|
|
.BR corosync_overview (7),
|
|
.SH "AUTHOR"
|
|
Angus Salkeld
|
|
.PP
|