Revision 0a68e0ff man/gnt-instance.rst
| b/man/gnt-instance.rst | ||
|---|---|---|
| 27 | 27 |
^^^ |
| 28 | 28 |
|
| 29 | 29 |
| **add** |
| 30 |
| {-t {diskless | file \| plain \| drbd}}
|
|
| 30 |
| {-t|--disk-template {diskless | file \| plain \| drbd}}
|
|
| 31 | 31 |
| {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
|
| 32 |
| \| -s *SIZE*}
|
|
| 32 |
| \| {-s|--os-size} *SIZE*}
|
|
| 33 | 33 |
| [--no-ip-check] [--no-name-check] [--no-start] [--no-install] |
| 34 | 34 |
| [--net=*N* [:options...] \| --no-nics] |
| 35 |
| [-B *BEPARAMS*]
|
|
| 36 |
| [-H *HYPERVISOR* [: option=*value*... ]]
|
|
| 37 |
| [-O, --os-parameters *param*=*value*... ]
|
|
| 35 |
| [{-B|--backend-parameters} *BEPARAMS*]
|
|
| 36 |
| [{-H|--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
|
|
| 37 |
| [{-O|--os-parameters} *param*=*value*... ]
|
|
| 38 | 38 |
| [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}]
|
| 39 |
| {-n *node[:secondary-node]* \| --iallocator *name*}
|
|
| 40 |
| {-o *os-type*}
|
|
| 39 |
| {{-n|--node} *node[:secondary-node]* \| {-I|--iallocator} *name*}
|
|
| 40 |
| {{-o|--os-type} *os-type*}
|
|
| 41 | 41 |
| [--submit] |
| 42 | 42 |
| {*instance*}
|
| 43 | 43 |
|
| ... | ... | |
| 93 | 93 |
random MAC, and set up according the the cluster level nic |
| 94 | 94 |
parameters. Each NIC can take these parameters (all optional): |
| 95 | 95 |
|
| 96 |
|
|
| 97 |
|
|
| 98 | 96 |
mac |
| 99 | 97 |
either a value or 'generate' to generate a new unique MAC |
| 100 | 98 |
|
| ... | ... | |
| 118 | 116 |
the instance, you can prevent the default of one NIC with the |
| 119 | 117 |
``--no-nics`` option. |
| 120 | 118 |
|
| 121 |
The ``-o`` options specifies the operating system to be installed. |
|
| 122 |
The available operating systems can be listed with **gnt-os list**. |
|
| 123 |
Passing ``--no-install`` will however skip the OS installation, |
|
| 124 |
allowing a manual import if so desired. Note that the no-installation |
|
| 125 |
mode will automatically disable the start-up of the instance (without |
|
| 126 |
an OS, it most likely won't be able to start-up successfully). |
|
| 119 |
The ``-o (--os-type)`` option specifies the operating system to be |
|
| 120 |
installed. The available operating systems can be listed with |
|
| 121 |
**gnt-os list**. Passing ``--no-install`` will however skip the OS |
|
| 122 |
installation, allowing a manual import if so desired. Note that the |
|
| 123 |
no-installation mode will automatically disable the start-up of the |
|
| 124 |
instance (without an OS, it most likely won't be able to start-up |
|
| 125 |
successfully). |
|
| 127 | 126 |
|
| 128 |
The ``-B`` option specifies the backend parameters for the
|
|
| 129 |
instance. If no such parameters are specified, the values are
|
|
| 130 |
inherited from the cluster. Possible parameters are: |
|
| 127 |
The ``-B (--backend-parameters)`` option specifies the backend
|
|
| 128 |
parameters for the instance. If no such parameters are specified, the
|
|
| 129 |
values are inherited from the cluster. Possible parameters are:
|
|
| 131 | 130 |
|
| 132 | 131 |
memory |
| 133 | 132 |
the memory size of the instance; as usual, suffixes can be used to |
| ... | ... | |
| 142 | 141 |
(enough redundancy in the cluster to survive a node failure) |
| 143 | 142 |
|
| 144 | 143 |
|
| 145 |
The ``-H`` option specified the hypervisor to use for the instance
|
|
| 146 |
(must be one of the enabled hypervisors on the cluster) and optionally
|
|
| 147 |
custom parameters for this instance. If not other options are used
|
|
| 148 |
(i.e. the invocation is just -H *NAME*) the instance will inherit the
|
|
| 149 |
cluster options. The defaults below show the cluster defaults at
|
|
| 150 |
cluster creation time. |
|
| 144 |
The ``-H (--hypervisor-parameters)`` option specified the hypervisor
|
|
| 145 |
to use for the instance (must be one of the enabled hypervisors on the
|
|
| 146 |
cluster) and optionally custom parameters for this instance. If not
|
|
| 147 |
other options are used (i.e. the invocation is just -H *NAME*) the
|
|
| 148 |
instance will inherit the cluster options. The defaults below show the
|
|
| 149 |
cluster defaults at cluster creation time.
|
|
| 151 | 150 |
|
| 152 | 151 |
The possible hypervisor options are as follows: |
| 153 | 152 |
|
| ... | ... | |
| 213 | 212 |
This parameter determines the way the network cards are presented |
| 214 | 213 |
to the instance. The possible options are: |
| 215 | 214 |
|
| 216 |
rtl8139 (default for Xen HVM) (HVM & KVM) |
|
| 217 |
ne2k\_isa (HVM & KVM) |
|
| 218 |
ne2k\_pci (HVM & KVM) |
|
| 219 |
i82551 (KVM) |
|
| 220 |
i82557b (KVM) |
|
| 221 |
i82559er (KVM) |
|
| 222 |
pcnet (KVM) |
|
| 223 |
e1000 (KVM) |
|
| 224 |
paravirtual (default for KVM) (HVM & KVM) |
|
| 215 |
- rtl8139 (default for Xen HVM) (HVM & KVM)
|
|
| 216 |
- ne2k\_isa (HVM & KVM)
|
|
| 217 |
- ne2k\_pci (HVM & KVM)
|
|
| 218 |
- i82551 (KVM)
|
|
| 219 |
- i82557b (KVM)
|
|
| 220 |
- i82559er (KVM)
|
|
| 221 |
- pcnet (KVM)
|
|
| 222 |
- e1000 (KVM)
|
|
| 223 |
- paravirtual (default for KVM) (HVM & KVM)
|
|
| 225 | 224 |
|
| 226 | 225 |
disk\_type |
| 227 | 226 |
Valid for the Xen HVM and KVM hypervisors. |
| ... | ... | |
| 431 | 430 |
"tablet". |
| 432 | 431 |
|
| 433 | 432 |
|
| 434 |
The ``-O`` (``--os-parameters``) option allows customisation of the OS
|
|
| 433 |
The ``-O (--os-parameters)`` option allows customisation of the OS
|
|
| 435 | 434 |
parameters. The actual parameter names and values depends on the OS |
| 436 | 435 |
being used, but the syntax is the same key=value. For example, setting |
| 437 | 436 |
a hypothetical ``dhcp`` parameter to yes can be achieved by:: |
| 438 | 437 |
|
| 439 | 438 |
gnt-instance add -O dhcp=yes ... |
| 440 | 439 |
|
| 440 |
The ``-I (--iallocator)`` option specifies the instance allocator |
|
| 441 |
plugin to use. If you pass in this option the allocator will select |
|
| 442 |
nodes for this instance automatically, so you don't need to pass them |
|
| 443 |
with the ``-n`` option. For more information please refer to the |
|
| 444 |
instance allocator documentation. |
|
| 441 | 445 |
|
| 442 |
The ``--iallocator`` option specifies the instance allocator plugin to |
|
| 443 |
use. If you pass in this option the allocator will select nodes for |
|
| 444 |
this instance automatically, so you don't need to pass them with the |
|
| 445 |
``-n`` option. For more information please refer to the instance |
|
| 446 |
allocator documentation. |
|
| 447 |
|
|
| 448 |
The ``-t`` options specifies the disk layout type for the instance. |
|
| 449 |
The available choices are: |
|
| 446 |
The ``-t (--disk-template)`` options specifies the disk layout type |
|
| 447 |
for the instance. The available choices are: |
|
| 450 | 448 |
|
| 451 | 449 |
diskless |
| 452 | 450 |
This creates an instance with no disks. Its useful for testing only |
| ... | ... | |
| 462 | 460 |
Disk devices will be drbd (version 8.x) on top of lvm volumes. |
| 463 | 461 |
|
| 464 | 462 |
|
| 465 |
The optional second value of the ``--node`` is used for the drbd
|
|
| 463 |
The optional second value of the ``-n (--node)`` is used for the drbd
|
|
| 466 | 464 |
template type and specifies the remote node. |
| 467 | 465 |
|
| 468 | 466 |
If you do not want gnt-instance to wait for the disk mirror to be |
| ... | ... | |
| 642 | 640 |
|
| 643 | 641 |
| **list** |
| 644 | 642 |
| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v] |
| 645 |
| [-o *[+]FIELD,...*] [instance...]
|
|
| 643 |
| [{-o|--output} *[+]FIELD,...*] [instance...]
|
|
| 646 | 644 |
|
| 647 | 645 |
Shows the currently configured instances with memory usage, disk |
| 648 | 646 |
usage, the node they are running on, and their run status. |
| ... | ... | |
| 662 | 660 |
The ``-v`` option activates verbose mode, which changes the display of |
| 663 | 661 |
special field states (see **ganeti(7)**). |
| 664 | 662 |
|
| 665 |
The ``-o`` option takes a comma-separated list of output fields. The |
|
| 666 |
available fields and their meaning are: |
|
| 667 |
|
|
| 663 |
The ``-o (--output)`` option takes a comma-separated list of output |
|
| 664 |
fields. The available fields and their meaning are: |
|
| 668 | 665 |
|
| 669 | 666 |
name |
| 670 | 667 |
the instance name |
| ... | ... | |
| 871 | 868 |
^^^^^^ |
| 872 | 869 |
|
| 873 | 870 |
| **modify** |
| 874 |
| [-H *HYPERVISOR\_PARAMETERS*]
|
|
| 875 |
| [-B *BACKEND\_PARAMETERS*]
|
|
| 871 |
| [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
|
|
| 872 |
| [{-B|--backend-parameters} *BACKEND\_PARAMETERS*]
|
|
| 876 | 873 |
| [--net add*[:options]* \| --net remove \| --net *N:options*] |
| 877 | 874 |
| [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \| |
| 878 | 875 |
| --disk *N*:mode=*MODE*] |
| 879 |
| [-t plain | -t drbd -n *new_secondary*] [--no-wait-for-sync]
|
|
| 876 |
| [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync]
|
|
| 880 | 877 |
| [--os-type=*OS* [--force-variant]] |
| 881 |
| [-O, --os-parameters *param*=*value*... ]
|
|
| 878 |
| [{-O|--os-parameters} *param*=*value*... ]
|
|
| 882 | 879 |
| [--submit] |
| 883 | 880 |
| {*instance*}
|
| 884 | 881 |
|
| ... | ... | |
| 887 | 884 |
disks and NICs to/from the instance. Note that you need to give at |
| 888 | 885 |
least one of the arguments, otherwise the command complains. |
| 889 | 886 |
|
| 890 |
The ``-H``, ``-B`` and ``-O`` options specifies hypervisor, backend |
|
| 891 |
and OS parameter options in the form of name=value[,...]. For details |
|
| 887 |
The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)`` |
|
| 888 |
and ``-O (--os-parameters)`` options specifies hypervisor, backend and |
|
| 889 |
OS parameter options in the form of name=value[,...]. For details |
|
| 892 | 890 |
which options can be specified, see the **add** command. |
| 893 | 891 |
|
| 894 |
The ``-t`` option will change the disk template of the instance.
|
|
| 895 |
Currently only conversions between the plain and drbd disk templates
|
|
| 896 |
are supported, and the instance must be stopped before attempting the
|
|
| 897 |
conversion. When changing from the plain to the drbd disk template, a
|
|
| 898 |
new secondary node must be specified via the ``-n`` option. The option
|
|
| 899 |
``--no-wait-for-sync`` can be used when converting to the ``drbd``
|
|
| 900 |
template in order to make the instance available for startup before
|
|
| 901 |
DRBD has finished resyncing. |
|
| 892 |
The ``-t (--disk-template)`` option will change the disk template of
|
|
| 893 |
the instance. Currently only conversions between the plain and drbd
|
|
| 894 |
disk templates are supported, and the instance must be stopped before
|
|
| 895 |
attempting the conversion. When changing from the plain to the drbd
|
|
| 896 |
disk template, a new secondary node must be specified via the ``-n``
|
|
| 897 |
option. The option ``--no-wait-for-sync`` can be used when converting
|
|
| 898 |
to the ``drbd`` template in order to make the instance available for
|
|
| 899 |
startup before DRBD has finished resyncing.
|
|
| 902 | 900 |
|
| 903 | 901 |
The ``--disk add:size=``*SIZE* option adds a disk to the instance. The |
| 904 | 902 |
optional ``vg=``*VG* option specifies LVM volume group other than |
| ... | ... | |
| 915 | 913 |
of the instance, while the ``--net`` *N*:*options* option will change |
| 916 | 914 |
the parameters of the Nth instance NIC. |
| 917 | 915 |
|
| 918 |
The option ``--os-type`` will change the OS name for the instance
|
|
| 916 |
The option ``-o (--os-type)`` will change the OS name for the instance
|
|
| 919 | 917 |
(without reinstallation). In case an OS variant is specified that is |
| 920 | 918 |
not found, then by default the modification is refused, unless |
| 921 | 919 |
``--force-variant`` is passed. An invalid OS will also be refused, |
| ... | ... | |
| 931 | 929 |
REINSTALL |
| 932 | 930 |
^^^^^^^^^ |
| 933 | 931 |
|
| 934 |
| **reinstall** [-o *os-type*] [--select-os] [-f *force*]
|
|
| 932 |
| **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*]
|
|
| 935 | 933 |
| [--force-multiple] |
| 936 | 934 |
| [--instance \| --node \| --primary \| --secondary \| --all] |
| 937 |
| [-O *OS\_PARAMETERS*] [--submit] {*instance*...}
|
|
| 935 |
| [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...}
|
|
| 938 | 936 |
|
| 939 | 937 |
Reinstalls the operating system on the given instance(s). The |
| 940 |
instance(s) must be stopped when running this command. If the |
|
| 941 |
``--os-type`` is specified, the operating system is changed.
|
|
| 938 |
instance(s) must be stopped when running this command. If the ``-o
|
|
| 939 |
(--os-type)`` is specified, the operating system is changed.
|
|
| 942 | 940 |
|
| 943 | 941 |
The ``--select-os`` option switches to an interactive OS reinstall. |
| 944 | 942 |
The user is prompted to select the OS template from the list of |
| 945 |
available OS templates. OS parameters can be overridden using ``-O`` |
|
| 946 |
(more documentation for this option under the **add** command). |
|
| 943 |
available OS templates. OS parameters can be overridden using ``-O |
|
| 944 |
(--os-parameters)`` (more documentation for this option under the |
|
| 945 |
**add** command). |
|
| 947 | 946 |
|
| 948 | 947 |
Since this is a potentially dangerous command, the user will be |
| 949 | 948 |
required to confirm this action, unless the ``-f`` flag is passed. |
| ... | ... | |
| 989 | 988 |
| [--force-multiple] |
| 990 | 989 |
| [--instance \| --node \| --primary \| --secondary \| --all \| |
| 991 | 990 |
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] |
| 992 |
| [-H ``key=value...``] [-B ``key=value...``] |
|
| 991 |
| [{-H|--hypervisor-parameters} ``key=value...``]
|
|
| 992 |
| [{-B|--backend-parameters} ``key=value...``]
|
|
| 993 | 993 |
| [--submit] |
| 994 | 994 |
| {*name*...}
|
| 995 | 995 |
|
| ... | ... | |
| 1043 | 1043 |
The ``--force-multiple`` will skip the interactive confirmation in the |
| 1044 | 1044 |
case the more than one instance will be affected. |
| 1045 | 1045 |
|
| 1046 |
The ``-H`` and ``-B`` options specify temporary hypervisor and backend |
|
| 1047 |
parameters that can be used to start an instance with modified |
|
| 1048 |
parameters. They can be useful for quick testing without having to |
|
| 1049 |
modify an instance back and forth, e.g.:: |
|
| 1046 |
The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)`` |
|
| 1047 |
options specify temporary hypervisor and backend parameters that can |
|
| 1048 |
be used to start an instance with modified parameters. They can be |
|
| 1049 |
useful for quick testing without having to modify an instance back and |
|
| 1050 |
forth, e.g.:: |
|
| 1050 | 1051 |
|
| 1051 | 1052 |
# gnt-instance start -H root_args="single" instance1 |
| 1052 | 1053 |
# gnt-instance start -B memory=2048 instance2 |
| ... | ... | |
| 1113 | 1114 |
^^^^^^ |
| 1114 | 1115 |
|
| 1115 | 1116 |
| **reboot** |
| 1116 |
| [--type=*REBOOT-TYPE*]
|
|
| 1117 |
| [{-t|--type} *REBOOT-TYPE*]
|
|
| 1117 | 1118 |
| [--ignore-secondaries] |
| 1118 | 1119 |
| [--shutdown-timeout=*N*] |
| 1119 | 1120 |
| [--force-multiple] |
| ... | ... | |
| 1123 | 1124 |
| [*name*...] |
| 1124 | 1125 |
|
| 1125 | 1126 |
Reboots one or more instances. The type of reboot depends on the value |
| 1126 |
of ``--type``. A soft reboot does a hypervisor reboot, a hard reboot
|
|
| 1127 |
of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
|
|
| 1127 | 1128 |
does a instance stop, recreates the hypervisor config for the instance |
| 1128 | 1129 |
and starts the instance. A full reboot does the equivalent of |
| 1129 | 1130 |
**gnt-instance shutdown && gnt-instance startup**. The default is |
Also available in: Unified diff