Revision e8f936b0 man/gnt-instance.rst
| b/man/gnt-instance.rst | ||
|---|---|---|
| 27 | 27 |
^^^ |
| 28 | 28 |
|
| 29 | 29 |
| **add** |
| 30 |
| {-t|--disk-template {diskless | file \| plain \| drbd \| rbd}}
|
|
| 31 |
| {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
|
|
| 32 |
| \| {-s|--os-size} *SIZE*}
|
|
| 33 |
| [--no-ip-check] [--no-name-check] [--no-start] [--no-install]
|
|
| 34 |
| [--net=*N* [:options...] \| --no-nics]
|
|
| 35 |
| [{-B|--backend-parameters} *BEPARAMS*]
|
|
| 36 |
| [{-H|--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
|
|
| 37 |
| [{-O|--os-parameters} *param*=*value*... ]
|
|
| 38 |
| [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}]
|
|
| 39 |
| {{-n|--node} *node[:secondary-node]* \| {-I|--iallocator} *name*}
|
|
| 40 |
| {{-o|--os-type} *os-type*}
|
|
| 41 |
| [--submit] |
|
| 42 |
| [--ignore-ipolicy] |
|
| 30 |
| {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}}
|
|
| 31 |
| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]
|
|
| 32 |
| \| {-s|\--os-size} *SIZE*}
|
|
| 33 |
| [\--no-ip-check] [\--no-name-check] [\--no-start] [\--no-install]
|
|
| 34 |
| [\--net=*N* [:options...] \| \--no-nics]
|
|
| 35 |
| [{-B|\--backend-parameters} *BEPARAMS*]
|
|
| 36 |
| [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]]
|
|
| 37 |
| [{-O|\--os-parameters} *param*=*value*... ]
|
|
| 38 |
| [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap}]
|
|
| 39 |
| {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*}
|
|
| 40 |
| {{-o|\--os-type} *os-type*}
|
|
| 41 |
| [\--submit]
|
|
| 42 |
| [\--ignore-ipolicy]
|
|
| 43 | 43 |
| {*instance*}
|
| 44 | 44 |
|
| 45 | 45 |
Creates a new instance on the specified host. The *instance* argument |
| ... | ... | |
| 743 | 743 |
REMOVE |
| 744 | 744 |
^^^^^^ |
| 745 | 745 |
|
| 746 |
**remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit]
|
|
| 747 |
[--force] {*instance*}
|
|
| 746 |
**remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
|
|
| 747 |
[\--force] {*instance*}
|
|
| 748 | 748 |
|
| 749 | 749 |
Remove an instance. This will remove all data from the instance and |
| 750 | 750 |
there is *no way back*. If you are not sure if you use an instance |
| ... | ... | |
| 776 | 776 |
^^^^ |
| 777 | 777 |
|
| 778 | 778 |
| **list** |
| 779 |
| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v]
|
|
| 780 |
| [{-o|--output} *[+]FIELD,...*] [--filter] [instance...]
|
|
| 779 |
| [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
|
|
| 780 |
| [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
|
|
| 781 | 781 |
|
| 782 | 782 |
Shows the currently configured instances with memory usage, disk |
| 783 | 783 |
usage, the node they are running on, and their run status. |
| ... | ... | |
| 837 | 837 |
INFO |
| 838 | 838 |
^^^^ |
| 839 | 839 |
|
| 840 |
**info** [-s \| --static] [--roman] {--all \| *instance*}
|
|
| 840 |
**info** [-s \| \--static] [\--roman] {\--all \| *instance*}
|
|
| 841 | 841 |
|
| 842 | 842 |
Show detailed information about the given instance(s). This is |
| 843 | 843 |
different from **list** as it shows detailed data about the instance's |
| ... | ... | |
| 858 | 858 |
^^^^^^ |
| 859 | 859 |
|
| 860 | 860 |
| **modify** |
| 861 |
| [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
|
|
| 862 |
| [{-B|--backend-parameters} *BACKEND\_PARAMETERS*]
|
|
| 863 |
| [{-m|--runtime-memory} *SIZE*]
|
|
| 864 |
| [--net add*[:options]* \| --net remove \| --net *N:options*]
|
|
| 865 |
| [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \|
|
|
| 866 |
| --disk *N*:mode=*MODE*] |
|
| 867 |
| [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync]
|
|
| 868 |
| [--os-type=*OS* [--force-variant]]
|
|
| 869 |
| [{-O|--os-parameters} *param*=*value*... ]
|
|
| 870 |
| [--offline \| --online]
|
|
| 871 |
| [--submit] |
|
| 872 |
| [--ignore-ipolicy] |
|
| 861 |
| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*]
|
|
| 862 |
| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*]
|
|
| 863 |
| [{-m|\--runtime-memory} *SIZE*]
|
|
| 864 |
| [\--net add*[:options]* \| \--net remove \| \--net *N:options*]
|
|
| 865 |
| [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk remove \|
|
|
| 866 |
| \--disk *N*:mode=*MODE*]
|
|
| 867 |
| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync]
|
|
| 868 |
| [\--os-type=*OS* [\--force-variant]]
|
|
| 869 |
| [{-O|\--os-parameters} *param*=*value*... ]
|
|
| 870 |
| [\--offline \| \--online]
|
|
| 871 |
| [\--submit]
|
|
| 872 |
| [\--ignore-ipolicy]
|
|
| 873 | 873 |
| {*instance*}
|
| 874 | 874 |
|
| 875 | 875 |
Modifies the memory size, number of vcpus, ip address, MAC address |
| ... | ... | |
| 940 | 940 |
REINSTALL |
| 941 | 941 |
^^^^^^^^^ |
| 942 | 942 |
|
| 943 |
| **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*]
|
|
| 944 |
| [--force-multiple] |
|
| 945 |
| [--instance \| --node \| --primary \| --secondary \| --all]
|
|
| 946 |
| [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...}
|
|
| 943 |
| **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*]
|
|
| 944 |
| [\--force-multiple]
|
|
| 945 |
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all]
|
|
| 946 |
| [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...}
|
|
| 947 | 947 |
|
| 948 | 948 |
Reinstalls the operating system on the given instance(s). The |
| 949 | 949 |
instance(s) must be stopped when running this command. If the ``-o |
| ... | ... | |
| 969 | 969 |
RENAME |
| 970 | 970 |
^^^^^^ |
| 971 | 971 |
|
| 972 |
| **rename** [--no-ip-check] [--no-name-check] [--submit]
|
|
| 972 |
| **rename** [\--no-ip-check] [\--no-name-check] [\--submit]
|
|
| 973 | 973 |
| {*instance*} {*new\_name*}
|
| 974 | 974 |
|
| 975 | 975 |
Renames the given instance. The instance must be stopped when running |
| ... | ... | |
| 996 | 996 |
^^^^^^^ |
| 997 | 997 |
|
| 998 | 998 |
| **startup** |
| 999 |
| [--force] [--ignore-offline]
|
|
| 1000 |
| [--force-multiple] [--no-remember]
|
|
| 1001 |
| [--instance \| --node \| --primary \| --secondary \| --all \|
|
|
| 1002 |
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
|
|
| 1003 |
| [{-H|--hypervisor-parameters} ``key=value...``]
|
|
| 1004 |
| [{-B|--backend-parameters} ``key=value...``]
|
|
| 1005 |
| [--submit] [--paused]
|
|
| 999 |
| [\--force] [\--ignore-offline]
|
|
| 1000 |
| [\--force-multiple] [\--no-remember]
|
|
| 1001 |
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
|
|
| 1002 |
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
|
|
| 1003 |
| [{-H|\--hypervisor-parameters} ``key=value...``]
|
|
| 1004 |
| [{-B|\--backend-parameters} ``key=value...``]
|
|
| 1005 |
| [\--submit] [\--paused]
|
|
| 1006 | 1006 |
| {*name*...}
|
| 1007 | 1007 |
|
| 1008 | 1008 |
Starts one or more instances, depending on the following options. The |
| 1009 | 1009 |
four available modes are: |
| 1010 | 1010 |
|
| 1011 |
--instance |
|
| 1011 |
\--instance
|
|
| 1012 | 1012 |
will start the instances given as arguments (at least one argument |
| 1013 | 1013 |
required); this is the default selection |
| 1014 | 1014 |
|
| 1015 |
--node |
|
| 1015 |
\--node
|
|
| 1016 | 1016 |
will start the instances who have the given node as either primary |
| 1017 | 1017 |
or secondary |
| 1018 | 1018 |
|
| 1019 |
--primary |
|
| 1019 |
\--primary
|
|
| 1020 | 1020 |
will start all instances whose primary node is in the list of nodes |
| 1021 | 1021 |
passed as arguments (at least one node required) |
| 1022 | 1022 |
|
| 1023 |
--secondary |
|
| 1023 |
\--secondary
|
|
| 1024 | 1024 |
will start all instances whose secondary node is in the list of |
| 1025 | 1025 |
nodes passed as arguments (at least one node required) |
| 1026 | 1026 |
|
| 1027 |
--all |
|
| 1027 |
\--all
|
|
| 1028 | 1028 |
will start all instances in the cluster (no arguments accepted) |
| 1029 | 1029 |
|
| 1030 |
--tags |
|
| 1030 |
\--tags
|
|
| 1031 | 1031 |
will start all instances in the cluster with the tags given as |
| 1032 | 1032 |
arguments |
| 1033 | 1033 |
|
| 1034 |
--node-tags |
|
| 1034 |
\--node-tags
|
|
| 1035 | 1035 |
will start all instances in the cluster on nodes with the tags |
| 1036 | 1036 |
given as arguments |
| 1037 | 1037 |
|
| 1038 |
--pri-node-tags |
|
| 1038 |
\--pri-node-tags
|
|
| 1039 | 1039 |
will start all instances in the cluster on primary nodes with the |
| 1040 | 1040 |
tags given as arguments |
| 1041 | 1041 |
|
| 1042 |
--sec-node-tags |
|
| 1042 |
\--sec-node-tags
|
|
| 1043 | 1043 |
will start all instances in the cluster on secondary nodes with the |
| 1044 | 1044 |
tags given as arguments |
| 1045 | 1045 |
|
| ... | ... | |
| 1096 | 1096 |
^^^^^^^^ |
| 1097 | 1097 |
|
| 1098 | 1098 |
| **shutdown** |
| 1099 |
| [--timeout=*N*] |
|
| 1100 |
| [--force-multiple] [--ignore-offline] [--no-remember]
|
|
| 1101 |
| [--instance \| --node \| --primary \| --secondary \| --all \|
|
|
| 1102 |
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
|
|
| 1103 |
| [--submit] |
|
| 1099 |
| [\--timeout=*N*]
|
|
| 1100 |
| [\--force-multiple] [\--ignore-offline] [\--no-remember]
|
|
| 1101 |
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
|
|
| 1102 |
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
|
|
| 1103 |
| [\--submit]
|
|
| 1104 | 1104 |
| {*name*...}
|
| 1105 | 1105 |
|
| 1106 | 1106 |
Stops one or more instances. If the instance cannot be cleanly stopped |
| ... | ... | |
| 1145 | 1145 |
^^^^^^ |
| 1146 | 1146 |
|
| 1147 | 1147 |
| **reboot** |
| 1148 |
| [{-t|--type} *REBOOT-TYPE*]
|
|
| 1149 |
| [--ignore-secondaries] |
|
| 1150 |
| [--shutdown-timeout=*N*] |
|
| 1151 |
| [--force-multiple] |
|
| 1152 |
| [--instance \| --node \| --primary \| --secondary \| --all \|
|
|
| 1153 |
| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]
|
|
| 1154 |
| [--submit] |
|
| 1148 |
| [{-t|\--type} *REBOOT-TYPE*]
|
|
| 1149 |
| [\--ignore-secondaries]
|
|
| 1150 |
| [\--shutdown-timeout=*N*]
|
|
| 1151 |
| [\--force-multiple]
|
|
| 1152 |
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
|
|
| 1153 |
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
|
|
| 1154 |
| [\--submit]
|
|
| 1155 | 1155 |
| [*name*...] |
| 1156 | 1156 |
|
| 1157 | 1157 |
Reboots one or more instances. The type of reboot depends on the value |
| ... | ... | |
| 1186 | 1186 |
CONSOLE |
| 1187 | 1187 |
^^^^^^^ |
| 1188 | 1188 |
|
| 1189 |
**console** [--show-cmd] {*instance*}
|
|
| 1189 |
**console** [\--show-cmd] {*instance*}
|
|
| 1190 | 1190 |
|
| 1191 | 1191 |
Connects to the console of the given instance. If the instance is not |
| 1192 | 1192 |
up, an error is returned. Use the ``--show-cmd`` option to display the |
| ... | ... | |
| 1212 | 1212 |
REPLACE-DISKS |
| 1213 | 1213 |
^^^^^^^^^^^^^ |
| 1214 | 1214 |
|
| 1215 |
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-p}
|
|
| 1216 |
[--disks *idx*] {*instance*}
|
|
| 1215 |
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p}
|
|
| 1216 |
[\--disks *idx*] {*instance*}
|
|
| 1217 | 1217 |
|
| 1218 |
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-s}
|
|
| 1219 |
[--disks *idx*] {*instance*}
|
|
| 1218 |
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s}
|
|
| 1219 |
[\--disks *idx*] {*instance*}
|
|
| 1220 | 1220 |
|
| 1221 |
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy]
|
|
| 1222 |
{--iallocator *name* \| -- {*instance*}
|
|
| 1221 |
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
|
|
| 1222 |
{\--iallocator *name* \| \--node *node* } {*instance*}
|
|
| 1223 | 1223 |
|
| 1224 |
**replace-disks** [--submit] [--early-release] [--ignore-ipolicy]
|
|
| 1225 |
{--auto} {*instance*}
|
|
| 1224 |
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
|
|
| 1225 |
{\--auto} {*instance*}
|
|
| 1226 | 1226 |
|
| 1227 | 1227 |
This command is a generalized form for replacing disks. It is |
| 1228 | 1228 |
currently only valid for the mirrored (DRBD) disk template. |
| ... | ... | |
| 1271 | 1271 |
ACTIVATE-DISKS |
| 1272 | 1272 |
^^^^^^^^^^^^^^ |
| 1273 | 1273 |
|
| 1274 |
**activate-disks** [--submit] [--ignore-size] {*instance*}
|
|
| 1274 |
**activate-disks** [\--submit] [\--ignore-size] {*instance*}
|
|
| 1275 | 1275 |
|
| 1276 | 1276 |
Activates the block devices of the given instance. If successful, the |
| 1277 | 1277 |
command will show the location and name of the block devices:: |
| ... | ... | |
| 1302 | 1302 |
DEACTIVATE-DISKS |
| 1303 | 1303 |
^^^^^^^^^^^^^^^^ |
| 1304 | 1304 |
|
| 1305 |
**deactivate-disks** [-f] [--submit] {*instance*}
|
|
| 1305 |
**deactivate-disks** [-f] [\--submit] {*instance*}
|
|
| 1306 | 1306 |
|
| 1307 | 1307 |
De-activates the block devices of the given instance. Note that if you |
| 1308 | 1308 |
run this command for an instance with a drbd disk template, while it |
| ... | ... | |
| 1324 | 1324 |
GROW-DISK |
| 1325 | 1325 |
^^^^^^^^^ |
| 1326 | 1326 |
|
| 1327 |
**grow-disk** [--no-wait-for-sync] [--submit] {*instance*} {*disk*}
|
|
| 1327 |
**grow-disk** [\--no-wait-for-sync] [\--submit] {*instance*} {*disk*}
|
|
| 1328 | 1328 |
{*amount*}
|
| 1329 | 1329 |
|
| 1330 | 1330 |
Grows an instance's disk. This is only possible for instances having a |
| ... | ... | |
| 1372 | 1372 |
RECREATE-DISKS |
| 1373 | 1373 |
^^^^^^^^^^^^^^ |
| 1374 | 1374 |
|
| 1375 |
| **recreate-disks** [--submit] [-n node1:[node2]] |
|
| 1376 |
| [--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
|
|
| 1375 |
| **recreate-disks** [\--submit] [-n node1:[node2]]
|
|
| 1376 |
| [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
|
|
| 1377 | 1377 |
|
| 1378 | 1378 |
Recreates all or a subset of disks of the given instance. |
| 1379 | 1379 |
|
| ... | ... | |
| 1408 | 1408 |
FAILOVER |
| 1409 | 1409 |
^^^^^^^^ |
| 1410 | 1410 |
|
| 1411 |
| **failover** [-f] [--ignore-consistency] [--ignore-ipolicy]
|
|
| 1412 |
| [--shutdown-timeout=*N*] |
|
| 1413 |
| [{-n|--target-node} *node* \| {-I|--iallocator} *name*]
|
|
| 1414 |
| [--submit] |
|
| 1411 |
| **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy]
|
|
| 1412 |
| [\--shutdown-timeout=*N*]
|
|
| 1413 |
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
|
|
| 1414 |
| [\--submit]
|
|
| 1415 | 1415 |
| {*instance*}
|
| 1416 | 1416 |
|
| 1417 | 1417 |
Failover will stop the instance (if running), change its primary node, |
| ... | ... | |
| 1455 | 1455 |
MIGRATE |
| 1456 | 1456 |
^^^^^^^ |
| 1457 | 1457 |
|
| 1458 |
**migrate** [-f] {--cleanup} {*instance*}
|
|
| 1458 |
**migrate** [-f] {\--cleanup} {*instance*}
|
|
| 1459 | 1459 |
|
| 1460 |
**migrate** [-f] [--allow-failover] [--non-live]
|
|
| 1461 |
[--migration-mode=live\|non-live] [--ignore-ipolicy]
|
|
| 1462 |
[--no-runtime-changes] |
|
| 1463 |
[{-n|--target-node} *node* \| {-I|--iallocator} *name*] {*instance*}
|
|
| 1460 |
**migrate** [-f] [\--allow-failover] [\--non-live]
|
|
| 1461 |
[\--migration-mode=live\|non-live] [\--ignore-ipolicy]
|
|
| 1462 |
[\--no-runtime-changes]
|
|
| 1463 |
[{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
|
|
| 1464 | 1464 |
|
| 1465 | 1465 |
Migrate will move the instance to its secondary node without shutdown. |
| 1466 | 1466 |
As with failover, it only works for instances having the drbd disk |
| ... | ... | |
| 1537 | 1537 |
MOVE |
| 1538 | 1538 |
^^^^ |
| 1539 | 1539 |
|
| 1540 |
**move** [-f] [--ignore-consistency] |
|
| 1541 |
[-n *node*] [--shutdown-timeout=*N*] [--submit] [--ignore-ipolicy]
|
|
| 1540 |
**move** [-f] [\--ignore-consistency]
|
|
| 1541 |
[-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy]
|
|
| 1542 | 1542 |
{*instance*}
|
| 1543 | 1543 |
|
| 1544 | 1544 |
Move will move the instance to an arbitrary node in the cluster. This |
| ... | ... | |
| 1572 | 1572 |
CHANGE-GROUP |
| 1573 | 1573 |
~~~~~~~~~~~~ |
| 1574 | 1574 |
|
| 1575 |
**change-group** [--iallocator *NAME*] [--to *GROUP*...] {*instance*}
|
|
| 1575 |
**change-group** [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
|
|
| 1576 | 1576 |
|
| 1577 | 1577 |
This command moves an instance to another node group. The move is |
| 1578 | 1578 |
calculated by an iallocator, either given on the command line or as a |
| ... | ... | |
| 1592 | 1592 |
ADD-TAGS |
| 1593 | 1593 |
^^^^^^^^ |
| 1594 | 1594 |
|
| 1595 |
**add-tags** [--from *file*] {*instancename*} {*tag*...}
|
|
| 1595 |
**add-tags** [\--from *file*] {*instancename*} {*tag*...}
|
|
| 1596 | 1596 |
|
| 1597 | 1597 |
Add tags to the given instance. If any of the tags contains invalid |
| 1598 | 1598 |
characters, the entire operation will abort. |
| ... | ... | |
| 1613 | 1613 |
REMOVE-TAGS |
| 1614 | 1614 |
^^^^^^^^^^^ |
| 1615 | 1615 |
|
| 1616 |
**remove-tags** [--from *file*] {*instancename*} {*tag*...}
|
|
| 1616 |
**remove-tags** [\--from *file*] {*instancename*} {*tag*...}
|
|
| 1617 | 1617 |
|
| 1618 | 1618 |
Remove tags from the given instance. If any of the tags are not |
| 1619 | 1619 |
existing on the node, the entire operation will abort. |
Also available in: Unified diff