Revision ea3243ca man/gnt-instance.rst

b/man/gnt-instance.rst
28 28

  
29 29
| **add**
30 30
| {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
31
| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
32
|  \| {size=*VAL*,provider=*PROVIDER*}[,param=*value*... ][,mode=*ro\|rw*]
31
| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,options...]
32
|  \| {size=*VAL*,provider=*PROVIDER*}[,param=*value*... ][,options...]
33 33
|  \| {-s|\--os-size} *SIZE*}
34 34
| [\--no-ip-check] [\--no-name-check] [\--no-start] [\--no-install]
35 35
| [\--net=*N* [:options...] \| \--no-nics]
......
50 50
The ``disk`` option specifies the parameters for the disks of the
51 51
instance. The numbering of disks starts at zero, and at least one disk
52 52
needs to be passed. For each disk, either the size or the adoption
53
source needs to be given, and optionally the access mode (read-only or
54
the default of read-write). The size is interpreted (when no unit is
53
source needs to be given. The size is interpreted (when no unit is
55 54
given) in mebibytes. You can also use one of the suffixes *m*, *g* or
56 55
*t* to specify the exact the units used; these suffixes map to
57
mebibytes, gibibytes and tebibytes. For LVM and DRBD devices, the LVM
58
volume group can also be specified (via the ``vg`` key). For DRBD
59
devices, a different VG can be specified for the metadata device using
60
the ``metavg`` key. For ExtStorage devices, also the ``provider``
61
option is mandatory, to specify which ExtStorage provider to use.
56
mebibytes, gibibytes and tebibytes. Each disk can also take the
57
these parametrs (all optional):
58

  
59
mode
60
  The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
61

  
62
name
63
   this option specifies a unique name for the disk, which can be used
64
   as a disk identifier.
65

  
66
vg
67
   The LVM volume group. This works only for LVM and DRBD devices.
68

  
69
metavg
70
   This options specifies a different VG for the metadata device. This
71
   works only for DRBD devices
62 72

  
63 73
When creating ExtStorage disks, also arbitrary parameters can be passed,
64 74
to the ExtStorage provider. Those parameters are passed as additional
......
135 145
    different nodegroups to be connected to the same network in
136 146
    different ways.
137 147

  
148
name
149
   this option specifies a name for the NIC, which can be used as a NIC
150
   identifier.
151

  
138 152

  
139 153
Of these "mode" and "link" are NIC parameters, and inherit their
140 154
default at cluster level.  Alternatively, if no network is desired for
......
1026 1040
| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1027 1041
| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1028 1042
| [{-m|\--runtime-memory} *SIZE*]
1029
| [\--net add*[:options]* \| \--net [*N*:]remove \| \--net *N:options*]
1030
| [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \|
1031
|  \--disk add:size=*SIZE*,provider=*PROVIDER*[,param=*value*... ] \|
1032
|  \--disk [*N*:]remove \|
1033
|  \--disk *N*:mode=*MODE*]
1043
| [\--net *N*:add[,options...] \|
1044
|  \--net *ID*:remove \|
1045
|  \--net *ID*:modify[,options...]]
1046
| [\--disk *N*:add,size=*SIZE*[,options...] \|
1047
|  \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \|
1048
|  \--disk *ID*:modify[,options...]
1049
|  \--disk *ID*:remove]
1034 1050
| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1035 1051
| [\--os-type=*OS* [\--force-variant]]
1036 1052
| [{-O|\--os-parameters} *param*=*value*... ]
......
1062 1078
memory to the given size (in MB if a different suffix is not specified),
1063 1079
by ballooning it up or down to the new value.
1064 1080

  
1065
The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
1066
optional ``vg=``*VG* option specifies an LVM volume group other than the
1067
default volume group to create the disk on. For DRBD disks, the
1068
``metavg=``*VG* option specifies the volume group for the metadata
1069
device. When adding an ExtStorage disk the ``provider=``*PROVIDER*
1070
option is also mandatory and specifies the ExtStorage provider. Also,
1071
for ExtStorage disks arbitrary parameters can be passed as additional
1072
comma separated options, same as in the **add** command. ``--disk``
1073
*N*``:add,size=``**SIZE** can be used to add a disk at a specific index.
1074
The ``--disk remove`` option will remove the last disk of the instance.
1075
Use ``--disk `` *N*``:remove`` to remove a disk by its index. The
1076
``--disk`` *N*``:mode=``*MODE* option will change the mode of the Nth
1077
disk of the instance between read-only (``ro``) and read-write (``rw``).
1078

  
1079
The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
1080
will add a new network interface to the instance. The available options
1081
are the same as in the **add** command (``mac``, ``ip``, ``link``,
1082
``mode``, ``network``). The ``--net remove`` will remove the last network
1083
interface of the instance (``--net`` *N*``:remove`` for a specific index),
1084
while the ``--net`` *N*``:``*options* option will change the parameters of
1085
the Nth instance network interface.
1081
The ``--disk *N*:add:size=*SIZE*[,options...]`` option adds a disk to
1082
the instance at a specific index.  The available options are the same as
1083
in the **add** command(``mode``, ``name``, ``vg``, ``metavg``). When
1084
adding an ExtStorage disk the ``provider=*PROVIDER*`` option is also
1085
mandatory and specifies the ExtStorage provider. Also, for ExtStorage
1086
disks arbitrary parameters can be passed as additional comma separated
1087
options, same as in the **add** command.
1088

  
1089
The ``--disk *ID*:remove`` option will a remove a disk by its identifier.
1090
*ID* can be the index of the disk, the disks's name or the disks's UUID.
1091
The ``--disk *ID*:modify[,options...]`` wil change the options of the disk.
1092
Available options are:
1093

  
1094
mode
1095
  The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
1096

  
1097
name
1098
   this option specifies a unique name for the disk, which can be used
1099
   as a disk identifier.
1100

  
1101
The ``--net *N*:add[,options..]`` will add a new network interface to
1102
the instance. The available options are the same as in the **add**
1103
command (``mac``, ``ip``, ``link``, ``mode``, ``network``). The
1104
``--net *ID*,remove`` will remove the intances' NIC with *ID* identifier,
1105
which can be the index of the NIC, the NIC's name or the NIC's UUID.
1106
The ``--net *ID*:modify[,options..]`` option will change the parameters of
1107
the instance network interface with the *ID* identifier.
1086 1108

  
1087 1109
The option ``-o (--os-type)`` will change the OS name for the instance
1088 1110
(without reinstallation). In case an OS variant is specified that is

Also available in: Unified diff