NAME
ccs_tool - The tool used to make online updates of CCS config files.
SYNOPSIS
ccs_tool
[OPTION].. <command>
DESCRIPTION
ccs_tool is part of the Cluster Configuration System (CCS). It is
used to make online updates to cluster.conf. It can also be used to
upgrade old style (GFS <= 6.0) CCS archives to the new xml cluster.conf
format.
OPTIONS
-h
Help. Print out the usage.
-V
Print the version information.
sub-commands have their own options, see below for more detail
COMMANDS
update <xml file>
This command is used to update the config file that ccsd is working with
while the cman cluster is operational (i.e. online). Run this on a single
machine to update cluster.conf on all current cluster members. This also
notfies cman of the new config version.
upgrade <location>
This command is used to upgrade an old CCS format archive to the new
xml format. <location> is the location of the old archive,
which can be either a block device archive or a file archive. The
converted configuration will be printed to stdout.
addnode [options]
<node> [<fenceoption=value>]...
Adds a new node to the cluster configuration file. Fencing device options
are specified as key=value pairs (as many as required) and are entered into the
configuration file as is. See the documentation for your fencing agent for more
details (eg a powerswitch fence device may need to know which port the node is
connected to).
Options:
-v <votes> Number of votes for this node (mandatory)
-n <nodeid> Node id for this node (optional)
-i <interface> Network interface to use for this node. Mandatory if the cluster
is using multicast as transport. Forbidden if not.
-m <multicast> Multicast address for cluster. Only allowed on the first node to
be added to the file. Subsequent nodes will use either multicast or broadcast
depending on the properties of the first node.
-f <fencedevice> Name of fence devcie to use for this node. The fence device
section must already have been addded to the file, probably using the addfence command.
-c <file> Config file to use. Defaults to /etc/cluster/cluster.conf
-o <file> Output file. Defaults to the same as -c
-C Don't run "ccs_tool update" after changing file. This will
happen by default if the input file is the same as the output file.
-F Force a "ccs_tool update" even if the input and output files
are different.
delnode [options]
<node>
Delete a node from the cluster configuration file. Note: there is no
"edit" command so to change the properties of a node you must delete it
and add it back in with the new properties.
Options:
-c <file> Config file to use. Defaults to /etc/cluster/cluster.conf
-o <file> Output file. Defaults to the same as -c
-C Don't run "ccs_tool update" after changing file. This will
happen by default if the input file is the same as the output file.
-F Force a "ccs_tool update" even if the input and output files
are different.
addfence [options]
<name> <agent> [<option>=<value>]...
Adds a new fence device section to the cluster configuration file. <agent> is the
name of the fence agent that controls the device. the options following are entered
as key-value pairs. See the fence agent documentation for details about these. eg:
you may need to enter the IP address and username/password for a powerswitch fencing
device.
Options:
-c <file> Config file to use. Defaults to /etc/cluster/cluster.conf
-o <file> Output file. Defaults to the same as -c
-C Don't run "ccs_tool update" after changing file. This will
happen by default if the input file is the same as the output file.
-F Force a "ccs_tool update" even if the input and output files
are different.
delfence [options]
<node>
Deletes a fencing device from the cluster configuration file.
delfence will allow you to remove a fence device that is in use by nodes.
This is to allow changes to be made, but be aware that it may produce an
invalid configuration file if you don't add it back in again.
Options:
-c <file> Config file to use. Defaults to /etc/cluster/cluster.conf
-o <file> Output file. Defaults to the same as -c
-C Don't run "ccs_tool update" after changing file. This will
happen by default if the input file is the same as the output file.
-F Force a "ccs_tool update" even if the input and output files
are different.
lsnode [options]
List the nodes in the configuration file. This is (hopefully obviously) not
necessarily the same as the nodes currently in the cluster, but it should
be a superset.
Options:
-v Verbose. Lists all the properties of the node, and the
node-specific properties of the fence device too.
-c <file> Config file to use. Defaults to /etc/cluster/cluster.conf
lsfence [options]
List all the fence devices in the cluster configuration file.
Options:
-v Verbose. Lists all the properties of the fence device rather
than just the names and agents.
-c <file> Config file to use. Defaults to /etc/cluster/cluster.conf
create [options] <clustername>
Create a new, skeleton, configuration file. Note that "create" on its own will
not create a valid configuration file. Fence agents and nodes will need to be
added to it before handing it over to ccsd. The new configuration file will
have a version number of 1. Subsequent addnode/delnode/addfence/delfence operations
will increment the version number by 1 each time.
Options:
-c <file> Config file to create. Defaults to /etc/cluster/cluster.conf
addnodeids
Adds node ID numbers to all the nodes in cluster.conf. In RHEL4, node IDs were optional
and assigned by cman when a node joined the cluster. In RHEL5 they must be pre-assigned
in cluster.conf. This command will not change any node IDs that are already set in
cluster.conf, it will simply add unique node ID numbers to nodes that do not already
have them.
SEE ALSO
ccs(7), ccsd(8), cluster.conf(5)