Revision e8f936b0 man/gnt-cluster.rst

b/man/gnt-cluster.rst
30 30
ADD-TAGS
31 31
~~~~~~~~
32 32

  
33
**add-tags** [--from *file*] {*tag*...}
33
**add-tags** [\--from *file*] {*tag*...}
34 34

  
35 35
Add tags to the cluster. If any of the tags contains invalid
36 36
characters, the entire operation will abort.
......
82 82
COPYFILE
83 83
~~~~~~~~
84 84

  
85
| **copyfile** [--use-replication-network] [-n *node*] [-g *group*]
85
| **copyfile** [\--use-replication-network] [-n *node*] [-g *group*]
86 86
| {*file*}
87 87

  
88 88
Copies a file to all or to some nodes. The argument specifies the
......
102 102
DEACTIVATE-MASTER-IP
103 103
~~~~~~~~~~~~~~~~~~~~
104 104

  
105
**deactivate-master-ip** [--yes]
105
**deactivate-master-ip** [\--yes]
106 106

  
107 107
Deactivates the master IP on the master node.
108 108

  
......
114 114
DESTROY
115 115
~~~~~~~
116 116

  
117
**destroy** {--yes-do-it}
117
**destroy** {\--yes-do-it}
118 118

  
119 119
Remove all configuration files related to the cluster, so that a
120 120
**gnt-cluster init** can be done again afterwards.
121 121

  
122 122
Since this is a dangerous command, you are required to pass the
123
argument *--yes-do-it.*
123
argument *\--yes-do-it.*
124 124

  
125 125
EPO
126 126
~~~
127 127

  
128
**epo** [--on] [--groups|--all] [--power-delay] *arguments*
128
**epo** [\--on] [\--groups|\--all] [\--power-delay] *arguments*
129 129

  
130 130
Performs an emergency power-off on nodes given as arguments. If
131 131
``--groups`` is given, arguments are node groups. If ``--all`` is
......
153 153
INFO
154 154
~~~~
155 155

  
156
**info** [--roman]
156
**info** [\--roman]
157 157

  
158 158
Shows runtime cluster information: cluster name, architecture (32
159 159
or 64 bit), master node, node list and instance list.
......
166 166
~~~~
167 167

  
168 168
| **init**
169
| [{-s|--secondary-ip} *secondary\_ip*]
170
| [--vg-name *vg-name*]
171
| [--master-netdev *interface-name*]
172
| [--master-netmask *netmask*]
173
| [--use-external-mip-script {yes \| no}]
174
| [{-m|--mac-prefix} *mac-prefix*]
175
| [--no-lvm-storage]
176
| [--no-etc-hosts]
177
| [--no-ssh-init]
178
| [--file-storage-dir *dir*]
179
| [--enabled-hypervisors *hypervisors*]
180
| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
181
| [{-B|--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
182
| [{-N|--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
183
| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
184
| [--maintain-node-health {yes \| no}]
185
| [--uid-pool *user-id pool definition*]
186
| [{-I|--default-iallocator} *default instance allocator*]
187
| [--primary-ip-version *version*]
188
| [--prealloc-wipe-disks {yes \| no}]
189
| [--node-parameters *ndparams*]
190
| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
191
| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
192
| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
193
| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
194
| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
195
| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
196
| [--ipol-disk-templates *template* [,*template*...]]
197
| [--disk-state *diskstate*]
198
| [--hypervisor-state *hvstate*]
169
| [{-s|\--secondary-ip} *secondary\_ip*]
170
| [\--vg-name *vg-name*]
171
| [\--master-netdev *interface-name*]
172
| [\--master-netmask *netmask*]
173
| [\--use-external-mip-script {yes \| no}]
174
| [{-m|\--mac-prefix} *mac-prefix*]
175
| [\--no-lvm-storage]
176
| [\--no-etc-hosts]
177
| [\--no-ssh-init]
178
| [\--file-storage-dir *dir*]
179
| [\--enabled-hypervisors *hypervisors*]
180
| [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
181
| [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
182
| [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
183
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
184
| [\--maintain-node-health {yes \| no}]
185
| [\--uid-pool *user-id pool definition*]
186
| [{-I|\--default-iallocator} *default instance allocator*]
187
| [\--primary-ip-version *version*]
188
| [\--prealloc-wipe-disks {yes \| no}]
189
| [\--node-parameters *ndparams*]
190
| [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
191
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
192
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
193
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
194
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
195
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
196
| [\--ipol-disk-templates *template* [,*template*...]]
197
| [\--disk-state *diskstate*]
198
| [\--hypervisor-state *hvstate*]
199 199
| {*clustername*}
200 200

  
201 201
This commands is only run once initially on the first node of the
......
524 524
MASTER-FAILOVER
525 525
~~~~~~~~~~~~~~~
526 526

  
527
**master-failover** [--no-voting]
527
**master-failover** [\--no-voting]
528 528

  
529 529
Failover the master role to the current node.
530 530

  
......
555 555
~~~~~~
556 556

  
557 557
| **modify**
558
| [--vg-name *vg-name*]
559
| [--no-lvm-storage]
560
| [--enabled-hypervisors *hypervisors*]
561
| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
562
| [{-B|--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
563
| [{-N|--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
564
| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
565
| [--uid-pool *user-id pool definition*]
566
| [--add-uids *user-id pool definition*]
567
| [--remove-uids *user-id pool definition*]
568
| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
569
| [--maintain-node-health {yes \| no}]
570
| [--prealloc-wipe-disks {yes \| no}]
571
| [{-I|--default-iallocator} *default instance allocator*]
572
| [--reserved-lvs=*NAMES*]
573
| [--node-parameters *ndparams*]
574
| [--master-netdev *interface-name*]
575
| [--master-netmask *netmask*]
576
| [--use-external-mip-script {yes \| no}]
577
| [--hypervisor-state *hvstate*]
578
| [--disk-state *diskstate*]
579
| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
580
| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
581
| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
582
| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
583
| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
584
| [--ipol-disk-templates *template* [,*template*...]]
558
| [\--vg-name *vg-name*]
559
| [\--no-lvm-storage]
560
| [\--enabled-hypervisors *hypervisors*]
561
| [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
562
| [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
563
| [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
564
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
565
| [\--uid-pool *user-id pool definition*]
566
| [\--add-uids *user-id pool definition*]
567
| [\--remove-uids *user-id pool definition*]
568
| [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
569
| [\--maintain-node-health {yes \| no}]
570
| [\--prealloc-wipe-disks {yes \| no}]
571
| [{-I|\--default-iallocator} *default instance allocator*]
572
| [\--reserved-lvs=*NAMES*]
573
| [\--node-parameters *ndparams*]
574
| [\--master-netdev *interface-name*]
575
| [\--master-netmask *netmask*]
576
| [\--use-external-mip-script {yes \| no}]
577
| [\--hypervisor-state *hvstate*]
578
| [\--disk-state *diskstate*]
579
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
580
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
581
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
582
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
583
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
584
| [\--ipol-disk-templates *template* [,*template*...]]
585 585

  
586 586

  
587 587
Modify the options for the cluster.
......
654 654
redist-conf
655 655
~~~~~~~~~~~
656 656

  
657
**redist-conf** [--submit]
657
**redist-conf** [\--submit]
658 658

  
659 659
This command forces a full push of configuration files from the
660 660
master node to the other nodes in the cluster. This is normally not
......
668 668
REMOVE-TAGS
669 669
~~~~~~~~~~~
670 670

  
671
**remove-tags** [--from *file*] {*tag*...}
671
**remove-tags** [\--from *file*] {*tag*...}
672 672

  
673 673
Remove tags from the cluster. If any of the tags are not existing
674 674
on the cluster, the entire operation will abort.
......
697 697
~~~~~~~~~~~~
698 698

  
699 699
| **renew-crypto** [-f]
700
| [--new-cluster-certificate] [--new-confd-hmac-key]
701
| [--new-rapi-certificate] [--rapi-certificate *rapi-cert*]
702
| [--new-spice-certificate | --spice-certificate *spice-cert*
703
| -- spice-ca-certificate *spice-ca-cert*]
704
| [--new-cluster-domain-secret] [--cluster-domain-secret *filename*]
700
| [\--new-cluster-certificate] [\--new-confd-hmac-key]
701
| [\--new-rapi-certificate] [\--rapi-certificate *rapi-cert*]
702
| [\--new-spice-certificate | \--spice-certificate *spice-cert*
703
| \--spice-ca-certificate *spice-ca-cert*]
704
| [\--new-cluster-domain-secret] [\--cluster-domain-secret *filename*]
705 705

  
706 706
This command will stop all Ganeti daemons in the cluster and start
707 707
them again once the new certificates and keys are replicated. The
......
738 738

  
739 739
Note that only active disks can be checked by this command; in case
740 740
a disk cannot be activated it's advised to use
741
**gnt-instance activate-disks --ignore-size ...** to force
741
**gnt-instance activate-disks \--ignore-size ...** to force
742 742
activation without regard to the current size.
743 743

  
744 744
When the all disk sizes are consistent, the command will return no
......
772 772
VERIFY
773 773
~~~~~~
774 774

  
775
| **verify** [--no-nplus1-mem] [--node-group *nodegroup*]
776
| [--error-codes] [{-I|--ignore-errors} *errorcode*]
777
| [{-I|--ignore-errors} *errorcode*...]
775
| **verify** [\--no-nplus1-mem] [\--node-group *nodegroup*]
776
| [\--error-codes] [{-I|\--ignore-errors} *errorcode*]
777
| [{-I|\--ignore-errors} *errorcode*...]
778 778

  
779 779
Verify correctness of cluster configuration. This is safe with
780 780
respect to running instances, and incurs no downtime of the

Also available in: Unified diff