Commit e8f936b0 authored by Iustin Pop's avatar Iustin Pop

More -- fixes

Because .DELETE_ON_ERROR doesn't work consistently (works when the
target we're talking about is a final target, but not for
intermediates), I missed a lot of man checks.
Signed-off-by: default avatarIustin Pop <iustin@google.com>
Reviewed-by: default avatarMichael Hanselmann <hansmi@google.com>
parent c3024b7e
......@@ -9,7 +9,7 @@ ganeti-rapi - Ganeti remote API daemon
Synopsis
--------
**ganeti-rapi** [-d] [-f] [--no-ssl] [-K *SSL_KEY_FILE*] [-C
**ganeti-rapi** [-d] [-f] [\--no-ssl] [-K *SSL_KEY_FILE*] [-C
*SSL_CERT_FILE*]
DESCRIPTION
......
......@@ -30,7 +30,7 @@ Activates the master IP on the master node.
ADD-TAGS
~~~~~~~~
**add-tags** [--from *file*] {*tag*...}
**add-tags** [\--from *file*] {*tag*...}
Add tags to the cluster. If any of the tags contains invalid
characters, the entire operation will abort.
......@@ -82,7 +82,7 @@ and the command which will be executed will be ``ls -l /etc``.
COPYFILE
~~~~~~~~
| **copyfile** [--use-replication-network] [-n *node*] [-g *group*]
| **copyfile** [\--use-replication-network] [-n *node*] [-g *group*]
| {*file*}
Copies a file to all or to some nodes. The argument specifies the
......@@ -102,7 +102,7 @@ named nodes.
DEACTIVATE-MASTER-IP
~~~~~~~~~~~~~~~~~~~~
**deactivate-master-ip** [--yes]
**deactivate-master-ip** [\--yes]
Deactivates the master IP on the master node.
......@@ -114,18 +114,18 @@ unless the ``--yes`` option is passed.
DESTROY
~~~~~~~
**destroy** {--yes-do-it}
**destroy** {\--yes-do-it}
Remove all configuration files related to the cluster, so that a
**gnt-cluster init** can be done again afterwards.
Since this is a dangerous command, you are required to pass the
argument *--yes-do-it.*
argument *\--yes-do-it.*
EPO
~~~
**epo** [--on] [--groups|--all] [--power-delay] *arguments*
**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
......@@ -153,7 +153,7 @@ Displays the current master node.
INFO
~~~~
**info** [--roman]
**info** [\--roman]
Shows runtime cluster information: cluster name, architecture (32
or 64 bit), master node, node list and instance list.
......@@ -166,36 +166,36 @@ INIT
~~~~
| **init**
| [{-s|--secondary-ip} *secondary\_ip*]
| [--vg-name *vg-name*]
| [--master-netdev *interface-name*]
| [--master-netmask *netmask*]
| [--use-external-mip-script {yes \| no}]
| [{-m|--mac-prefix} *mac-prefix*]
| [--no-lvm-storage]
| [--no-etc-hosts]
| [--no-ssh-init]
| [--file-storage-dir *dir*]
| [--enabled-hypervisors *hypervisors*]
| [{-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*...]]
| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [--maintain-node-health {yes \| no}]
| [--uid-pool *user-id pool definition*]
| [{-I|--default-iallocator} *default instance allocator*]
| [--primary-ip-version *version*]
| [--prealloc-wipe-disks {yes \| no}]
| [--node-parameters *ndparams*]
| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--ipol-disk-templates *template* [,*template*...]]
| [--disk-state *diskstate*]
| [--hypervisor-state *hvstate*]
| [{-s|\--secondary-ip} *secondary\_ip*]
| [\--vg-name *vg-name*]
| [\--master-netdev *interface-name*]
| [\--master-netmask *netmask*]
| [\--use-external-mip-script {yes \| no}]
| [{-m|\--mac-prefix} *mac-prefix*]
| [\--no-lvm-storage]
| [\--no-etc-hosts]
| [\--no-ssh-init]
| [\--file-storage-dir *dir*]
| [\--enabled-hypervisors *hypervisors*]
| [{-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*...]]
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [\--maintain-node-health {yes \| no}]
| [\--uid-pool *user-id pool definition*]
| [{-I|\--default-iallocator} *default instance allocator*]
| [\--primary-ip-version *version*]
| [\--prealloc-wipe-disks {yes \| no}]
| [\--node-parameters *ndparams*]
| [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--ipol-disk-templates *template* [,*template*...]]
| [\--disk-state *diskstate*]
| [\--hypervisor-state *hvstate*]
| {*clustername*}
This commands is only run once initially on the first node of the
......@@ -524,7 +524,7 @@ List the tags of the cluster.
MASTER-FAILOVER
~~~~~~~~~~~~~~~
**master-failover** [--no-voting]
**master-failover** [\--no-voting]
Failover the master role to the current node.
......@@ -555,33 +555,33 @@ MODIFY
~~~~~~
| **modify**
| [--vg-name *vg-name*]
| [--no-lvm-storage]
| [--enabled-hypervisors *hypervisors*]
| [{-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*...]]
| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [--uid-pool *user-id pool definition*]
| [--add-uids *user-id pool definition*]
| [--remove-uids *user-id pool definition*]
| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
| [--maintain-node-health {yes \| no}]
| [--prealloc-wipe-disks {yes \| no}]
| [{-I|--default-iallocator} *default instance allocator*]
| [--reserved-lvs=*NAMES*]
| [--node-parameters *ndparams*]
| [--master-netdev *interface-name*]
| [--master-netmask *netmask*]
| [--use-external-mip-script {yes \| no}]
| [--hypervisor-state *hvstate*]
| [--disk-state *diskstate*]
| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--ipol-disk-templates *template* [,*template*...]]
| [\--vg-name *vg-name*]
| [\--no-lvm-storage]
| [\--enabled-hypervisors *hypervisors*]
| [{-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*...]]
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [\--uid-pool *user-id pool definition*]
| [\--add-uids *user-id pool definition*]
| [\--remove-uids *user-id pool definition*]
| [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
| [\--maintain-node-health {yes \| no}]
| [\--prealloc-wipe-disks {yes \| no}]
| [{-I|\--default-iallocator} *default instance allocator*]
| [\--reserved-lvs=*NAMES*]
| [\--node-parameters *ndparams*]
| [\--master-netdev *interface-name*]
| [\--master-netmask *netmask*]
| [\--use-external-mip-script {yes \| no}]
| [\--hypervisor-state *hvstate*]
| [\--disk-state *diskstate*]
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--ipol-disk-templates *template* [,*template*...]]
Modify the options for the cluster.
......@@ -654,7 +654,7 @@ The ``info`` option shows whether the watcher is currently paused.
redist-conf
~~~~~~~~~~~
**redist-conf** [--submit]
**redist-conf** [\--submit]
This command forces a full push of configuration files from the
master node to the other nodes in the cluster. This is normally not
......@@ -668,7 +668,7 @@ that it can be examined via **gnt-job info**.
REMOVE-TAGS
~~~~~~~~~~~
**remove-tags** [--from *file*] {*tag*...}
**remove-tags** [\--from *file*] {*tag*...}
Remove tags from the cluster. If any of the tags are not existing
on the cluster, the entire operation will abort.
......@@ -697,11 +697,11 @@ RENEW-CRYPTO
~~~~~~~~~~~~
| **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*]
| [\--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
them again once the new certificates and keys are replicated. The
......@@ -738,7 +738,7 @@ arguments are given, all instances will be checked.
Note that only active disks can be checked by this command; in case
a disk cannot be activated it's advised to use
**gnt-instance activate-disks --ignore-size ...** to force
**gnt-instance activate-disks \--ignore-size ...** to force
activation without regard to the current size.
When the all disk sizes are consistent, the command will return no
......@@ -772,9 +772,9 @@ node will be listed as /nodes/*name*, and an instance as
VERIFY
~~~~~~
| **verify** [--no-nplus1-mem] [--node-group *nodegroup*]
| [--error-codes] [{-I|--ignore-errors} *errorcode*]
| [{-I|--ignore-errors} *errorcode*...]
| **verify** [\--no-nplus1-mem] [\--node-group *nodegroup*]
| [\--error-codes] [{-I|\--ignore-errors} *errorcode*]
| [{-I|\--ignore-errors} *errorcode*...]
Verify correctness of cluster configuration. This is safe with
respect to running instances, and incurs no downtime of the
......
......@@ -24,17 +24,17 @@ ADD
~~~
| **add**
| [--node-parameters=*NDPARAMS*]
| [--alloc-policy=*POLICY*]
| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--ipol-disk-templates *template* [,*template*...]]
| [--disk-state *diskstate*]
| [--hypervisor-state *hvstate*]
| [\--node-parameters=*NDPARAMS*]
| [\--alloc-policy=*POLICY*]
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--ipol-disk-templates *template* [,*template*...]]
| [\--disk-state *diskstate*]
| [\--hypervisor-state *hvstate*]
| {*group*}
Creates a new group with the given name. The node group will be
......@@ -75,7 +75,7 @@ ASSIGN-NODES
~~~~~~~~~~~~
| **assign-nodes**
| [--force]
| [\--force]
| {*group*} {*node*...}
Assigns one or more nodes to the specified group, moving them from their
......@@ -91,17 +91,17 @@ MODIFY
~~~~~~
| **modify**
| [--node-parameters=*NDPARAMS*]
| [--alloc-policy=*POLICY*]
| [--hypervisor-state *hvstate*]
| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [--disk-state *diskstate*]
| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [--ipol-disk-templates *template* [,*template*...]]
| [\--node-parameters=*NDPARAMS*]
| [\--alloc-policy=*POLICY*]
| [\--hypervisor-state *hvstate*]
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
| [\--disk-state *diskstate*]
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
| [\--ipol-disk-templates *template* [,*template*...]]
| {*group*}
Modifies some parameters from the node group.
......@@ -129,8 +129,8 @@ least one group, so the last group cannot be removed.
LIST
~~~~
| **list** [--no-headers] [--separator=*SEPARATOR*] [-v]
| [-o *[+]FIELD,...*] [--filter] [group...]
| **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
| [-o *[+]FIELD,...*] [\--filter] [group...]
Lists all existing node groups in the cluster.
......@@ -178,7 +178,7 @@ Renames a given group from *oldname* to *newname*.
EVACUATE
~~~~~~~~
**evacuate** [--iallocator *NAME*] [--to *GROUP*...] {*group*}
**evacuate** [\--iallocator *NAME*] [\--to *GROUP*...] {*group*}
This command will move all instances out of the given node group.
Instances are placed in a new group by an iallocator, either given on
......@@ -198,7 +198,7 @@ TAGS
ADD-TAGS
^^^^^^^^
**add-tags** [--from *file*] {*groupname*} {*tag*...}
**add-tags** [\--from *file*] {*groupname*} {*tag*...}
Add tags to the given node group. If any of the tags contains invalid
characters, the entire operation will abort.
......@@ -219,7 +219,7 @@ List the tags of the given node group.
REMOVE-TAGS
^^^^^^^^^^^
**remove-tags** [--from *file*] {*groupname*} {*tag*...}
**remove-tags** [\--from *file*] {*groupname*} {*tag*...}
Remove tags from the given node group. If any of the tags are not
existing on the node, the entire operation will abort.
......
......@@ -27,19 +27,19 @@ ADD
^^^
| **add**
| {-t|--disk-template {diskless | file \| plain \| drbd \| rbd}}
| {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
| \| {-s|--os-size} *SIZE*}
| [--no-ip-check] [--no-name-check] [--no-start] [--no-install]
| [--net=*N* [:options...] \| --no-nics]
| [{-B|--backend-parameters} *BEPARAMS*]
| [{-H|--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
| [{-O|--os-parameters} *param*=*value*... ]
| [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}]
| {{-n|--node} *node[:secondary-node]* \| {-I|--iallocator} *name*}
| {{-o|--os-type} *os-type*}
| [--submit]
| [--ignore-ipolicy]
| {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
| \| {-s|\--os-size} *SIZE*}
| [\--no-ip-check] [\--no-name-check] [\--no-start] [\--no-install]
| [\--net=*N* [:options...] \| \--no-nics]
| [{-B|\--backend-parameters} *BEPARAMS*]
| [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
| [{-O|\--os-parameters} *param*=*value*... ]
| [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap}]
| {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*}
| {{-o|\--os-type} *os-type*}
| [\--submit]
| [\--ignore-ipolicy]
| {*instance*}
Creates a new instance on the specified host. The *instance* argument
......@@ -743,8 +743,8 @@ follows::
REMOVE
^^^^^^
**remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit]
[--force] {*instance*}
**remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
[\--force] {*instance*}
Remove an instance. This will remove all data from the instance and
there is *no way back*. If you are not sure if you use an instance
......@@ -776,8 +776,8 @@ LIST
^^^^
| **list**
| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v]
| [{-o|--output} *[+]FIELD,...*] [--filter] [instance...]
| [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
| [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
Shows the currently configured instances with memory usage, disk
usage, the node they are running on, and their run status.
......@@ -837,7 +837,7 @@ Lists available fields for instances.
INFO
^^^^
**info** [-s \| --static] [--roman] {--all \| *instance*}
**info** [-s \| \--static] [\--roman] {\--all \| *instance*}
Show detailed information about the given instance(s). This is
different from **list** as it shows detailed data about the instance's
......@@ -858,18 +858,18 @@ MODIFY
^^^^^^
| **modify**
| [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
| [{-B|--backend-parameters} *BACKEND\_PARAMETERS*]
| [{-m|--runtime-memory} *SIZE*]
| [--net add*[:options]* \| --net remove \| --net *N:options*]
| [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \|
| --disk *N*:mode=*MODE*]
| [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync]
| [--os-type=*OS* [--force-variant]]
| [{-O|--os-parameters} *param*=*value*... ]
| [--offline \| --online]
| [--submit]
| [--ignore-ipolicy]
| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
| [{-m|\--runtime-memory} *SIZE*]
| [\--net add*[:options]* \| \--net remove \| \--net *N:options*]
| [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk remove \|
| \--disk *N*:mode=*MODE*]
| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
| [\--os-type=*OS* [\--force-variant]]
| [{-O|\--os-parameters} *param*=*value*... ]
| [\--offline \| \--online]
| [\--submit]
| [\--ignore-ipolicy]
| {*instance*}
Modifies the memory size, number of vcpus, ip address, MAC address
......@@ -940,10 +940,10 @@ running, there is no effect on the instance.
REINSTALL
^^^^^^^^^
| **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*]
| [--force-multiple]
| [--instance \| --node \| --primary \| --secondary \| --all]
| [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...}
| **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
| [\--force-multiple]
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
| [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
Reinstalls the operating system on the given instance(s). The
instance(s) must be stopped when running this command. If the ``-o
......@@ -969,7 +969,7 @@ can be examined via **gnt-job info**.
RENAME
^^^^^^
| **rename** [--no-ip-check] [--no-name-check] [--submit]
| **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
| {*instance*} {*new\_name*}
Renames the given instance. The instance must be stopped when running
......@@ -996,50 +996,50 @@ STARTUP
^^^^^^^
| **startup**
| [--force] [--ignore-offline]
| [--force-multiple] [--no-remember]
| [--instance \| --node \| --primary \| --secondary \| --all \|
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
| [{-H|--hypervisor-parameters} ``key=value...``]
| [{-B|--backend-parameters} ``key=value...``]
| [--submit] [--paused]
| [\--force] [\--ignore-offline]
| [\--force-multiple] [\--no-remember]
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
| [{-H|\--hypervisor-parameters} ``key=value...``]
| [{-B|\--backend-parameters} ``key=value...``]
| [\--submit] [\--paused]
| {*name*...}
Starts one or more instances, depending on the following options. The
four available modes are:
--instance
\--instance
will start the instances given as arguments (at least one argument
required); this is the default selection
--node
\--node
will start the instances who have the given node as either primary
or secondary
--primary
\--primary
will start all instances whose primary node is in the list of nodes
passed as arguments (at least one node required)
--secondary
\--secondary
will start all instances whose secondary node is in the list of
nodes passed as arguments (at least one node required)
--all
\--all
will start all instances in the cluster (no arguments accepted)
--tags
\--tags
will start all instances in the cluster with the tags given as
arguments
--node-tags
\--node-tags
will start all instances in the cluster on nodes with the tags
given as arguments
--pri-node-tags
\--pri-node-tags
will start all instances in the cluster on primary nodes with the
tags given as arguments
--sec-node-tags
\--sec-node-tags
will start all instances in the cluster on secondary nodes with the
tags given as arguments
......@@ -1096,11 +1096,11 @@ SHUTDOWN
^^^^^^^^
| **shutdown**
| [--timeout=*N*]
| [--force-multiple] [--ignore-offline] [--no-remember]
| [--instance \| --node \| --primary \| --secondary \| --all \|
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
| [--submit]
| [\--timeout=*N*]
| [\--force-multiple] [\--ignore-offline] [\--no-remember]
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
| [\--submit]
| {*name*...}
Stops one or more instances. If the instance cannot be cleanly stopped
......@@ -1145,13 +1145,13 @@ REBOOT
^^^^^^
| **reboot**
| [{-t|--type} *REBOOT-TYPE*]
| [--ignore-secondaries]
| [--shutdown-timeout=*N*]
| [--force-multiple]
| [--instance \| --node \| --primary \| --secondary \| --all \|
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
| [--submit]
| [{-t|\--type} *REBOOT-TYPE*]
| [\--ignore-secondaries]
| [\--shutdown-timeout=*N*]
| [\--force-multiple]
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
| [\--submit]
| [*name*...]
Reboots one or more instances. The type of reboot depends on the value
......@@ -1186,7 +1186,7 @@ Example::
CONSOLE
^^^^^^^
**console** [--show-cmd] {*instance*}
**console** [\--show-cmd] {*instance*}
Connects to the console of the given instance. If the instance is not
up, an error is returned. Use the ``--show-cmd`` option to display the
......@@ -1212,17 +1212,17 @@ Disk management
REPLACE-DISKS
^^^^^^^^^^^^^
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-p}
[--disks *idx*] {*instance*}
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
[\--disks *idx*] {*instance*}
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-s}
[--disks *idx*] {*instance*}
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
[\--disks *idx*] {*instance*}
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy]
{--iallocator *name* \| -- {*instance*}
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
{\--iallocator *name* \| \--node *node* } {*instance*}
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy]
{--auto} {*instance*}
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
{\--auto} {*instance*}
This command is a generalized form for replacing disks. It is
currently only valid for the mirrored (DRBD) disk template.
......@@ -1271,7 +1271,7 @@ new secondary.
ACTIVATE-DISKS
^^^^^^^^^^^^^^
**activate-disks** [--submit] [--ignore-size] {*instance*}
**activate-disks** [\--submit] [\--ignore-size] {*instance*}
Activates the block devices of the given instance. If successful, the
command will show the location and name of the block devices::
......@@ -1302,7 +1302,7 @@ running.
DEACTIVATE-DISKS
^^^^^^^^^^^^^^^^
**deactivate-disks** [-f] [--submit] {*instance*}
**deactivate-disks** [-f] [\--submit] {*instance*}
De-activates the block devices of the given instance. Note that if you
run this command for an instance with a drbd disk template, while it
......@@ -1324,7 +1324,7 @@ can be examined via **gnt-job info**.
GROW-DISK
^^^^^^^^^
**grow-disk** [--no-wait-for-sync] [--submit] {*instance*} {*disk*}
**grow-disk** [\--no-wait-for-sync] [\--submit] {*instance*} {*disk*}
{*amount*}
Grows an instance's disk. This is only possible for instances having a
......@@ -1372,8 +1372,8 @@ instance.
RECREATE-DISKS
^^^^^^^^^^^^^^
| **recreate-disks** [--submit] [-n node1:[node2]]
| [--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
| **recreate-disks** [\--submit] [-n node1:[node2]]
| [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
Recreates all or a subset of disks of the given instance.
......@@ -1408,10 +1408,10 @@ Recovery
FAILOVER
^^^^^^^^
| **failover** [-f] [--ignore-consistency] [--ignore-ipolicy]
| [--shutdown-timeout=*N*]
| [{-n|--target-node} *node* \| {-I|--iallocator} *name*]
| [--submit]
| **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
| [\--shutdown-timeout=*N*]
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
| [\--submit]
| {*instance*}
Failover will stop the instance (if running), change its primary node,
......@@ -1455,12 +1455,12 @@ Example::
MIGRATE
^^^^^^^
**migrate** [-f] {--cleanup} {*instance*}
**migrate** [-f] {\--cleanup} {*instance*}
**migrate** [-f] [--allow-failover] [--non-live]
[--migration-mode=live\|non-live] [--ignore-ipolicy]
[--no-runtime-changes]
[{-n|--target-node} *node* \| {-I|--iallocator} *name*] {*instance*}
**migrate** [-f] [\--allow-failover] [\--non-live]
[\--migration-mode=live\|non-live] [\--ignore-ipolicy]
[\--no-runtime-changes]
[{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
Migrate will move the instance to its secondary node without shutdown.
As with failover, it only works for instances having the drbd disk
......@@ -1537,8 +1537,8 @@ Example (and expected output)::
MOVE
^^^^
**move** [-f] [--ignore-consistency]
[-n *node*] [--shutdown-timeout=*N*] [--submit] [--ignore-ipolicy]
**move** [-f] [\--ignore-consistency]
[-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
{*instance*}