Revision 12f126b2 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 these
57
parameters (all optional):
58

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

  
63
name
64
   this option specifies a name for the disk, which can be used as a disk
65
   identifier. An instance can not have two disks with the same name.
66

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

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

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

  
149
name
150
   this option specifies a name for the NIC, which can be used as a NIC
151
   identifier. An instance can not have two NICs with the same name.
152

  
138 153

  
139 154
Of these "mode" and "link" are NIC parameters, and inherit their
140 155
default at cluster level.  Alternatively, if no network is desired for
......
1026 1041
| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
1027 1042
| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
1028 1043
| [{-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*]
1044
| [\--net add[:options...] \|
1045
|  \--net [*N*:]add[,options...] \|
1046
|  \--net [*ID*:]remove \|
1047
|  \--net *ID*:modify[,options...]]
1048
| [\--disk add:size=*SIZE*[,options...] \|
1049
|  \--disk *N*:add,size=*SIZE*[,options...] \|
1050
|  \--disk *N*:add,size=*SIZE*,provider=*PROVIDER*[,options...][,param=*value*... ] \|
1051
|  \--disk *ID*:modify[,options...]
1052
|  \--disk [*ID*:]remove]
1034 1053
| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
1035 1054
| [\--new-primary=*node*]
1036 1055
| [\--os-type=*OS* [\--force-variant]]
......
1063 1082
memory to the given size (in MB if a different suffix is not specified),
1064 1083
by ballooning it up or down to the new value.
1065 1084

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

  
1080
The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option
1081
will add a new network interface to the instance. The available options
1082
are the same as in the **add** command (``mac``, ``ip``, ``link``,
1083
``mode``, ``network``). The ``--net remove`` will remove the last network
1084
interface of the instance (``--net`` *N*``:remove`` for a specific index),
1085
while the ``--net`` *N*``:``*options* option will change the parameters of
1086
the Nth instance network interface.
1085
The ``--disk add:size=*SIZE*,[options..]`` option adds a disk to the
1086
instance, and ``--disk *N*:add:size=*SIZE*,[options..]`` will add a disk
1087
to the the instance at a specific index. The available options are the
1088
same as in the **add** command(``mode``, ``name``, ``vg``, ``metavg``).
1089
When adding an ExtStorage disk the ``provider=*PROVIDER*`` option is
1090
also mandatory and specifies the ExtStorage provider. Also, for
1091
ExtStorage disks arbitrary parameters can be passed as additional comma
1092
separated options, same as in the **add** command. -The ``--disk remove``
1093
option will remove the last disk of the instance. Use
1094
``--disk `` *ID*``:remove`` to remove a disk by its identifier.  *ID*
1095
can be the index of the disk, the disks's name or the disks's UUID.  The
1096
``--disk *ID*:modify[,options...]`` wil change the options of the disk.
1097
Available options are:
1098

  
1099
mode
1100
  The access mode. Either ``ro`` (read-only) or the default ``rw`` (read-write).
1101

  
1102
name
1103
   this option specifies a name for the disk, which can be used as a disk
1104
   identifier. An instance can not have two disks with the same name.
1105

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

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

Also available in: Unified diff