COMMANDS
--------
+ACTIVATE-MASTER-IP
+~~~~~~~~~~~~~~~~~~
+
+**activate-master-ip**
+
+Activates the master IP on the master node.
+
ADD-TAGS
~~~~~~~~
COMMAND
~~~~~~~
-**command** [-n *node*] {*command*}
+**command** [-n *node*] [-g *group*] {*command*}
Executes a command on all nodes. If the option ``-n`` is not given,
the command will be executed on all nodes, otherwise it will be
# gnt-cluster command -n node1.example.com -n node2.example.com date
+The ``-g`` option can be used to run a command only on a specific node
+group, e.g.::
+
+ # gnt-cluster command -g default date
+
The command is executed serially on the selected nodes. If the
master node is present in the list, the command will be executed
last on the master. Regarding the other nodes, the execution order
COPYFILE
~~~~~~~~
-**copyfile** [--use-replication-network] [-n *node*] {*file*}
+| **copyfile** [--use-replication-network] [-n *node*] [-g *group*]
+| {*file*}
Copies a file to all or to some nodes. The argument specifies the
source file (on the current system), the ``-n`` argument specifies
the target node, or nodes if the option is given multiple times. If
-``-n`` is not given at all, the file will be copied to all nodes.
+``-n`` is not given at all, the file will be copied to all nodes. The
+``-g`` option can be used to only select nodes in a specific node group.
Passing the ``--use-replication-network`` option will cause the
copy to be done over the replication network (only matters if the
primary/secondary IPs are different). Example::
This will copy the file /tmp/test from the current node to the two
named nodes.
+DEACTIVATE-MASTER-IP
+~~~~~~~~~~~~~~~~~~~~
+
+**deactivate-master-ip** [--yes]
+
+Deactivates the master IP on the master node.
+
+This should be run only locally or on a connection to the node ip
+directly, as a connection to the master ip will be broken by this
+operation. Because of this risk it will require user confirmation
+unless the ``--yes`` option is passed.
+
DESTROY
~~~~~~~
Since this is a dangerous command, you are required to pass the
argument *--yes-do-it.*
+EPO
+~~~
+
+**epo** [--on] [--groups|--all] [--power-delay] *arguments*
+
+Performs an emergency power-off on nodes given as arguments. If
+``--groups`` is given, arguments are node groups. If ``--all`` is
+provided, the whole cluster will be shut down.
+
+The ``--on`` flag recovers the cluster after an emergency power-off.
+When powering on the cluster you can use ``--power-delay`` to define the
+time in seconds (fractions allowed) waited between powering on
+individual nodes.
+
+Please note that the master node will not be turned down or up
+automatically. It will just be left in a state, where you can manully
+perform the shutdown of that one node. If the master is in the list of
+affected nodes and this is not a complete cluster emergency power-off
+(e.g. using ``--all``), you're required to do a master failover to
+another node not affected.
+
GETMASTER
~~~~~~~~~
| [--no-ssh-init]
| [--file-storage-dir *dir*]
| [--enabled-hypervisors *hypervisors*]
-| [-t *hypervisor name*]
| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
| [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]]
| [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]]
network script it is interpreted as a routing table number or
name.
-The option ``--maintain-node-health`` allows to enable/disable
+The option ``--maintain-node-health`` allows one to enable/disable
automatic maintenance actions on nodes. Currently these include
automatic shutdown of instances and deactivation of DRBD devices on
offline nodes; in the future it might be extended to automatic
that the user-id pool feature is disabled.
The ``-I (--default-iallocator)`` option specifies the default
-instance allocator. The instance allocator will be used for
-operations like instance creation, instance and node migration,
-etc. when no manual override is specified. If this option is not
-specified, the default instance allocator will be blank, which
-means that relevant operations will require the administrator to
-manually specify either an instance allocator, or a set of nodes.
-The default iallocator can be changed later using the **modify**
-command.
+instance allocator. The instance allocator will be used for operations
+like instance creation, instance and node migration, etc. when no
+manual override is specified. If this option is not specified and
+htools was not enabled at build time, the default instance allocator
+will be blank, which means that relevant operations will require the
+administrator to manually specify either an instance allocator, or a
+set of nodes. If the option is not specified but htools was enabled,
+the default iallocator will be **hail**(1) (assuming it can be found
+on disk). The default iallocator can be changed later using the
+**modify** command.
The ``--primary-ip-version`` option specifies the IP version used
for the primary address. Possible values are 4 and 6 for IPv4 and
| **renew-crypto** [-f]
| [--new-cluster-certificate] [--new-confd-hmac-key]
| [--new-rapi-certificate] [--rapi-certificate *rapi-cert*]
+| [--new-spice-certificate | --spice-certificate *spice-cert*
+| -- spice-ca-certificate *spice-ca-cert*]
| [--new-cluster-domain-secret] [--cluster-domain-secret *filename*]
This command will stop all Ganeti daemons in the cluster and start
use your own certificate, e.g. one signed by a certificate
authority (CA), pass its filename to ``--rapi-certificate``.
+To generate a new self-signed SPICE certificate, used by SPICE
+connections to the KVM hypervisor, specify the
+``--new-spice-certificate`` option. If you want to provide a
+certificate, pass its filename to ``--spice-certificate`` and pass the
+signing CA certificate to ``--spice-ca-certificate``.
+
``--new-cluster-domain-secret`` generates a new, random cluster
domain secret. ``--cluster-domain-secret`` reads the secret from a
file. The cluster domain secret is used to sign information
VERIFY
~~~~~~
-**verify** [--no-nplus1-mem]
+**verify** [--no-nplus1-mem] [--node-group *nodegroup*]
Verify correctness of cluster configuration. This is safe with
respect to running instances, and incurs no downtime of the
whether if it loses a node it can restart all the instances on
their secondaries (and report an error otherwise).
+With ``--node-group``, restrict the verification to those nodes and
+instances that live in the named group. This will not verify global
+settings, but will allow to perform verification of a group while other
+operations are ongoing in other groups.
+
VERIFY-DISKS
~~~~~~~~~~~~
**version**
Show the cluster version.
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End:
projects / ganeti-local / blobdiff