Revision 0a68e0ff man/gnt-node.rst

b/man/gnt-node.rst
23 23
ADD
24 24
~~~
25 25

  
26
| **add** [--readd] [-s *secondary\_ip*] [-g *nodegroup*]
26
| **add** [--readd] [{-s|--secondary-ip} *secondary\_ip*]
27
| [{-g|--node-group} *nodegroup*]
27 28
| [--master-capable=``yes|no``] [--vm-capable=``yes|no``]
28 29
| [--node-parameters *ndparams*]
29 30
| {*nodename*}
......
39 40
forcibly join the specified host the cluster, not paying attention
40 41
to its current status (it could be already in a cluster, etc.)
41 42

  
42
The ``-s`` is used in dual-home clusters and specifies the new node's
43
IP in the secondary network. See the discussion in **gnt-cluster**(8)
44
for more information.
43
The ``-s (--secondary-ip)`` is used in dual-home clusters and
44
specifies the new node's IP in the secondary network. See the
45
discussion in **gnt-cluster**(8) for more information.
45 46

  
46 47
In case you're readding a node after hardware failure, you can use
47 48
the ``--readd`` parameter. In this case, you don't need to pass the
......
53 54
appears to belong to another cluster. This is used during cluster merging, for
54 55
example.
55 56

  
56
The ``-g`` is used to add the new node into a specific node group,
57
specified by UUID or name. If only one node group exists you can
58
skip this option, otherwise it's mandatory.
57
The ``-g (--node-group)`` option is used to add the new node into a
58
specific node group, specified by UUID or name. If only one node group
59
exists you can skip this option, otherwise it's mandatory.
59 60

  
60 61
The ``vm_capable``, ``master_capable`` and ``ndparams`` options are
61 62
described in **ganeti**(7), and are used to set the properties of the
......
93 94

  
94 95
The new location for the instances can be specified in two ways:
95 96

  
96
- as a single node for all instances, via the ``--new-secondary``
97
- as a single node for all instances, via the ``-n (--new-secondary)``
97 98
  option
98 99

  
99
- or via the ``--iallocator`` option, giving a script name as
100
- or via the ``-I (--iallocator)`` option, giving a script name as
100 101
  parameter, so each instance will be in turn placed on the (per the
101 102
  script) optimal node
102 103

  
......
113 114

  
114 115
Example::
115 116

  
116
    # gnt-node evacuate -I dumb node3.example.com
117
    # gnt-node evacuate -I hail node3.example.com
117 118

  
118 119

  
119 120
FAILOVER
......
149 150

  
150 151
| **list**
151 152
| [--no-headers] [--separator=*SEPARATOR*]
152
| [--units=*UNITS*] [-v] [-o *[+]FIELD,...*]
153
| [--units=*UNITS*] [-v] [{-o|--output} *[+]FIELD,...*]
153 154
| [node...]
154 155

  
155 156
Lists the nodes in the cluster.
......
172 173
The ``-v`` option activates verbose mode, which changes the display of
173 174
special field states (see **ganeti(7)**).
174 175

  
175
The ``-o`` option takes a comma-separated list of output fields.
176
The available fields and their meaning are:
176
The ``-o (--output)`` option takes a comma-separated list of output
177
fields. The available fields and their meaning are:
177 178

  
178 179

  
179 180
name
......
356 357
~~~~~~
357 358

  
358 359
| **modify** [-f] [--submit]
359
| [--master-candidate=``yes|no``] [--drained=``yes|no``] [--offline=``yes|no``]
360
| [{-C|--master-candidate} ``yes|no``]
361
| [{-D|--drained} ``yes|no``] [{-O|--offline} ``yes|no``]
360 362
| [--master-capable=``yes|no``] [--vm-capable=``yes|no``] [--auto-promote]
361
| [-s *secondary_ip*]
363
| [{-s|--secondary-ip} *secondary_ip*]
362 364
| [--node-parameters *ndparams*]
363 365
| [--node-powered=``yes|no``]
364 366
| {*node*}
......
368 370
yes. The meaning of the roles and flags are described in the
369 371
manpage **ganeti**(7).
370 372

  
371
``--node-powered`` can be used to modify state-of-record if it doesn't reflect
372
the reality anymore.
373
The option ``--node-powered`` can be used to modify state-of-record if
374
it doesn't reflect the reality anymore.
373 375

  
374 376
In case a node is demoted from the master candidate role, the
375 377
operation will be refused unless you pass the ``--auto-promote``
......
385 387

  
386 388
    # gnt-node modify --offline=yes node1.example.com
387 389

  
388
The ``-s`` can be used to change the node's secondary ip. No drbd
389
instances can be running on the node, while this operation is
390
taking place.
390
The ``-s (--secondary-ip)`` option can be used to change the node's
391
secondary ip. No drbd instances can be running on the node, while this
392
operation is taking place.
391 393

  
392 394
Example (setting the node back to online and master candidate)::
393 395

  
......
425 427
~~~~~~~
426 428

  
427 429
| **volumes** [--no-headers] [--human-readable]
428
| [--separator=*SEPARATOR*] [--output=*FIELDS*]
430
| [--separator=*SEPARATOR*] [{-o|--output} *FIELDS*]
429 431
| [*node*...]
430 432

  
431 433
Lists all logical volumes and their physical disks from the node(s)
......
443 445
parsing by scripts. In both cases, the ``--units`` option can be
444 446
used to enforce a given output unit.
445 447

  
446
The ``-o`` option takes a comma-separated list of output fields.
447
The available fields and their meaning are:
448
The ``-o (--output)`` option takes a comma-separated list of output
449
fields. The available fields and their meaning are:
448 450

  
449 451
node
450 452
    the node name on which the volume exists
......
479 481

  
480 482
| **list-storage** [--no-headers] [--human-readable]
481 483
| [--separator=*SEPARATOR*] [--storage-type=*STORAGE\_TYPE*]
482
| [--output=*FIELDS*]
484
| [{-o|--output} *FIELDS*]
483 485
| [*node*...]
484 486

  
485 487
Lists the available storage units and their details for the given
......
500 502
The ``--storage-type`` option can be used to choose a storage unit
501 503
type. Possible choices are lvm-pv, lvm-vg or file.
502 504

  
503
The ``-o`` option takes a comma-separated list of output fields.
504
The available fields and their meaning are:
505
The ``-o (--output)`` option takes a comma-separated list of output
506
fields. The available fields and their meaning are:
505 507

  
506 508
node
507 509
    the node name on which the volume exists

Also available in: Unified diff