.TH "o2cb_ctl" "8" "September 2010" "Version 1.8.7" "OCFS2 Manual Pages"
.SH "NAME"
o2cb_ctl \- Control program for the \fIO2CB\fR cluster service.
.SH "SYNOPSIS"
.B o2cb_ctl 
\fB\-C\fR \fB\-n\fR \fIobject\fR \fB\-t\fR type\fR [\fB\-i\fR] [\fB\-a\fR \fIattribute\fR ]
.br
.B o2cb_ctl 
\fB\-D\fR \fB\-n\fR \fIobject\fR [\fB\-u\fR]
.br
.B o2cb_ctl 
\fB\-I\fR [\fB\-o\|\-z\fR] \fB\-l\fR \fImanager\fR> [\fB\-n\fR \fIobject\fR>] [\fB\-t\fR \fItype\fR] [\fB\-a\fR \fIattribute\fR]
.br
.B o2cb_ctl 
\fB\-H\fR [\fB\-n\fR \fIobject\fR] [\fB\-t\fR \fItype\fR>] [\fB\-a\fR \fIattribute\fR>] 
.br
.B o2cb_ctl 
\fB\-h\fR
.br
.B o2cb_ctl 
\fB\-V\fR

.SH "DESCRIPTION"
.PP 
\fBo2cb_ctl\fR is the control program for the \fIO2CB\fR cluster service.
Users are not advised to use this program directly but instead use the
\fIO2CB\fR init service and/or \fIocfs2console\fR.

.SH "OPTIONS"

.TP
\fB\-C\fR
Create an object in the OCFS2 Cluster Configuration.

.TP
\fB\-D\fR
Delete an object from the existing OCFS2 Cluster Configuration.

.TP
\fB\-I\fR
Print information about the OCFS2 Cluster Configuration.

.TP
\fB\-H\fR
Change an object or objects in the existing OCFS2 Cluster Configuration.

.TP
\fB\-h\fR
Displays help and exit.

.TP
\fB\-V\fR
Print version and exit.

.SH "OTHER OPTIONS"

.TP
\fB\-a\fR \fI<attribute>\fR
With \fB\-C\fR, \fI<attribute>\fR is in format "parameter=value", where
the parameter is a valid parameter that can be set in the file
\fI/etc/ocfs2/cluster.conf\fR.  With \fB\-I\fR, \fI<attribute>\fR may be
"parameter", indicating an attribute to be listed in the output, or it
may be "parameter==value", indicating that only objects matching
"parameter=value" are to be displayed.

.TP
\fB\-i\fR
Valid only with \fB\-C\fR. When creating something (\fInode\fR or
\fIcluster\fR), it will also install it in the live cluster. If the
parameter is not specified, then only update the
\fI/etc/ocfs2/cluster.conf\fR.

.TP
\fB\-n\fR \fIobject\fR
\fIobject\fR is usually the node name or cluster name. In the
\fI/etc/ocfs2/cluster.conf\fR file, it would be the value of the name
parameter for any of the sections (\fIcluster\fR or \fInode\fR).

.TP
\fB\-o\fR
Valid only with \fB\-I\fR. Using this parameter, if one asks o2cb_ctl to
list all nodes, it will output it in a format suitable for shell parsing.

.TP
\fB\-t\fR \fItype\fR
\fItype\fR can be cluster, node or heartbeat.

.TP
\fB\-u\fR
Valid only with \fB\-D\fR. When deleting something (\fInode\fR or
\fIcluster\fR), it will also remove it from the live cluster. If the
parameter is not specified, then only update the
\fI/etc/ocfs2/cluster.conf\fR.

.TP
\fB\-z\fR
Valid only with \fB\-I\fR. This is the default. If one asks o2cb_ctl to
list all nodes, it will give a verbose listing.

.SH "EXAMPLES"

.HP
Add node5 to an offline cluster:

$ o2cb_ctl -C -n node5 -t node -a number=5
.br
	-a ip_address=192.168.0.5 -a ip_port=7777
.br
	-a cluster=mycluster

.TP
Add node10 to an online cluster:

$ o2cb_ctl -C -i -n node10 -t node -a number=10
.br
	-a ip_address=192.168.1.10 -a ip_port=7777
.br
	-a cluster=mycluster

Note the -i argument.

.TP
Query the IP address of node5:

$ o2cb_ctl -I -n node5 -a ip_address

.TP
Change the IP address of node5:

$ o2cb_ctl -H -n node5 -a ip_address=192.168.1.5

.SH "SEE ALSO"
.BR mkfs.ocfs2(8)
.BR fsck.ocfs2(8)
.BR tunefs.ocfs2(8)
.BR mounted.ocfs2(8)
.BR o2cb(7)

.SH "AUTHORS"
Oracle Corporation

.SH "COPYRIGHT"
Copyright \(co 2004, 2010 Oracle. All rights reserved.