#!/usr/bin/python
#
-# Copyright (C) 2006, 2007 Google Inc.
+# Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
+"""Instance related commands"""
+
+# pylint: disable-msg=W0401,W0614,C0103
+# W0401: Wildcard import ganeti.cli
+# W0614: Unused import %s from wildcard import (since we need cli)
+# C0103: Invalid name gnt-instance
import sys
import os
import itertools
-from optparse import make_option
+import simplejson
from cStringIO import StringIO
from ganeti.cli import *
from ganeti import opcodes
-from ganeti import logger
from ganeti import constants
+from ganeti import compat
from ganeti import utils
from ganeti import errors
+from ganeti import netutils
_SHUTDOWN_CLUSTER = "cluster"
_SHUTDOWN_NODES_BOTH = "nodes"
_SHUTDOWN_NODES_PRI = "nodes-pri"
_SHUTDOWN_NODES_SEC = "nodes-sec"
+_SHUTDOWN_NODES_BOTH_BY_TAGS = "nodes-by-tags"
+_SHUTDOWN_NODES_PRI_BY_TAGS = "nodes-pri-by-tags"
+_SHUTDOWN_NODES_SEC_BY_TAGS = "nodes-sec-by-tags"
_SHUTDOWN_INSTANCES = "instances"
+_SHUTDOWN_INSTANCES_BY_TAGS = "instances-by-tags"
+
+_SHUTDOWN_NODES_TAGS_MODES = (
+ _SHUTDOWN_NODES_BOTH_BY_TAGS,
+ _SHUTDOWN_NODES_PRI_BY_TAGS,
+ _SHUTDOWN_NODES_SEC_BY_TAGS)
_VALUE_TRUE = "true"
+#: default list of options for L{ListInstances}
_LIST_DEF_FIELDS = [
- "name", "os", "pnode", "status", "oper_ram",
+ "name", "hypervisor", "os", "pnode", "status", "oper_ram",
]
-def _ExpandMultiNames(mode, names):
+def _ExpandMultiNames(mode, names, client=None):
"""Expand the given names using the passed mode.
- Args:
- - mode, which can be one of _SHUTDOWN_CLUSTER, _SHUTDOWN_NODES_BOTH,
- _SHUTDOWN_NODES_PRI, _SHUTDOWN_NODES_SEC or _SHUTDOWN_INSTANCES
- - names, which is a list of names; for cluster, it must be empty,
- and for node and instance it must be a list of valid item
- names (short names are valid as usual, e.g. node1 instead of
- node1.example.com)
-
For _SHUTDOWN_CLUSTER, all instances will be returned. For
_SHUTDOWN_NODES_PRI/SEC, all instances having those nodes as
- primary/secondary will be shutdown. For _SHUTDOWN_NODES_BOTH, all
+ primary/secondary will be returned. For _SHUTDOWN_NODES_BOTH, all
instances having those nodes as either primary or secondary will be
returned. For _SHUTDOWN_INSTANCES, the given instances will be
returned.
+ @param mode: one of L{_SHUTDOWN_CLUSTER}, L{_SHUTDOWN_NODES_BOTH},
+ L{_SHUTDOWN_NODES_PRI}, L{_SHUTDOWN_NODES_SEC} or
+ L{_SHUTDOWN_INSTANCES}
+ @param names: a list of names; for cluster, it must be empty,
+ and for node and instance it must be a list of valid item
+ names (short names are valid as usual, e.g. node1 instead of
+ node1.example.com)
+ @rtype: list
+ @return: the list of names after the expansion
+ @raise errors.ProgrammerError: for unknown selection type
+ @raise errors.OpPrereqError: for invalid input parameters
+
"""
+ # pylint: disable-msg=W0142
+
+ if client is None:
+ client = GetClient()
if mode == _SHUTDOWN_CLUSTER:
if names:
- raise errors.OpPrereqError("Cluster filter mode takes no arguments")
- op = opcodes.OpQueryInstances(output_fields=["name"], names=[])
- idata = SubmitOpCode(op)
+ raise errors.OpPrereqError("Cluster filter mode takes no arguments",
+ errors.ECODE_INVAL)
+ idata = client.QueryInstances([], ["name"], False)
inames = [row[0] for row in idata]
elif mode in (_SHUTDOWN_NODES_BOTH,
_SHUTDOWN_NODES_PRI,
- _SHUTDOWN_NODES_SEC):
- if not names:
- raise errors.OpPrereqError("No node names passed")
- op = opcodes.OpQueryNodes(output_fields=["name", "pinst_list",
- "sinst_list"], names=names)
- ndata = SubmitOpCode(op)
+ _SHUTDOWN_NODES_SEC) + _SHUTDOWN_NODES_TAGS_MODES:
+ if mode in _SHUTDOWN_NODES_TAGS_MODES:
+ if not names:
+ raise errors.OpPrereqError("No node tags passed", errors.ECODE_INVAL)
+ ndata = client.QueryNodes([], ["name", "pinst_list",
+ "sinst_list", "tags"], False)
+ ndata = [row for row in ndata if set(row[3]).intersection(names)]
+ else:
+ if not names:
+ raise errors.OpPrereqError("No node names passed", errors.ECODE_INVAL)
+ ndata = client.QueryNodes(names, ["name", "pinst_list", "sinst_list"],
+ False)
+
ipri = [row[1] for row in ndata]
pri_names = list(itertools.chain(*ipri))
isec = [row[2] for row in ndata]
sec_names = list(itertools.chain(*isec))
- if mode == _SHUTDOWN_NODES_BOTH:
+ if mode in (_SHUTDOWN_NODES_BOTH, _SHUTDOWN_NODES_BOTH_BY_TAGS):
inames = pri_names + sec_names
- elif mode == _SHUTDOWN_NODES_PRI:
+ elif mode in (_SHUTDOWN_NODES_PRI, _SHUTDOWN_NODES_PRI_BY_TAGS):
inames = pri_names
- elif mode == _SHUTDOWN_NODES_SEC:
+ elif mode in (_SHUTDOWN_NODES_SEC, _SHUTDOWN_NODES_SEC_BY_TAGS):
inames = sec_names
else:
raise errors.ProgrammerError("Unhandled shutdown type")
-
elif mode == _SHUTDOWN_INSTANCES:
if not names:
- raise errors.OpPrereqError("No instance names passed")
- op = opcodes.OpQueryInstances(output_fields=["name"], names=names)
- idata = SubmitOpCode(op)
+ raise errors.OpPrereqError("No instance names passed",
+ errors.ECODE_INVAL)
+ idata = client.QueryInstances(names, ["name"], False)
inames = [row[0] for row in idata]
-
+ elif mode == _SHUTDOWN_INSTANCES_BY_TAGS:
+ if not names:
+ raise errors.OpPrereqError("No instance tags passed",
+ errors.ECODE_INVAL)
+ idata = client.QueryInstances([], ["name", "tags"], False)
+ inames = [row[0] for row in idata if set(row[1]).intersection(names)]
else:
- raise errors.OpPrereqError("Unknown mode '%s'" % mode)
+ raise errors.OpPrereqError("Unknown mode '%s'" % mode, errors.ECODE_INVAL)
return inames
-def _ConfirmOperation(inames, text):
+def _ConfirmOperation(inames, text, extra=""):
"""Ask the user to confirm an operation on a list of instances.
This function is used to request confirmation for doing an operation
on a given list of instances.
- The inames argument is what the selection algorithm computed, and
- the text argument is the operation we should tell the user to
- confirm (e.g. 'shutdown' or 'startup').
-
- Returns: boolean depending on user's confirmation.
+ @type inames: list
+ @param inames: the list of names that we display when
+ we ask for confirmation
+ @type text: str
+ @param text: the operation that the user should confirm
+ (e.g. I{shutdown} or I{startup})
+ @rtype: boolean
+ @return: True or False depending on user's confirmation.
"""
count = len(inames)
- msg = ("The %s will operate on %d instances.\n"
- "Do you want to continue?" % (text, count))
+ msg = ("The %s will operate on %d instances.\n%s"
+ "Do you want to continue?" % (text, count, extra))
affected = ("\nAffected instances:\n" +
"\n".join([" %s" % name for name in inames]))
return choice
-def _TransformPath(user_input):
- """Transform a user path into a canonical value.
+def _EnsureInstancesExist(client, names):
+ """Check for and ensure the given instance names exist.
+
+ This function will raise an OpPrereqError in case they don't
+ exist. Otherwise it will exit cleanly.
- This function transforms the a path passed as textual information
- into the constants that the LU code expects.
+ @type client: L{ganeti.luxi.Client}
+ @param client: the client to use for the query
+ @type names: list
+ @param names: the list of instance names to query
+ @raise errors.OpPrereqError: in case any instance is missing
"""
- if user_input:
- if user_input.lower() == "default":
- result_path = constants.VALUE_DEFAULT
- elif user_input.lower() == "none":
- result_path = constants.VALUE_NONE
- else:
- if not os.path.isabs(user_input):
- raise errors.OpPrereqError("Path '%s' is not an absolute filename" %
- user_input)
- result_path = user_input
- else:
- result_path = constants.VALUE_DEFAULT
+ # TODO: change LUQueryInstances to that it actually returns None
+ # instead of raising an exception, or devise a better mechanism
+ result = client.QueryInstances(names, ["name"], False)
+ for orig_name, row in zip(names, result):
+ if row[0] is None:
+ raise errors.OpPrereqError("Instance '%s' does not exist" % orig_name,
+ errors.ECODE_NOENT)
+
- return result_path
+def GenericManyOps(operation, fn):
+ """Generic multi-instance operations.
+
+ The will return a wrapper that processes the options and arguments
+ given, and uses the passed function to build the opcode needed for
+ the specific operation. Thus all the generic loop/confirmation code
+ is abstracted into this function.
+
+ """
+ def realfn(opts, args):
+ if opts.multi_mode is None:
+ opts.multi_mode = _SHUTDOWN_INSTANCES
+ cl = GetClient()
+ inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
+ if not inames:
+ raise errors.OpPrereqError("Selection filter does not match"
+ " any instances", errors.ECODE_INVAL)
+ multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
+ if not (opts.force_multi or not multi_on
+ or _ConfirmOperation(inames, operation)):
+ return 1
+ jex = JobExecutor(verbose=multi_on, cl=cl, opts=opts)
+ for name in inames:
+ op = fn(name, opts)
+ jex.QueueJob(name, op)
+ results = jex.WaitOrShow(not opts.submit_only)
+ rcode = compat.all(row[0] for row in results)
+ return int(not rcode)
+ return realfn
def ListInstances(opts, args):
"""List instances and their properties.
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should be an empty list
+ @rtype: int
+ @return: the desired exit code
+
"""
if opts.output is None:
selected_fields = _LIST_DEF_FIELDS
else:
selected_fields = opts.output.split(",")
- op = opcodes.OpQueryInstances(output_fields=selected_fields, names=[])
- output = SubmitOpCode(op)
+ output = GetClient().QueryInstances(args, selected_fields, opts.do_locking)
if not opts.no_headers:
headers = {
"name": "Instance", "os": "OS", "pnode": "Primary_node",
"snodes": "Secondary_Nodes", "admin_state": "Autostart",
- "oper_state": "Running", "admin_ram": "Configured_memory",
+ "oper_state": "Running",
"oper_ram": "Memory", "disk_template": "Disk_template",
- "ip": "IP Address", "mac": "MAC Address",
- "bridge": "Bridge", "vcpus": "VCPUs",
+ "oper_vcpus": "VCPUs",
+ "ip": "IP_address", "mac": "MAC_address",
+ "nic_mode": "NIC_Mode", "nic_link": "NIC_Link",
+ "bridge": "Bridge",
"sda_size": "Disk/0", "sdb_size": "Disk/1",
- "status": "Status",
+ "disk_usage": "DiskUsage",
+ "status": "Status", "tags": "Tags",
+ "network_port": "Network_port",
+ "hv/kernel_path": "Kernel_path",
+ "hv/initrd_path": "Initrd_path",
+ "hv/boot_order": "Boot_order",
+ "hv/acpi": "ACPI",
+ "hv/pae": "PAE",
+ "hv/cdrom_image_path": "CDROM_image_path",
+ "hv/nic_type": "NIC_type",
+ "hv/disk_type": "Disk_type",
+ "hv/vnc_bind_address": "VNC_bind_address",
+ "serial_no": "SerialNo", "hypervisor": "Hypervisor",
+ "hvparams": "Hypervisor_parameters",
+ "be/memory": "Configured_memory",
+ "be/vcpus": "VCPUs",
+ "vcpus": "VCPUs",
+ "be/auto_balance": "Auto_balance",
+ "disk.count": "Disks", "disk.sizes": "Disk_sizes",
+ "nic.count": "NICs", "nic.ips": "NIC_IPs",
+ "nic.modes": "NIC_modes", "nic.links": "NIC_links",
+ "nic.bridges": "NIC_bridges", "nic.macs": "NIC_MACs",
+ "ctime": "CTime", "mtime": "MTime", "uuid": "UUID",
}
else:
headers = None
- if opts.human_readable:
- unitfields = ["admin_ram", "oper_ram", "sda_size", "sdb_size"]
- else:
- unitfields = None
-
- numfields = ["admin_ram", "oper_ram", "sda_size", "sdb_size", "vcpus"]
+ unitfields = ["be/memory", "oper_ram", "sd(a|b)_size", "disk\.size/.*"]
+ numfields = ["be/memory", "oper_ram", "sd(a|b)_size", "be/vcpus",
+ "serial_no", "(disk|nic)\.count", "disk\.size/.*"]
+ list_type_fields = ("tags", "disk.sizes", "nic.macs", "nic.ips",
+ "nic.modes", "nic.links", "nic.bridges")
# change raw values to nicer strings
for row in output:
for idx, field in enumerate(selected_fields):
elif field == "oper_ram":
if val is None:
val = "(node down)"
+ elif field == "oper_vcpus":
+ if val is None:
+ val = "(node down)"
elif field == "sda_size" or field == "sdb_size":
if val is None:
val = "N/A"
+ elif field == "ctime" or field == "mtime":
+ val = utils.FormatTime(val)
+ elif field in list_type_fields:
+ val = ",".join(str(item) for item in val)
+ elif val is None:
+ val = "-"
+ if opts.roman_integers and isinstance(val, int):
+ val = compat.TryToRoman(val)
row[idx] = str(val)
data = GenerateTable(separator=opts.separator, headers=headers,
fields=selected_fields, unitfields=unitfields,
- numfields=numfields, data=output)
+ numfields=numfields, data=output, units=opts.units)
for line in data:
- logger.ToStdout(line)
+ ToStdout(line)
return 0
def AddInstance(opts, args):
"""Add an instance to the cluster.
- Args:
- opts - class with options as members
- args - list with a single element, the instance name
- Opts used:
- mem - amount of memory to allocate to instance (MiB)
- size - amount of disk space to allocate to instance (MiB)
- os - which OS to run on instance
- node - node to run new instance on
+ This is just a wrapper over GenericInstanceCreate.
"""
- instance = args[0]
+ return GenericInstanceCreate(constants.INSTANCE_CREATE, opts, args)
- (pnode, snode) = SplitNodeOption(opts.node)
- kernel_path = _TransformPath(opts.kernel_path)
- initrd_path = _TransformPath(opts.initrd_path)
+def BatchCreate(opts, args):
+ """Create instances using a definition file.
- hvm_acpi = opts.hvm_acpi == _VALUE_TRUE
- hvm_pae = opts.hvm_pae == _VALUE_TRUE
+ This function reads a json file with instances defined
+ in the form::
+
+ {"instance-name":{
+ "disk_size": [20480],
+ "template": "drbd",
+ "backend": {
+ "memory": 512,
+ "vcpus": 1 },
+ "os": "debootstrap",
+ "primary_node": "firstnode",
+ "secondary_node": "secondnode",
+ "iallocator": "dumb"}
+ }
+
+ Note that I{primary_node} and I{secondary_node} have precedence over
+ I{iallocator}.
+
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain one element, the json filename
+ @rtype: int
+ @return: the desired exit code
+
+ """
+ _DEFAULT_SPECS = {"disk_size": [20 * 1024],
+ "backend": {},
+ "iallocator": None,
+ "primary_node": None,
+ "secondary_node": None,
+ "nics": None,
+ "start": True,
+ "ip_check": True,
+ "name_check": True,
+ "hypervisor": None,
+ "hvparams": {},
+ "file_storage_dir": None,
+ "force_variant": False,
+ "file_driver": 'loop'}
+
+ def _PopulateWithDefaults(spec):
+ """Returns a new hash combined with default values."""
+ mydict = _DEFAULT_SPECS.copy()
+ mydict.update(spec)
+ return mydict
+
+ def _Validate(spec):
+ """Validate the instance specs."""
+ # Validate fields required under any circumstances
+ for required_field in ('os', 'template'):
+ if required_field not in spec:
+ raise errors.OpPrereqError('Required field "%s" is missing.' %
+ required_field, errors.ECODE_INVAL)
+ # Validate special fields
+ if spec['primary_node'] is not None:
+ if (spec['template'] in constants.DTS_NET_MIRROR and
+ spec['secondary_node'] is None):
+ raise errors.OpPrereqError('Template requires secondary node, but'
+ ' there was no secondary provided.',
+ errors.ECODE_INVAL)
+ elif spec['iallocator'] is None:
+ raise errors.OpPrereqError('You have to provide at least a primary_node'
+ ' or an iallocator.',
+ errors.ECODE_INVAL)
+
+ if (spec['hvparams'] and
+ not isinstance(spec['hvparams'], dict)):
+ raise errors.OpPrereqError('Hypervisor parameters must be a dict.',
+ errors.ECODE_INVAL)
+
+ json_filename = args[0]
+ try:
+ instance_data = simplejson.loads(utils.ReadFile(json_filename))
+ except Exception, err: # pylint: disable-msg=W0703
+ ToStderr("Can't parse the instance definition file: %s" % str(err))
+ return 1
+
+ if not isinstance(instance_data, dict):
+ ToStderr("The instance definition file is not in dict format.")
+ return 1
+
+ jex = JobExecutor(opts=opts)
+
+ # Iterate over the instances and do:
+ # * Populate the specs with default value
+ # * Validate the instance specs
+ i_names = utils.NiceSort(instance_data.keys()) # pylint: disable-msg=E1103
+ for name in i_names:
+ specs = instance_data[name]
+ specs = _PopulateWithDefaults(specs)
+ _Validate(specs)
+
+ hypervisor = specs['hypervisor']
+ hvparams = specs['hvparams']
+
+ disks = []
+ for elem in specs['disk_size']:
+ try:
+ size = utils.ParseUnit(elem)
+ except (TypeError, ValueError), err:
+ raise errors.OpPrereqError("Invalid disk size '%s' for"
+ " instance %s: %s" %
+ (elem, name, err), errors.ECODE_INVAL)
+ disks.append({"size": size})
+
+ utils.ForceDictType(specs['backend'], constants.BES_PARAMETER_TYPES)
+ utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)
+
+ tmp_nics = []
+ for field in ('ip', 'mac', 'mode', 'link', 'bridge'):
+ if field in specs:
+ if not tmp_nics:
+ tmp_nics.append({})
+ tmp_nics[0][field] = specs[field]
+
+ if specs['nics'] is not None and tmp_nics:
+ raise errors.OpPrereqError("'nics' list incompatible with using"
+ " individual nic fields as well",
+ errors.ECODE_INVAL)
+ elif specs['nics'] is not None:
+ tmp_nics = specs['nics']
+ elif not tmp_nics:
+ tmp_nics = [{}]
+
+ op = opcodes.OpCreateInstance(instance_name=name,
+ disks=disks,
+ disk_template=specs['template'],
+ mode=constants.INSTANCE_CREATE,
+ os_type=specs['os'],
+ force_variant=specs["force_variant"],
+ pnode=specs['primary_node'],
+ snode=specs['secondary_node'],
+ nics=tmp_nics,
+ start=specs['start'],
+ ip_check=specs['ip_check'],
+ name_check=specs['name_check'],
+ wait_for_sync=True,
+ iallocator=specs['iallocator'],
+ hypervisor=hypervisor,
+ hvparams=hvparams,
+ beparams=specs['backend'],
+ file_storage_dir=specs['file_storage_dir'],
+ file_driver=specs['file_driver'])
+
+ jex.QueueJob(name, op)
+ # we never want to wait, just show the submitted job IDs
+ jex.WaitOrShow(False)
- if ((opts.hvm_cdrom_image_path is not None) and
- (opts.hvm_cdrom_image_path.lower() == constants.VALUE_NONE)):
- hvm_cdrom_image_path = None
- else:
- hvm_cdrom_image_path = opts.hvm_cdrom_image_path
-
- op = opcodes.OpCreateInstance(instance_name=instance, mem_size=opts.mem,
- disk_size=opts.size, swap_size=opts.swap,
- disk_template=opts.disk_template,
- mode=constants.INSTANCE_CREATE,
- os_type=opts.os, pnode=pnode,
- snode=snode, vcpus=opts.vcpus,
- ip=opts.ip, bridge=opts.bridge,
- start=opts.start, ip_check=opts.ip_check,
- wait_for_sync=opts.wait_for_sync,
- mac=opts.mac,
- kernel_path=kernel_path,
- initrd_path=initrd_path,
- iallocator=opts.iallocator,
- hvm_boot_order=opts.hvm_boot_order,
- file_storage_dir=opts.file_storage_dir,
- file_driver=opts.file_driver,
- hvm_acpi=hvm_acpi, hvm_pae=hvm_pae,
- hvm_cdrom_image_path=hvm_cdrom_image_path,
- vnc_bind_address=opts.vnc_bind_address)
-
- SubmitOpCode(op)
return 0
def ReinstallInstance(opts, args):
"""Reinstall an instance.
- Args:
- opts - class with options as members
- args - list containing a single element, the instance name
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the name of the
+ instance to be reinstalled
+ @rtype: int
+ @return: the desired exit code
"""
- instance_name = args[0]
+ # first, compute the desired name list
+ if opts.multi_mode is None:
+ opts.multi_mode = _SHUTDOWN_INSTANCES
- if not opts.force:
- usertext = ("This will reinstall the instance %s and remove"
- " all data. Continue?") % instance_name
- if not AskUser(usertext):
+ inames = _ExpandMultiNames(opts.multi_mode, args)
+ if not inames:
+ raise errors.OpPrereqError("Selection filter does not match any instances",
+ errors.ECODE_INVAL)
+
+ # second, if requested, ask for an OS
+ if opts.select_os is True:
+ op = opcodes.OpDiagnoseOS(output_fields=["name", "valid", "variants"],
+ names=[])
+ result = SubmitOpCode(op, opts=opts)
+
+ if not result:
+ ToStdout("Can't get the OS list")
+ return 1
+
+ ToStdout("Available OS templates:")
+ number = 0
+ choices = []
+ for (name, valid, variants) in result:
+ if valid:
+ for entry in CalculateOSNames(name, variants):
+ ToStdout("%3s: %s", number, entry)
+ choices.append(("%s" % number, entry, entry))
+ number += 1
+
+ choices.append(('x', 'exit', 'Exit gnt-instance reinstall'))
+ selected = AskUser("Enter OS template number (or x to abort):",
+ choices)
+
+ if selected == 'exit':
+ ToStderr("User aborted reinstall, exiting")
return 1
- op = opcodes.OpReinstallInstance(instance_name=instance_name,
- os_type=opts.os)
- SubmitOpCode(op)
+ os_name = selected
+ else:
+ os_name = opts.os
+ # third, get confirmation: multi-reinstall requires --force-multi
+ # *and* --force, single-reinstall just --force
+ multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
+ if multi_on:
+ warn_msg = "Note: this will remove *all* data for the below instances!\n"
+ if not ((opts.force_multi and opts.force) or
+ _ConfirmOperation(inames, "reinstall", extra=warn_msg)):
+ return 1
+ else:
+ if not opts.force:
+ usertext = ("This will reinstall the instance %s and remove"
+ " all data. Continue?") % inames[0]
+ if not AskUser(usertext):
+ return 1
+
+ jex = JobExecutor(verbose=multi_on, opts=opts)
+ for instance_name in inames:
+ op = opcodes.OpReinstallInstance(instance_name=instance_name,
+ os_type=os_name,
+ force_variant=opts.force_variant)
+ jex.QueueJob(instance_name, op)
+
+ jex.WaitOrShow(not opts.submit_only)
return 0
def RemoveInstance(opts, args):
"""Remove an instance.
- Args:
- opts - class with options as members
- args - list containing a single element, the instance name
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the name of
+ the instance to be removed
+ @rtype: int
+ @return: the desired exit code
"""
instance_name = args[0]
force = opts.force
+ cl = GetClient()
if not force:
+ _EnsureInstancesExist(cl, [instance_name])
+
usertext = ("This will remove the volumes of the instance %s"
" (including mirrors), thus removing all the data"
" of the instance. Continue?") % instance_name
return 1
op = opcodes.OpRemoveInstance(instance_name=instance_name,
- ignore_failures=opts.ignore_failures)
- SubmitOpCode(op)
+ ignore_failures=opts.ignore_failures,
+ shutdown_timeout=opts.shutdown_timeout)
+ SubmitOrSend(op, opts, cl=cl)
return 0
def RenameInstance(opts, args):
"""Rename an instance.
- Args:
- opts - class with options as members
- args - list containing two elements, the instance name and the new name
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain two elements, the old and the
+ new instance names
+ @rtype: int
+ @return: the desired exit code
"""
+ if not opts.name_check:
+ if not AskUser("As you disabled the check of the DNS entry, please verify"
+ " that '%s' is a FQDN. Continue?" % args[1]):
+ return 1
+
op = opcodes.OpRenameInstance(instance_name=args[0],
new_name=args[1],
- ignore_ip=opts.ignore_ip)
- SubmitOpCode(op)
+ ip_check=opts.ip_check,
+ name_check=opts.name_check)
+ result = SubmitOrSend(op, opts)
+
+ ToStdout("Instance '%s' renamed to '%s'", args[0], result)
return 0
"""Activate an instance's disks.
This serves two purposes:
- - it allows one (as long as the instance is not running) to mount
- the disks and modify them from the node
+ - it allows (as long as the instance is not running)
+ mounting the disks and modifying them from the node
- it repairs inactive secondary drbds
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the instance name
+ @rtype: int
+ @return: the desired exit code
+
"""
instance_name = args[0]
- op = opcodes.OpActivateInstanceDisks(instance_name=instance_name)
- disks_info = SubmitOpCode(op)
+ op = opcodes.OpActivateInstanceDisks(instance_name=instance_name,
+ ignore_size=opts.ignore_size)
+ disks_info = SubmitOrSend(op, opts)
for host, iname, nname in disks_info:
- print "%s:%s:%s" % (host, iname, nname)
+ ToStdout("%s:%s:%s", host, iname, nname)
return 0
def DeactivateDisks(opts, args):
- """Command-line interface for _ShutdownInstanceBlockDevices.
+ """Deactivate an instance's disks.
This function takes the instance name, looks for its primary node
and the tries to shutdown its block devices on that node.
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the instance name
+ @rtype: int
+ @return: the desired exit code
+
"""
instance_name = args[0]
op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
- SubmitOpCode(op)
+ SubmitOrSend(op, opts)
return 0
-def StartupInstance(opts, args):
- """Startup an instance.
+def RecreateDisks(opts, args):
+ """Recreate an instance's disks.
- Args:
- opts - class with options as members
- args - list containing a single element, the instance name
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the instance name
+ @rtype: int
+ @return: the desired exit code
"""
- if opts.multi_mode is None:
- opts.multi_mode = _SHUTDOWN_INSTANCES
- inames = _ExpandMultiNames(opts.multi_mode, args)
- if not inames:
- raise errors.OpPrereqError("Selection filter does not match any instances")
- multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
- if not (opts.force_multi or not multi_on
- or _ConfirmOperation(inames, "startup")):
- return 1
- for name in inames:
- op = opcodes.OpStartupInstance(instance_name=name,
- force=opts.force,
- extra_args=opts.extra_args)
- if multi_on:
- logger.ToStdout("Starting up %s" % name)
- SubmitOpCode(op)
+ instance_name = args[0]
+ if opts.disks:
+ try:
+ opts.disks = [int(v) for v in opts.disks.split(",")]
+ except (ValueError, TypeError), err:
+ ToStderr("Invalid disks value: %s" % str(err))
+ return 1
+ else:
+ opts.disks = []
+
+ op = opcodes.OpRecreateInstanceDisks(instance_name=instance_name,
+ disks=opts.disks)
+ SubmitOrSend(op, opts)
return 0
-def RebootInstance(opts, args):
- """Reboot an instance
+def GrowDisk(opts, args):
+ """Grow an instance's disks.
- Args:
- opts - class with options as members
- args - list containing a single element, the instance name
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain two elements, the instance name
+ whose disks we grow and the disk name, e.g. I{sda}
+ @rtype: int
+ @return: the desired exit code
"""
- if opts.multi_mode is None:
- opts.multi_mode = _SHUTDOWN_INSTANCES
- inames = _ExpandMultiNames(opts.multi_mode, args)
- if not inames:
- raise errors.OpPrereqError("Selection filter does not match any instances")
- multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
- if not (opts.force_multi or not multi_on
- or _ConfirmOperation(inames, "reboot")):
- return 1
- for name in inames:
- op = opcodes.OpRebootInstance(instance_name=name,
- reboot_type=opts.reboot_type,
- ignore_secondaries=opts.ignore_secondaries)
-
- SubmitOpCode(op)
+ instance = args[0]
+ disk = args[1]
+ try:
+ disk = int(disk)
+ except (TypeError, ValueError), err:
+ raise errors.OpPrereqError("Invalid disk index: %s" % str(err),
+ errors.ECODE_INVAL)
+ amount = utils.ParseUnit(args[2])
+ op = opcodes.OpGrowDisk(instance_name=instance, disk=disk, amount=amount,
+ wait_for_sync=opts.wait_for_sync)
+ SubmitOrSend(op, opts)
return 0
-def ShutdownInstance(opts, args):
+def _StartupInstance(name, opts):
+ """Startup instances.
+
+ This returns the opcode to start an instance, and its decorator will
+ wrap this into a loop starting all desired instances.
+
+ @param name: the name of the instance to act on
+ @param opts: the command line options selected by the user
+ @return: the opcode needed for the operation
+
+ """
+ op = opcodes.OpStartupInstance(instance_name=name,
+ force=opts.force)
+ # do not add these parameters to the opcode unless they're defined
+ if opts.hvparams:
+ op.hvparams = opts.hvparams
+ if opts.beparams:
+ op.beparams = opts.beparams
+ return op
+
+
+def _RebootInstance(name, opts):
+ """Reboot instance(s).
+
+ This returns the opcode to reboot an instance, and its decorator
+ will wrap this into a loop rebooting all desired instances.
+
+ @param name: the name of the instance to act on
+ @param opts: the command line options selected by the user
+ @return: the opcode needed for the operation
+
+ """
+ return opcodes.OpRebootInstance(instance_name=name,
+ reboot_type=opts.reboot_type,
+ ignore_secondaries=opts.ignore_secondaries,
+ shutdown_timeout=opts.shutdown_timeout)
+
+
+def _ShutdownInstance(name, opts):
"""Shutdown an instance.
- Args:
- opts - class with options as members
- args - list containing a single element, the instance name
+ This returns the opcode to shutdown an instance, and its decorator
+ will wrap this into a loop shutting down all desired instances.
+
+ @param name: the name of the instance to act on
+ @param opts: the command line options selected by the user
+ @return: the opcode needed for the operation
"""
- if opts.multi_mode is None:
- opts.multi_mode = _SHUTDOWN_INSTANCES
- inames = _ExpandMultiNames(opts.multi_mode, args)
- if not inames:
- raise errors.OpPrereqError("Selection filter does not match any instances")
- multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
- if not (opts.force_multi or not multi_on
- or _ConfirmOperation(inames, "shutdown")):
- return 1
- for name in inames:
- op = opcodes.OpShutdownInstance(instance_name=name)
- if multi_on:
- logger.ToStdout("Shutting down %s" % name)
- SubmitOpCode(op)
- return 0
+ return opcodes.OpShutdownInstance(instance_name=name,
+ timeout=opts.timeout)
def ReplaceDisks(opts, args):
"""Replace the disks of an instance
- Args:
- opts - class with options as members
- args - list with a single element, the instance name
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the instance name
+ @rtype: int
+ @return: the desired exit code
"""
- instance_name = args[0]
- new_2ndary = opts.new_secondary
+ new_2ndary = opts.dst_node
iallocator = opts.iallocator
if opts.disks is None:
- disks = ["sda", "sdb"]
+ disks = []
else:
- disks = opts.disks.split(",")
- if opts.on_primary == opts.on_secondary: # no -p or -s passed, or both passed
- mode = constants.REPLACE_DISK_ALL
- elif opts.on_primary: # only on primary:
+ try:
+ disks = [int(i) for i in opts.disks.split(",")]
+ except (TypeError, ValueError), err:
+ raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err),
+ errors.ECODE_INVAL)
+ cnt = [opts.on_primary, opts.on_secondary, opts.auto,
+ new_2ndary is not None, iallocator is not None].count(True)
+ if cnt != 1:
+ raise errors.OpPrereqError("One and only one of the -p, -s, -a, -n and -i"
+ " options must be passed", errors.ECODE_INVAL)
+ elif opts.on_primary:
mode = constants.REPLACE_DISK_PRI
- if new_2ndary is not None or iallocator is not None:
- raise errors.OpPrereqError("Can't change secondary node on primary disk"
- " replacement")
- elif opts.on_secondary is not None or iallocator is not None:
- # only on secondary
+ elif opts.on_secondary:
mode = constants.REPLACE_DISK_SEC
+ elif opts.auto:
+ mode = constants.REPLACE_DISK_AUTO
+ if disks:
+ raise errors.OpPrereqError("Cannot specify disks when using automatic"
+ " mode", errors.ECODE_INVAL)
+ elif new_2ndary is not None or iallocator is not None:
+ # replace secondary
+ mode = constants.REPLACE_DISK_CHG
op = opcodes.OpReplaceDisks(instance_name=args[0], disks=disks,
remote_node=new_2ndary, mode=mode,
- iallocator=iallocator)
- SubmitOpCode(op)
+ iallocator=iallocator,
+ early_release=opts.early_release)
+ SubmitOrSend(op, opts)
return 0
The failover is done by shutting it down on its present node and
starting it on the secondary.
- Args:
- opts - class with options as members
- args - list with a single element, the instance name
- Opts used:
- force - whether to failover without asking questions.
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the instance name
+ @rtype: int
+ @return: the desired exit code
"""
+ cl = GetClient()
instance_name = args[0]
force = opts.force
if not force:
+ _EnsureInstancesExist(cl, [instance_name])
+
usertext = ("Failover will happen to image %s."
" This requires a shutdown of the instance. Continue?" %
(instance_name,))
return 1
op = opcodes.OpFailoverInstance(instance_name=instance_name,
- ignore_consistency=opts.ignore_consistency)
- SubmitOpCode(op)
+ ignore_consistency=opts.ignore_consistency,
+ shutdown_timeout=opts.shutdown_timeout)
+ SubmitOrSend(op, opts, cl=cl)
+ return 0
+
+
+def MigrateInstance(opts, args):
+ """Migrate an instance.
+
+ The migrate is done without shutdown.
+
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the instance name
+ @rtype: int
+ @return: the desired exit code
+
+ """
+ cl = GetClient()
+ instance_name = args[0]
+ force = opts.force
+
+ if not force:
+ _EnsureInstancesExist(cl, [instance_name])
+
+ if opts.cleanup:
+ usertext = ("Instance %s will be recovered from a failed migration."
+ " Note that the migration procedure (including cleanup)" %
+ (instance_name,))
+ else:
+ usertext = ("Instance %s will be migrated. Note that migration" %
+ (instance_name,))
+ usertext += (" might impact the instance if anything goes wrong"
+ " (e.g. due to bugs in the hypervisor). Continue?")
+ if not AskUser(usertext):
+ return 1
+
+ # this should be removed once --non-live is deprecated
+ if not opts.live and opts.migration_mode is not None:
+ raise errors.OpPrereqError("Only one of the --non-live and "
+ "--migration-mode options can be passed",
+ errors.ECODE_INVAL)
+ if not opts.live: # --non-live passed
+ mode = constants.HT_MIGRATION_NONLIVE
+ else:
+ mode = opts.migration_mode
+
+ op = opcodes.OpMigrateInstance(instance_name=instance_name, mode=mode,
+ cleanup=opts.cleanup)
+ SubmitOpCode(op, cl=cl, opts=opts)
+ return 0
+
+
+def MoveInstance(opts, args):
+ """Move an instance.
+
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the instance name
+ @rtype: int
+ @return: the desired exit code
+
+ """
+ cl = GetClient()
+ instance_name = args[0]
+ force = opts.force
+
+ if not force:
+ usertext = ("Instance %s will be moved."
+ " This requires a shutdown of the instance. Continue?" %
+ (instance_name,))
+ if not AskUser(usertext):
+ return 1
+
+ op = opcodes.OpMoveInstance(instance_name=instance_name,
+ target_node=opts.node,
+ shutdown_timeout=opts.shutdown_timeout)
+ SubmitOrSend(op, opts, cl=cl)
return 0
def ConnectToInstanceConsole(opts, args):
"""Connect to the console of an instance.
- Args:
- opts - class with options as members
- args - list with a single element, the instance name
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the instance name
+ @rtype: int
+ @return: the desired exit code
"""
instance_name = args[0]
op = opcodes.OpConnectConsole(instance_name=instance_name)
- cmd = SubmitOpCode(op)
+ cmd = SubmitOpCode(op, opts=opts)
if opts.show_command:
- print utils.ShellQuoteArgs(cmd)
+ ToStdout("%s", utils.ShellQuoteArgs(cmd))
else:
- # drop lock and exec so other commands can run while we have console
- utils.Unlock("cmd")
try:
os.execvp(cmd[0], cmd)
finally:
- sys.stderr.write("Can't run console command %s with arguments:\n'%s'" %
- (cmd, " ".join(argv)))
- os._exit(1)
+ ToStderr("Can't run console command %s with arguments:\n'%s'",
+ cmd[0], " ".join(cmd))
+ os._exit(1) # pylint: disable-msg=W0212
+
+
+def _FormatLogicalID(dev_type, logical_id, roman):
+ """Formats the logical_id of a disk.
+ """
+ if dev_type == constants.LD_DRBD8:
+ node_a, node_b, port, minor_a, minor_b, key = logical_id
+ data = [
+ ("nodeA", "%s, minor=%s" % (node_a, compat.TryToRoman(minor_a,
+ convert=roman))),
+ ("nodeB", "%s, minor=%s" % (node_b, compat.TryToRoman(minor_b,
+ convert=roman))),
+ ("port", compat.TryToRoman(port, convert=roman)),
+ ("auth key", key),
+ ]
+ elif dev_type == constants.LD_LV:
+ vg_name, lv_name = logical_id
+ data = ["%s/%s" % (vg_name, lv_name)]
+ else:
+ data = [str(logical_id)]
+
+ return data
-def _FormatBlockDevInfo(buf, dev, indent_level):
+
+def _FormatBlockDevInfo(idx, top_level, dev, static, roman):
"""Show block device information.
- This is only used by ShowInstanceConfig(), but it's too big to be
+ This is only used by L{ShowInstanceConfig}, but it's too big to be
left for an inline definition.
+ @type idx: int
+ @param idx: the index of the current disk
+ @type top_level: boolean
+ @param top_level: if this a top-level disk?
+ @type dev: dict
+ @param dev: dictionary with disk information
+ @type static: boolean
+ @param static: wheter the device information doesn't contain
+ runtime information but only static data
+ @type roman: boolean
+ @param roman: whether to try to use roman integers
+ @return: a list of either strings, tuples or lists
+ (which should be formatted at a higher indent level)
+
"""
- def helper(buf, dtype, status):
- """Format one line for physical device status."""
+ def helper(dtype, status):
+ """Format one line for physical device status.
+
+ @type dtype: str
+ @param dtype: a constant from the L{constants.LDS_BLOCK} set
+ @type status: tuple
+ @param status: a tuple as returned from L{backend.FindBlockDevice}
+ @return: the string representing the status
+
+ """
if not status:
- buf.write("not active\n")
+ return "not active"
+ txt = ""
+ (path, major, minor, syncp, estt, degr, ldisk_status) = status
+ if major is None:
+ major_string = "N/A"
else:
- (path, major, minor, syncp, estt, degr, ldisk) = status
- if major is None:
- major_string = "N/A"
- else:
- major_string = str(major)
+ major_string = str(compat.TryToRoman(major, convert=roman))
- if minor is None:
- minor_string = "N/A"
- else:
- minor_string = str(minor)
-
- buf.write("%s (%s:%s)" % (path, major_string, minor_string))
- if dtype in (constants.LD_MD_R1, constants.LD_DRBD7, constants.LD_DRBD8):
- if syncp is not None:
- sync_text = "*RECOVERING* %5.2f%%," % syncp
- if estt:
- sync_text += " ETA %ds" % estt
- else:
- sync_text += " ETA unknown"
- else:
- sync_text = "in sync"
- if degr:
- degr_text = "*DEGRADED*"
- else:
- degr_text = "ok"
- if ldisk:
- ldisk_text = " *MISSING DISK*"
- else:
- ldisk_text = ""
- buf.write(" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
- elif dtype == constants.LD_LV:
- if ldisk:
- ldisk_text = " *FAILED* (failed drive?)"
+ if minor is None:
+ minor_string = "N/A"
+ else:
+ minor_string = str(compat.TryToRoman(minor, convert=roman))
+
+ txt += ("%s (%s:%s)" % (path, major_string, minor_string))
+ if dtype in (constants.LD_DRBD8, ):
+ if syncp is not None:
+ sync_text = "*RECOVERING* %5.2f%%," % syncp
+ if estt:
+ sync_text += " ETA %ss" % compat.TryToRoman(estt, convert=roman)
else:
- ldisk_text = ""
- buf.write(ldisk_text)
- buf.write("\n")
-
- if dev["iv_name"] is not None:
- data = " - %s, " % dev["iv_name"]
+ sync_text += " ETA unknown"
+ else:
+ sync_text = "in sync"
+ if degr:
+ degr_text = "*DEGRADED*"
+ else:
+ degr_text = "ok"
+ if ldisk_status == constants.LDS_FAULTY:
+ ldisk_text = " *MISSING DISK*"
+ elif ldisk_status == constants.LDS_UNKNOWN:
+ ldisk_text = " *UNCERTAIN STATE*"
+ else:
+ ldisk_text = ""
+ txt += (" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
+ elif dtype == constants.LD_LV:
+ if ldisk_status == constants.LDS_FAULTY:
+ ldisk_text = " *FAILED* (failed drive?)"
+ else:
+ ldisk_text = ""
+ txt += ldisk_text
+ return txt
+
+ # the header
+ if top_level:
+ if dev["iv_name"] is not None:
+ txt = dev["iv_name"]
+ else:
+ txt = "disk %s" % compat.TryToRoman(idx, convert=roman)
else:
- data = " - "
- data += "type: %s" % dev["dev_type"]
+ txt = "child %s" % compat.TryToRoman(idx, convert=roman)
+ if isinstance(dev["size"], int):
+ nice_size = utils.FormatUnit(dev["size"], "h")
+ else:
+ nice_size = dev["size"]
+ d1 = ["- %s: %s, size %s" % (txt, dev["dev_type"], nice_size)]
+ data = []
+ if top_level:
+ data.append(("access mode", dev["mode"]))
if dev["logical_id"] is not None:
- data += ", logical_id: %s" % (dev["logical_id"],)
+ try:
+ l_id = _FormatLogicalID(dev["dev_type"], dev["logical_id"], roman)
+ except ValueError:
+ l_id = [str(dev["logical_id"])]
+ if len(l_id) == 1:
+ data.append(("logical_id", l_id[0]))
+ else:
+ data.extend(l_id)
elif dev["physical_id"] is not None:
- data += ", physical_id: %s" % (dev["physical_id"],)
- buf.write("%*s%s\n" % (2*indent_level, "", data))
- buf.write("%*s primary: " % (2*indent_level, ""))
- helper(buf, dev["dev_type"], dev["pstatus"])
-
- if dev["sstatus"]:
- buf.write("%*s secondary: " % (2*indent_level, ""))
- helper(buf, dev["dev_type"], dev["sstatus"])
+ data.append("physical_id:")
+ data.append([dev["physical_id"]])
+ if not static:
+ data.append(("on primary", helper(dev["dev_type"], dev["pstatus"])))
+ if dev["sstatus"] and not static:
+ data.append(("on secondary", helper(dev["dev_type"], dev["sstatus"])))
if dev["children"]:
- for child in dev["children"]:
- _FormatBlockDevInfo(buf, child, indent_level+1)
+ data.append("child devices:")
+ for c_idx, child in enumerate(dev["children"]):
+ data.append(_FormatBlockDevInfo(c_idx, False, child, static, roman))
+ d1.append(data)
+ return d1
+
+
+def _FormatList(buf, data, indent_level):
+ """Formats a list of data at a given indent level.
+ If the element of the list is:
+ - a string, it is simply formatted as is
+ - a tuple, it will be split into key, value and the all the
+ values in a list will be aligned all at the same start column
+ - a list, will be recursively formatted
+
+ @type buf: StringIO
+ @param buf: the buffer into which we write the output
+ @param data: the list to format
+ @type indent_level: int
+ @param indent_level: the indent level to format at
+
+ """
+ max_tlen = max([len(elem[0]) for elem in data
+ if isinstance(elem, tuple)] or [0])
+ for elem in data:
+ if isinstance(elem, basestring):
+ buf.write("%*s%s\n" % (2*indent_level, "", elem))
+ elif isinstance(elem, tuple):
+ key, value = elem
+ spacer = "%*s" % (max_tlen - len(key), "")
+ buf.write("%*s%s:%s %s\n" % (2*indent_level, "", key, spacer, value))
+ elif isinstance(elem, list):
+ _FormatList(buf, elem, indent_level+1)
+
+
+def _FormatParameterDict(buf, per_inst, actual):
+ """Formats a parameter dictionary.
+
+ @type buf: L{StringIO}
+ @param buf: the buffer into which to write
+ @type per_inst: dict
+ @param per_inst: the instance's own parameters
+ @type actual: dict
+ @param actual: the current parameter set (including defaults)
+
+ """
+ for key in sorted(actual):
+ val = per_inst.get(key, "default (%s)" % actual[key])
+ buf.write(" - %s: %s\n" % (key, val))
def ShowInstanceConfig(opts, args):
"""Compute instance run-time status.
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: either an empty list, and then we query all
+ instances, or should contain a list of instance names
+ @rtype: int
+ @return: the desired exit code
+
"""
- retcode = 0
- op = opcodes.OpQueryInstanceData(instances=args)
- result = SubmitOpCode(op)
+ if not args and not opts.show_all:
+ ToStderr("No instance selected."
+ " Please pass in --all if you want to query all instances.\n"
+ "Note that this can take a long time on a big cluster.")
+ return 1
+ elif args and opts.show_all:
+ ToStderr("Cannot use --all if you specify instance names.")
+ return 1
+ retcode = 0
+ op = opcodes.OpQueryInstanceData(instances=args, static=opts.static)
+ result = SubmitOpCode(op, opts=opts)
if not result:
- logger.ToStdout("No instances.")
+ ToStdout("No instances.")
return 1
buf = StringIO()
for instance_name in result:
instance = result[instance_name]
buf.write("Instance name: %s\n" % instance["name"])
- buf.write("State: configured to be %s, actual state is %s\n" %
- (instance["config_state"], instance["run_state"]))
+ buf.write("UUID: %s\n" % instance["uuid"])
+ buf.write("Serial number: %s\n" %
+ compat.TryToRoman(instance["serial_no"],
+ convert=opts.roman_integers))
+ buf.write("Creation time: %s\n" % utils.FormatTime(instance["ctime"]))
+ buf.write("Modification time: %s\n" % utils.FormatTime(instance["mtime"]))
+ buf.write("State: configured to be %s" % instance["config_state"])
+ if not opts.static:
+ buf.write(", actual state is %s" % instance["run_state"])
+ buf.write("\n")
+ ##buf.write("Considered for memory checks in cluster verify: %s\n" %
+ ## instance["auto_balance"])
buf.write(" Nodes:\n")
buf.write(" - primary: %s\n" % instance["pnode"])
- buf.write(" - secondaries: %s\n" % ", ".join(instance["snodes"]))
+ buf.write(" - secondaries: %s\n" % utils.CommaJoin(instance["snodes"]))
buf.write(" Operating system: %s\n" % instance["os"])
- buf.write(" Allocated network port: %s\n" % instance["network_port"])
- if instance["kernel_path"] in (None, constants.VALUE_DEFAULT):
- kpath = "(default: %s)" % constants.XEN_KERNEL
- else:
- kpath = instance["kernel_path"]
- buf.write(" Kernel path: %s\n" % kpath)
- if instance["initrd_path"] in (None, constants.VALUE_DEFAULT):
- initrd = "(default: %s)" % constants.XEN_INITRD
- elif instance["initrd_path"] == constants.VALUE_NONE:
- initrd = "(none)"
- else:
- initrd = instance["initrd_path"]
- buf.write(" initrd: %s\n" % initrd)
- buf.write(" HVM:\n")
- buf.write(" - boot order: %s\n" % instance["hvm_boot_order"])
- buf.write(" - ACPI support: %s\n" % instance["hvm_acpi"])
- buf.write(" - PAE support: %s\n" % instance["hvm_pae"])
- buf.write(" - virtual CDROM: %s\n" % instance["hvm_cdrom_image_path"])
- buf.write(" VNC bind address: %s\n" % instance["vnc_bind_address"])
+ _FormatParameterDict(buf, instance["os_instance"], instance["os_actual"])
+ if instance.has_key("network_port"):
+ buf.write(" Allocated network port: %s\n" %
+ compat.TryToRoman(instance["network_port"],
+ convert=opts.roman_integers))
+ buf.write(" Hypervisor: %s\n" % instance["hypervisor"])
+
+ # custom VNC console information
+ vnc_bind_address = instance["hv_actual"].get(constants.HV_VNC_BIND_ADDRESS,
+ None)
+ if vnc_bind_address:
+ port = instance["network_port"]
+ display = int(port) - constants.VNC_BASE_PORT
+ if display > 0 and vnc_bind_address == constants.IP4_ADDRESS_ANY:
+ vnc_console_port = "%s:%s (display %s)" % (instance["pnode"],
+ port,
+ display)
+ elif display > 0 and netutils.IsValidIP4(vnc_bind_address):
+ vnc_console_port = ("%s:%s (node %s) (display %s)" %
+ (vnc_bind_address, port,
+ instance["pnode"], display))
+ else:
+ # vnc bind address is a file
+ vnc_console_port = "%s:%s" % (instance["pnode"],
+ vnc_bind_address)
+ buf.write(" - console connection: vnc to %s\n" % vnc_console_port)
+
+ _FormatParameterDict(buf, instance["hv_instance"], instance["hv_actual"])
buf.write(" Hardware:\n")
- buf.write(" - VCPUs: %d\n" % instance["vcpus"])
- buf.write(" - memory: %dMiB\n" % instance["memory"])
- buf.write(" - NICs: %s\n" %
- ", ".join(["{MAC: %s, IP: %s, bridge: %s}" %
- (mac, ip, bridge)
- for mac, ip, bridge in instance["nics"]]))
- buf.write(" Block devices:\n")
-
- for device in instance["disks"]:
- _FormatBlockDevInfo(buf, device, 1)
-
- logger.ToStdout(buf.getvalue().rstrip('\n'))
+ buf.write(" - VCPUs: %s\n" %
+ compat.TryToRoman(instance["be_actual"][constants.BE_VCPUS],
+ convert=opts.roman_integers))
+ buf.write(" - memory: %sMiB\n" %
+ compat.TryToRoman(instance["be_actual"][constants.BE_MEMORY],
+ convert=opts.roman_integers))
+ buf.write(" - NICs:\n")
+ for idx, (ip, mac, mode, link) in enumerate(instance["nics"]):
+ buf.write(" - nic/%d: MAC: %s, IP: %s, mode: %s, link: %s\n" %
+ (idx, mac, ip, mode, link))
+ buf.write(" Disks:\n")
+
+ for idx, device in enumerate(instance["disks"]):
+ _FormatList(buf, _FormatBlockDevInfo(idx, True, device, opts.static,
+ opts.roman_integers), 2)
+
+ ToStdout(buf.getvalue().rstrip('\n'))
return retcode
All parameters take effect only at the next restart of the instance.
- Args:
- opts - class with options as members
- args - list with a single element, the instance name
- Opts used:
- memory - the new memory size
- vcpus - the new number of cpus
- mac - the new MAC address of the instance
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the instance name
+ @rtype: int
+ @return: the desired exit code
"""
- if not (opts.mem or opts.vcpus or opts.ip or opts.bridge or opts.mac or
- opts.kernel_path or opts.initrd_path or opts.hvm_boot_order or
- opts.hvm_acpi or opts.hvm_acpi or opts.hvm_cdrom_image_path or
- opts.vnc_bind_address):
- logger.ToStdout("Please give at least one of the parameters.")
+ if not (opts.nics or opts.disks or opts.disk_template or
+ opts.hvparams or opts.beparams or opts.os or opts.osparams):
+ ToStderr("Please give at least one of the parameters.")
return 1
- kernel_path = _TransformPath(opts.kernel_path)
- initrd_path = _TransformPath(opts.initrd_path)
- if opts.hvm_boot_order == 'default':
- hvm_boot_order = constants.VALUE_DEFAULT
- else:
- hvm_boot_order = opts.hvm_boot_order
+ for param in opts.beparams:
+ if isinstance(opts.beparams[param], basestring):
+ if opts.beparams[param].lower() == "default":
+ opts.beparams[param] = constants.VALUE_DEFAULT
- hvm_acpi = opts.hvm_acpi == _VALUE_TRUE
- hvm_pae = opts.hvm_pae == _VALUE_TRUE
+ utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES,
+ allowed_values=[constants.VALUE_DEFAULT])
- if ((opts.hvm_cdrom_image_path is not None) and
- (opts.hvm_cdrom_image_path.lower() == constants.VALUE_NONE)):
- hvm_cdrom_image_path = None
- else:
- hvm_cdrom_image_path = opts.hvm_cdrom_image_path
+ for param in opts.hvparams:
+ if isinstance(opts.hvparams[param], basestring):
+ if opts.hvparams[param].lower() == "default":
+ opts.hvparams[param] = constants.VALUE_DEFAULT
+
+ utils.ForceDictType(opts.hvparams, constants.HVS_PARAMETER_TYPES,
+ allowed_values=[constants.VALUE_DEFAULT])
+
+ for idx, (nic_op, nic_dict) in enumerate(opts.nics):
+ try:
+ nic_op = int(nic_op)
+ opts.nics[idx] = (nic_op, nic_dict)
+ except (TypeError, ValueError):
+ pass
- op = opcodes.OpSetInstanceParams(instance_name=args[0], mem=opts.mem,
- vcpus=opts.vcpus, ip=opts.ip,
- bridge=opts.bridge, mac=opts.mac,
- kernel_path=opts.kernel_path,
- initrd_path=opts.initrd_path,
- hvm_boot_order=hvm_boot_order,
- hvm_acpi=hvm_acpi, hvm_pae=hvm_pae,
- hvm_cdrom_image_path=hvm_cdrom_image_path,
- vnc_bind_address=opts.vnc_bind_address)
+ for idx, (disk_op, disk_dict) in enumerate(opts.disks):
+ try:
+ disk_op = int(disk_op)
+ opts.disks[idx] = (disk_op, disk_dict)
+ except (TypeError, ValueError):
+ pass
+ if disk_op == constants.DDM_ADD:
+ if 'size' not in disk_dict:
+ raise errors.OpPrereqError("Missing required parameter 'size'",
+ errors.ECODE_INVAL)
+ disk_dict['size'] = utils.ParseUnit(disk_dict['size'])
+
+ if (opts.disk_template and
+ opts.disk_template in constants.DTS_NET_MIRROR and
+ not opts.node):
+ ToStderr("Changing the disk template to a mirrored one requires"
+ " specifying a secondary node")
+ return 1
- result = SubmitOpCode(op)
+ op = opcodes.OpSetInstanceParams(instance_name=args[0],
+ nics=opts.nics,
+ disks=opts.disks,
+ disk_template=opts.disk_template,
+ remote_node=opts.node,
+ hvparams=opts.hvparams,
+ beparams=opts.beparams,
+ os_name=opts.os,
+ osparams=opts.osparams,
+ force_variant=opts.force_variant,
+ force=opts.force)
+
+ # even if here we process the result, we allow submit only
+ result = SubmitOrSend(op, opts)
if result:
- logger.ToStdout("Modified instance %s" % args[0])
+ ToStdout("Modified instance %s", args[0])
for param, data in result:
- logger.ToStdout(" - %-5s -> %s" % (param, data))
- logger.ToStdout("Please don't forget that these parameters take effect"
- " only at the next start of the instance.")
+ ToStdout(" - %-5s -> %s", param, data)
+ ToStdout("Please don't forget that most parameters take effect"
+ " only at the next start of the instance.")
return 0
-# options used in more than one cmd
-node_opt = make_option("-n", "--node", dest="node", help="Target node",
- metavar="<node>")
-
-os_opt = cli_option("-o", "--os-type", dest="os", help="What OS to run",
- metavar="<os>")
-
# multi-instance selection options
-m_force_multi = make_option("--force-multiple", dest="force_multi",
- help="Do not ask for confirmation when more than"
- " one instance is affected",
- action="store_true", default=False)
-
-m_pri_node_opt = make_option("--primary", dest="multi_mode",
- help="Filter by nodes (primary only)",
- const=_SHUTDOWN_NODES_PRI, action="store_const")
-
-m_sec_node_opt = make_option("--secondary", dest="multi_mode",
- help="Filter by nodes (secondary only)",
- const=_SHUTDOWN_NODES_SEC, action="store_const")
-
-m_node_opt = make_option("--node", dest="multi_mode",
- help="Filter by nodes (primary and secondary)",
- const=_SHUTDOWN_NODES_BOTH, action="store_const")
-
-m_clust_opt = make_option("--all", dest="multi_mode",
- help="Select all instances in the cluster",
- const=_SHUTDOWN_CLUSTER, action="store_const")
-
-m_inst_opt = make_option("--instance", dest="multi_mode",
- help="Filter by instance name [default]",
- const=_SHUTDOWN_INSTANCES, action="store_const")
-
+m_force_multi = cli_option("--force-multiple", dest="force_multi",
+ help="Do not ask for confirmation when more than"
+ " one instance is affected",
+ action="store_true", default=False)
+
+m_pri_node_opt = cli_option("--primary", dest="multi_mode",
+ help="Filter by nodes (primary only)",
+ const=_SHUTDOWN_NODES_PRI, action="store_const")
+
+m_sec_node_opt = cli_option("--secondary", dest="multi_mode",
+ help="Filter by nodes (secondary only)",
+ const=_SHUTDOWN_NODES_SEC, action="store_const")
+
+m_node_opt = cli_option("--node", dest="multi_mode",
+ help="Filter by nodes (primary and secondary)",
+ const=_SHUTDOWN_NODES_BOTH, action="store_const")
+
+m_clust_opt = cli_option("--all", dest="multi_mode",
+ help="Select all instances in the cluster",
+ const=_SHUTDOWN_CLUSTER, action="store_const")
+
+m_inst_opt = cli_option("--instance", dest="multi_mode",
+ help="Filter by instance name [default]",
+ const=_SHUTDOWN_INSTANCES, action="store_const")
+
+m_node_tags_opt = cli_option("--node-tags", dest="multi_mode",
+ help="Filter by node tag",
+ const=_SHUTDOWN_NODES_BOTH_BY_TAGS,
+ action="store_const")
+
+m_pri_node_tags_opt = cli_option("--pri-node-tags", dest="multi_mode",
+ help="Filter by primary node tag",
+ const=_SHUTDOWN_NODES_PRI_BY_TAGS,
+ action="store_const")
+
+m_sec_node_tags_opt = cli_option("--sec-node-tags", dest="multi_mode",
+ help="Filter by secondary node tag",
+ const=_SHUTDOWN_NODES_SEC_BY_TAGS,
+ action="store_const")
+
+m_inst_tags_opt = cli_option("--tags", dest="multi_mode",
+ help="Filter by instance tag",
+ const=_SHUTDOWN_INSTANCES_BY_TAGS,
+ action="store_const")
# this is defined separately due to readability only
add_opts = [
- DEBUG_OPT,
- make_option("-n", "--node", dest="node",
- help="Target node and optional secondary node",
- metavar="<pnode>[:<snode>]"),
- cli_option("-s", "--os-size", dest="size", help="Disk size, in MiB unless"
- " a suffix is used",
- default=20 * 1024, type="unit", metavar="<size>"),
- cli_option("--swap-size", dest="swap", help="Swap size, in MiB unless a"
- " suffix is used",
- default=4 * 1024, type="unit", metavar="<size>"),
- os_opt,
- cli_option("-m", "--memory", dest="mem", help="Memory size (in MiB)",
- default=128, type="unit", metavar="<mem>"),
- make_option("-p", "--cpu", dest="vcpus", help="Number of virtual CPUs",
- default=1, type="int", metavar="<PROC>"),
- make_option("-t", "--disk-template", dest="disk_template",
- help="Custom disk setup (diskless, file, plain or drbd)",
- default=None, metavar="TEMPL"),
- make_option("-i", "--ip", dest="ip",
- help="IP address ('none' [default], 'auto', or specify address)",
- default='none', type="string", metavar="<ADDRESS>"),
- make_option("--mac", dest="mac",
- help="MAC address ('auto' [default], or specify address)",
- default='auto', type="string", metavar="<MACADDRESS>"),
- make_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
- action="store_false", help="Don't wait for sync (DANGEROUS!)"),
- make_option("-b", "--bridge", dest="bridge",
- help="Bridge to connect this instance to",
- default=None, metavar="<bridge>"),
- make_option("--no-start", dest="start", default=True,
- action="store_false", help="Don't start the instance after"
- " creation"),
- make_option("--no-ip-check", dest="ip_check", default=True,
- action="store_false", help="Don't check that the instance's IP"
- " is alive (only valid with --no-start)"),
- make_option("--kernel", dest="kernel_path",
- help="Path to the instances' kernel (or 'default')",
- default=None,
- type="string", metavar="<FILENAME>"),
- make_option("--initrd", dest="initrd_path",
- help="Path to the instances' initrd (or 'none', or 'default')",
- default=None,
- type="string", metavar="<FILENAME>"),
- make_option("--hvm-boot-order", dest="hvm_boot_order",
- help="Boot device order for HVM (one or more of [acdn])",
- default=None, type="string", metavar="<BOOTORDER>"),
- make_option("--file-storage-dir", dest="file_storage_dir",
- help="Relative path under default cluster-wide file storage dir"
- " to store file-based disks", default=None,
- metavar="<DIR>"),
- make_option("--file-driver", dest="file_driver", help="Driver to use"
- " for image files", default="loop", metavar="<DRIVER>"),
- make_option("--iallocator", metavar="<NAME>",
- help="Select nodes for the instance automatically using the"
- " <NAME> iallocator plugin", default=None, type="string"),
- make_option("--hvm-acpi", dest="hvm_acpi",
- help="ACPI support for HVM (true|false)",
- metavar="<BOOL>", choices=["true", "false"]),
- make_option("--hvm-pae", dest="hvm_pae",
- help="PAE support for HVM (true|false)",
- metavar="<BOOL>", choices=["true", "false"]),
- make_option("--hvm-cdrom-image-path", dest="hvm_cdrom_image_path",
- help="CDROM image path for HVM (absolute path or None)",
- default=None, type="string", metavar="<CDROMIMAGE>"),
- make_option("--vnc-bind-address", dest="vnc_bind_address",
- help="bind address for VNC (IP address)",
- default=None, type="string", metavar="<VNCADDRESS>"),
+ BACKEND_OPT,
+ DISK_OPT,
+ DISK_TEMPLATE_OPT,
+ FILESTORE_DIR_OPT,
+ FILESTORE_DRIVER_OPT,
+ HYPERVISOR_OPT,
+ IALLOCATOR_OPT,
+ NET_OPT,
+ NODE_PLACEMENT_OPT,
+ NOIPCHECK_OPT,
+ NONAMECHECK_OPT,
+ NONICS_OPT,
+ NOSTART_OPT,
+ NWSYNC_OPT,
+ OSPARAMS_OPT,
+ OS_OPT,
+ FORCE_VARIANT_OPT,
+ NO_INSTALL_OPT,
+ OS_SIZE_OPT,
+ SUBMIT_OPT,
]
commands = {
- 'add': (AddInstance, ARGS_ONE, add_opts,
- "[...] -t disk-type -n node[:secondary-node] -o os-type <name>",
- "Creates and adds a new instance to the cluster"),
- 'console': (ConnectToInstanceConsole, ARGS_ONE,
- [DEBUG_OPT,
- make_option("--show-cmd", dest="show_command",
- action="store_true", default=False,
- help=("Show command instead of executing it"))],
- "[--show-cmd] <instance>",
- "Opens a console on the specified instance"),
- 'failover': (FailoverInstance, ARGS_ONE,
- [DEBUG_OPT, FORCE_OPT,
- make_option("--ignore-consistency", dest="ignore_consistency",
- action="store_true", default=False,
- help="Ignore the consistency of the disks on"
- " the secondary"),
- ],
- "[-f] <instance>",
- "Stops the instance and starts it on the backup node, using"
- " the remote mirror (only for instances of type drbd)"),
- 'info': (ShowInstanceConfig, ARGS_ANY, [DEBUG_OPT], "[<instance>...]",
- "Show information on the specified instance"),
- 'list': (ListInstances, ARGS_NONE,
- [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT], "",
- "Lists the instances and their status. The available fields are"
- " (see the man page for details): status, oper_state, oper_ram,"
- " name, os, pnode, snodes, admin_state, admin_ram, disk_template,"
- " ip, mac, bridge, sda_size, sdb_size, vcpus. The default field"
- " list is (in order): %s." % ", ".join(_LIST_DEF_FIELDS),
- ),
- 'reinstall': (ReinstallInstance, ARGS_ONE, [DEBUG_OPT, FORCE_OPT, os_opt],
- "[-f] <instance>", "Reinstall a stopped instance"),
- 'remove': (RemoveInstance, ARGS_ONE,
- [DEBUG_OPT, FORCE_OPT,
- make_option("--ignore-failures", dest="ignore_failures",
- action="store_true", default=False,
- help=("Remove the instance from the cluster even"
- " if there are failures during the removal"
- " process (shutdown, disk removal, etc.)")),
- ],
- "[-f] <instance>", "Shuts down the instance and removes it"),
- 'rename': (RenameInstance, ARGS_FIXED(2),
- [DEBUG_OPT,
- make_option("--no-ip-check", dest="ignore_ip",
- help="Do not check that the IP of the new name"
- " is alive",
- default=False, action="store_true"),
- ],
- "<instance> <new_name>", "Rename the instance"),
- 'replace-disks': (ReplaceDisks, ARGS_ONE,
- [DEBUG_OPT,
- make_option("-n", "--new-secondary", dest="new_secondary",
- help=("New secondary node (for secondary"
- " node change)"), metavar="NODE"),
- make_option("-p", "--on-primary", dest="on_primary",
- default=False, action="store_true",
- help=("Replace the disk(s) on the primary"
- " node (only for the drbd template)")),
- make_option("-s", "--on-secondary", dest="on_secondary",
- default=False, action="store_true",
- help=("Replace the disk(s) on the secondary"
- " node (only for the drbd template)")),
- make_option("--disks", dest="disks", default=None,
- help=("Comma-separated list of disks"
- " to replace (e.g. sda) (optional,"
- " defaults to all disks")),
- make_option("--iallocator", metavar="<NAME>",
- help="Select new secondary for the instance"
- " automatically using the"
- " <NAME> iallocator plugin (enables"
- " secondary node replacement)",
- default=None, type="string"),
- ],
- "[-s|-p|-n NODE] <instance>",
- "Replaces all disks for the instance"),
- 'modify': (SetInstanceParams, ARGS_ONE,
- [DEBUG_OPT, FORCE_OPT,
- cli_option("-m", "--memory", dest="mem",
- help="Memory size",
- default=None, type="unit", metavar="<mem>"),
- make_option("-p", "--cpu", dest="vcpus",
- help="Number of virtual CPUs",
- default=None, type="int", metavar="<PROC>"),
- make_option("-i", "--ip", dest="ip",
- help="IP address ('none' or numeric IP)",
- default=None, type="string", metavar="<ADDRESS>"),
- make_option("-b", "--bridge", dest="bridge",
- help="Bridge to connect this instance to",
- default=None, type="string", metavar="<bridge>"),
- make_option("--mac", dest="mac",
- help="MAC address", default=None,
- type="string", metavar="<MACADDRESS>"),
- make_option("--kernel", dest="kernel_path",
- help="Path to the instances' kernel (or"
- " 'default')", default=None,
- type="string", metavar="<FILENAME>"),
- make_option("--initrd", dest="initrd_path",
- help="Path to the instances' initrd (or 'none', or"
- " 'default')", default=None,
- type="string", metavar="<FILENAME>"),
- make_option("--hvm-boot-order", dest="hvm_boot_order",
- help="boot device order for HVM"
- "(either one or more of [acdn] or 'default')",
- default=None, type="string", metavar="<BOOTORDER>"),
- make_option("--hvm-acpi", dest="hvm_acpi",
- help="ACPI support for HVM (true|false)",
- metavar="<BOOL>", choices=["true", "false"]),
- make_option("--hvm-pae", dest="hvm_pae",
- help="PAE support for HVM (true|false)",
- metavar="<BOOL>", choices=["true", "false"]),
- make_option("--hvm-cdrom-image-path",
- dest="hvm_cdrom_image_path",
- help="CDROM image path for HVM"
- "(absolute path or None)",
- default=None, type="string", metavar="<CDROMIMAGE>"),
- make_option("--vnc-bind-address", dest="vnc_bind_address",
- help="bind address for VNC (IP address)",
- default=None, type="string", metavar="<VNCADDRESS>"),
- ],
- "<instance>", "Alters the parameters of an instance"),
- 'shutdown': (ShutdownInstance, ARGS_ANY,
- [DEBUG_OPT, m_node_opt, m_pri_node_opt, m_sec_node_opt,
- m_clust_opt, m_inst_opt, m_force_multi],
- "<instance>", "Stops an instance"),
- 'startup': (StartupInstance, ARGS_ANY,
- [DEBUG_OPT, FORCE_OPT, m_force_multi,
- make_option("-e", "--extra", dest="extra_args",
- help="Extra arguments for the instance's kernel",
- default=None, type="string", metavar="<PARAMS>"),
- m_node_opt, m_pri_node_opt, m_sec_node_opt,
- m_clust_opt, m_inst_opt,
- ],
- "<instance>", "Starts an instance"),
-
- 'reboot': (RebootInstance, ARGS_ANY,
- [DEBUG_OPT, m_force_multi,
- make_option("-e", "--extra", dest="extra_args",
- help="Extra arguments for the instance's kernel",
- default=None, type="string", metavar="<PARAMS>"),
- make_option("-t", "--type", dest="reboot_type",
- help="Type of reboot: soft/hard/full",
- default=constants.INSTANCE_REBOOT_SOFT,
- type="string", metavar="<REBOOT>"),
- make_option("--ignore-secondaries", dest="ignore_secondaries",
- default=False, action="store_true",
- help="Ignore errors from secondaries"),
- m_node_opt, m_pri_node_opt, m_sec_node_opt,
- m_clust_opt, m_inst_opt,
- ],
- "<instance>", "Reboots an instance"),
- 'activate-disks': (ActivateDisks, ARGS_ONE, [DEBUG_OPT],
- "<instance>",
- "Activate an instance's disks"),
- 'deactivate-disks': (DeactivateDisks, ARGS_ONE, [DEBUG_OPT],
- "<instance>",
- "Deactivate an instance's disks"),
- 'list-tags': (ListTags, ARGS_ONE, [DEBUG_OPT],
- "<node_name>", "List the tags of the given instance"),
- 'add-tags': (AddTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
- "<node_name> tag...", "Add tags to the given instance"),
- 'remove-tags': (RemoveTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
- "<node_name> tag...", "Remove tags from given instance"),
+ 'add': (
+ AddInstance, [ArgHost(min=1, max=1)], add_opts,
+ "[...] -t disk-type -n node[:secondary-node] -o os-type <name>",
+ "Creates and adds a new instance to the cluster"),
+ 'batch-create': (
+ BatchCreate, [ArgFile(min=1, max=1)], [],
+ "<instances.json>",
+ "Create a bunch of instances based on specs in the file."),
+ 'console': (
+ ConnectToInstanceConsole, ARGS_ONE_INSTANCE,
+ [SHOWCMD_OPT],
+ "[--show-cmd] <instance>", "Opens a console on the specified instance"),
+ 'failover': (
+ FailoverInstance, ARGS_ONE_INSTANCE,
+ [FORCE_OPT, IGNORE_CONSIST_OPT, SUBMIT_OPT, SHUTDOWN_TIMEOUT_OPT],
+ "[-f] <instance>", "Stops the instance and starts it on the backup node,"
+ " using the remote mirror (only for instances of type drbd)"),
+ 'migrate': (
+ MigrateInstance, ARGS_ONE_INSTANCE,
+ [FORCE_OPT, NONLIVE_OPT, MIGRATION_MODE_OPT, CLEANUP_OPT],
+ "[-f] <instance>", "Migrate instance to its secondary node"
+ " (only for instances of type drbd)"),
+ 'move': (
+ MoveInstance, ARGS_ONE_INSTANCE,
+ [FORCE_OPT, SUBMIT_OPT, SINGLE_NODE_OPT, SHUTDOWN_TIMEOUT_OPT],
+ "[-f] <instance>", "Move instance to an arbitrary node"
+ " (only for instances of type file and lv)"),
+ 'info': (
+ ShowInstanceConfig, ARGS_MANY_INSTANCES,
+ [STATIC_OPT, ALL_OPT, ROMAN_OPT],
+ "[-s] {--all | <instance>...}",
+ "Show information on the specified instance(s)"),
+ 'list': (
+ ListInstances, ARGS_MANY_INSTANCES,
+ [NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, SYNC_OPT, ROMAN_OPT],
+ "[<instance>...]",
+ "Lists the instances and their status. The available fields are"
+ " (see the man page for details): status, oper_state, oper_ram,"
+ " oper_vcpus, name, os, pnode, snodes, admin_state, admin_ram,"
+ " disk_template, ip, mac, nic_mode, nic_link, sda_size, sdb_size,"
+ " vcpus, serial_no,"
+ " nic.count, nic.mac/N, nic.ip/N, nic.mode/N, nic.link/N,"
+ " nic.macs, nic.ips, nic.modes, nic.links,"
+ " disk.count, disk.size/N, disk.sizes,"
+ " hv/NAME, be/memory, be/vcpus, be/auto_balance,"
+ " hypervisor."
+ " The default field"
+ " list is (in order): %s." % utils.CommaJoin(_LIST_DEF_FIELDS),
+ ),
+ 'reinstall': (
+ ReinstallInstance, [ArgInstance()],
+ [FORCE_OPT, OS_OPT, FORCE_VARIANT_OPT, m_force_multi, m_node_opt,
+ m_pri_node_opt, m_sec_node_opt, m_clust_opt, m_inst_opt, m_node_tags_opt,
+ m_pri_node_tags_opt, m_sec_node_tags_opt, m_inst_tags_opt, SELECT_OS_OPT,
+ SUBMIT_OPT],
+ "[-f] <instance>", "Reinstall a stopped instance"),
+ 'remove': (
+ RemoveInstance, ARGS_ONE_INSTANCE,
+ [FORCE_OPT, SHUTDOWN_TIMEOUT_OPT, IGNORE_FAILURES_OPT, SUBMIT_OPT],
+ "[-f] <instance>", "Shuts down the instance and removes it"),
+ 'rename': (
+ RenameInstance,
+ [ArgInstance(min=1, max=1), ArgHost(min=1, max=1)],
+ [NOIPCHECK_OPT, NONAMECHECK_OPT, SUBMIT_OPT],
+ "<instance> <new_name>", "Rename the instance"),
+ 'replace-disks': (
+ ReplaceDisks, ARGS_ONE_INSTANCE,
+ [AUTO_REPLACE_OPT, DISKIDX_OPT, IALLOCATOR_OPT, EARLY_RELEASE_OPT,
+ NEW_SECONDARY_OPT, ON_PRIMARY_OPT, ON_SECONDARY_OPT, SUBMIT_OPT],
+ "[-s|-p|-n NODE|-I NAME] <instance>",
+ "Replaces all disks for the instance"),
+ 'modify': (
+ SetInstanceParams, ARGS_ONE_INSTANCE,
+ [BACKEND_OPT, DISK_OPT, FORCE_OPT, HVOPTS_OPT, NET_OPT, SUBMIT_OPT,
+ DISK_TEMPLATE_OPT, SINGLE_NODE_OPT, OS_OPT, FORCE_VARIANT_OPT,
+ OSPARAMS_OPT],
+ "<instance>", "Alters the parameters of an instance"),
+ 'shutdown': (
+ GenericManyOps("shutdown", _ShutdownInstance), [ArgInstance()],
+ [m_node_opt, m_pri_node_opt, m_sec_node_opt, m_clust_opt,
+ m_node_tags_opt, m_pri_node_tags_opt, m_sec_node_tags_opt,
+ m_inst_tags_opt, m_inst_opt, m_force_multi, TIMEOUT_OPT, SUBMIT_OPT],
+ "<instance>", "Stops an instance"),
+ 'startup': (
+ GenericManyOps("startup", _StartupInstance), [ArgInstance()],
+ [FORCE_OPT, m_force_multi, m_node_opt, m_pri_node_opt, m_sec_node_opt,
+ m_node_tags_opt, m_pri_node_tags_opt, m_sec_node_tags_opt,
+ m_inst_tags_opt, m_clust_opt, m_inst_opt, SUBMIT_OPT, HVOPTS_OPT,
+ BACKEND_OPT],
+ "<instance>", "Starts an instance"),
+ 'reboot': (
+ GenericManyOps("reboot", _RebootInstance), [ArgInstance()],
+ [m_force_multi, REBOOT_TYPE_OPT, IGNORE_SECONDARIES_OPT, m_node_opt,
+ m_pri_node_opt, m_sec_node_opt, m_clust_opt, m_inst_opt, SUBMIT_OPT,
+ m_node_tags_opt, m_pri_node_tags_opt, m_sec_node_tags_opt,
+ m_inst_tags_opt, SHUTDOWN_TIMEOUT_OPT],
+ "<instance>", "Reboots an instance"),
+ 'activate-disks': (
+ ActivateDisks, ARGS_ONE_INSTANCE, [SUBMIT_OPT, IGNORE_SIZE_OPT],
+ "<instance>", "Activate an instance's disks"),
+ 'deactivate-disks': (
+ DeactivateDisks, ARGS_ONE_INSTANCE, [SUBMIT_OPT],
+ "<instance>", "Deactivate an instance's disks"),
+ 'recreate-disks': (
+ RecreateDisks, ARGS_ONE_INSTANCE, [SUBMIT_OPT, DISKIDX_OPT],
+ "<instance>", "Recreate an instance's disks"),
+ 'grow-disk': (
+ GrowDisk,
+ [ArgInstance(min=1, max=1), ArgUnknown(min=1, max=1),
+ ArgUnknown(min=1, max=1)],
+ [SUBMIT_OPT, NWSYNC_OPT],
+ "<instance> <disk> <size>", "Grow an instance's disk"),
+ 'list-tags': (
+ ListTags, ARGS_ONE_INSTANCE, [],
+ "<instance_name>", "List the tags of the given instance"),
+ 'add-tags': (
+ AddTags, [ArgInstance(min=1, max=1), ArgUnknown()],
+ [TAG_SRC_OPT],
+ "<instance_name> tag...", "Add tags to the given instance"),
+ 'remove-tags': (
+ RemoveTags, [ArgInstance(min=1, max=1), ArgUnknown()],
+ [TAG_SRC_OPT],
+ "<instance_name> tag...", "Remove tags from given instance"),
}
+#: dictionary with aliases for commands
aliases = {
'activate_block_devs': 'activate-disks',
'replace_disks': 'replace-disks',
'stop': 'shutdown',
}
+
if __name__ == '__main__':
sys.exit(GenericMain(commands, aliases=aliases,
override={"tag_type": constants.TAG_INSTANCE}))