# 02110-1301, USA.
+# pylint: disable-msg=W0401,W0614
+# W0401: Wildcard import ganeti.cli
+# W0614: Unused import %s from wildcard import (since we need cli)
+
import sys
import os
import itertools
+import simplejson
from optparse import make_option
from cStringIO import StringIO
from ganeti.cli import *
+from ganeti import cli
from ganeti import opcodes
-from ganeti import logger
from ganeti import constants
from ganeti import utils
from ganeti import errors
_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):
"""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
+
"""
if mode == _SHUTDOWN_CLUSTER:
if names:
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)
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
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",
+ "bridge": "Bridge",
"sda_size": "Disk/0", "sdb_size": "Disk/1",
"status": "Status", "tags": "Tags",
"network_port": "Network_port",
- "kernel_path": "Kernel_path",
- "initrd_path": "Initrd_path",
- "hvm_boot_order": "HVM_boot_order",
- "hvm_acpi": "HVM_ACPI",
- "hvm_pae": "HVM_PAE",
- "hvm_cdrom_image_path": "HVM_CDROM_image_path",
- "hvm_nic_type": "HVM_NIC_type",
- "hvm_disk_type": "HVM_disk_type",
- "vnc_bind_address": "VNC_bind_address",
+ "hv/kernel_path": "Kernel_path",
+ "hv/initrd_path": "Initrd_path",
+ "hv/boot_order": "HVM_boot_order",
+ "hv/acpi": "HVM_ACPI",
+ "hv/pae": "HVM_PAE",
+ "hv/cdrom_image_path": "HVM_CDROM_image_path",
+ "hv/nic_type": "HVM_NIC_type",
+ "hv/disk_type": "HVM_Disk_type",
+ "hv/vnc_bind_address": "VNC_bind_address",
+ "serial_no": "SerialNo", "hypervisor": "Hypervisor",
+ "hvparams": "Hypervisor_parameters",
+ "be/memory": "Configured_memory",
+ "be/vcpus": "VCPUs",
+ "be/auto_balance": "Auto_balance",
+ "disk.count": "Disks", "disk.sizes": "Disk_sizes",
+ "nic.count": "NICs", "nic.ips": "NIC_IPs",
+ "nic.bridges": "NIC_bridges", "nic.macs": "NIC_MACs",
}
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",)
+ list_type_fields = ("tags", "disk.sizes",
+ "nic.macs", "nic.ips", "nic.bridges")
# change raw values to nicer strings
for row in output:
for idx, field in enumerate(selected_fields):
if val is None:
val = "N/A"
elif field in list_type_fields:
- val = ",".join(val)
+ val = ",".join(str(item) for item in val)
+ elif val is None:
+ 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
+ @param opts: the command line options selected by the user
+ @type args: list
+ @param args: should contain only one element, the new instance name
+ @rtype: int
+ @return: the desired exit code
"""
instance = args[0]
(pnode, snode) = SplitNodeOption(opts.node)
- kernel_path = _TransformPath(opts.kernel_path)
- initrd_path = _TransformPath(opts.initrd_path)
-
- hvm_acpi = opts.hvm_acpi == _VALUE_TRUE
- hvm_pae = opts.hvm_pae == _VALUE_TRUE
+ hypervisor = None
+ hvparams = {}
+ if opts.hypervisor:
+ hypervisor, hvparams = opts.hypervisor
- if ((opts.hvm_cdrom_image_path is not None) and
- (opts.hvm_cdrom_image_path.lower() == constants.VALUE_NONE)):
- hvm_cdrom_image_path = None
+ if opts.nics:
+ try:
+ nic_max = max(int(nidx[0])+1 for nidx in opts.nics)
+ except ValueError, err:
+ raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err))
+ nics = [{}] * nic_max
+ for nidx, ndict in opts.nics.items():
+ nidx = int(nidx)
+ nics[nidx] = ndict
+ elif opts.no_nics:
+ # no nics
+ nics = []
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,
+ # default of one nic, all auto
+ nics = [{}]
+
+ if opts.disk_template == constants.DT_DISKLESS:
+ if opts.disks:
+ raise errors.OpPrereqError("Diskless instance but disk"
+ " information passed")
+ disks = []
+ else:
+ if not opts.disks:
+ raise errors.OpPrereqError("No disk information specified")
+ try:
+ disk_max = max(int(didx[0])+1 for didx in opts.disks)
+ except ValueError, err:
+ raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
+ disks = [{}] * disk_max
+ for didx, ddict in opts.disks:
+ didx = int(didx)
+ if "size" not in ddict:
+ raise errors.OpPrereqError("Missing size for disk %d" % didx)
+ try:
+ ddict["size"] = utils.ParseUnit(ddict["size"])
+ except ValueError, err:
+ raise errors.OpPrereqError("Invalid disk size for disk %d: %s" %
+ (didx, err))
+ disks[didx] = ddict
+
+ ValidateBeParams(opts.beparams)
+
+## kernel_path = _TransformPath(opts.kernel_path)
+## initrd_path = _TransformPath(opts.initrd_path)
+
+## hvm_acpi = opts.hvm_acpi == _VALUE_TRUE
+## hvm_pae = opts.hvm_pae == _VALUE_TRUE
+
+## 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,
+ disks=disks,
disk_template=opts.disk_template,
+ nics=nics,
mode=constants.INSTANCE_CREATE,
os_type=opts.os, pnode=pnode,
- snode=snode, vcpus=opts.vcpus,
- ip=opts.ip, bridge=opts.bridge,
+ snode=snode,
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,
+ hypervisor=hypervisor,
+ hvparams=hvparams,
+ beparams=opts.beparams,
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,
- hvm_nic_type=opts.hvm_nic_type,
- hvm_disk_type=opts.hvm_disk_type)
+ )
SubmitOrSend(op, opts)
return 0
+def BatchCreate(opts, args):
+ """Create instances using a definition file.
+
+ This function reads a json file with instances defined
+ in the form::
+
+ {"instance-name":{
+ "disk_size": 25,
+ "swap_size": 1024,
+ "template": "drbd",
+ "backend": {
+ "memory": 512,
+ "vcpus": 1 },
+ "os": "etch-image",
+ "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,
+ "swap_size": 4 * 1024,
+ "backend": {},
+ "iallocator": None,
+ "primary_node": None,
+ "secondary_node": None,
+ "ip": 'none',
+ "mac": 'auto',
+ "bridge": None,
+ "start": True,
+ "ip_check": True,
+ "hypervisor": None,
+ "file_storage_dir": None,
+ "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)
+ # 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.')
+ elif spec['iallocator'] is None:
+ raise errors.OpPrereqError('You have to provide at least a primary_node'
+ ' or an iallocator.')
+
+ if (spec['hypervisor'] and
+ not isinstance(spec['hypervisor'], dict)):
+ raise errors.OpPrereqError('Hypervisor parameters must be a dict.')
+
+ json_filename = args[0]
+ fd = open(json_filename, 'r')
+ try:
+ instance_data = simplejson.load(fd)
+ finally:
+ fd.close()
+
+ # Iterate over the instances and do:
+ # * Populate the specs with default value
+ # * Validate the instance specs
+ for (name, specs) in instance_data.iteritems():
+ specs = _PopulateWithDefaults(specs)
+ _Validate(specs)
+
+ hypervisor = None
+ hvparams = {}
+ if specs['hypervisor']:
+ hypervisor, hvparams = specs['hypervisor'].iteritems()
+
+ op = opcodes.OpCreateInstance(instance_name=name,
+ disk_size=specs['disk_size'],
+ swap_size=specs['swap_size'],
+ disk_template=specs['template'],
+ mode=constants.INSTANCE_CREATE,
+ os_type=specs['os'],
+ pnode=specs['primary_node'],
+ snode=specs['secondary_node'],
+ ip=specs['ip'], bridge=specs['bridge'],
+ start=specs['start'],
+ ip_check=specs['ip_check'],
+ wait_for_sync=True,
+ mac=specs['mac'],
+ iallocator=specs['iallocator'],
+ hypervisor=hypervisor,
+ hvparams=hvparams,
+ beparams=specs['backend'],
+ file_storage_dir=specs['file_storage_dir'],
+ file_driver=specs['file_driver'])
+
+ ToStdout("%s: %s", name, cli.SendJob([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]
result = SubmitOpCode(op)
if not result:
- logger.ToStdout("Can't get the OS list")
+ ToStdout("Can't get the OS list")
return 1
- logger.ToStdout("Available OS templates:")
+ ToStdout("Available OS templates:")
number = 0
choices = []
for entry in result:
- logger.ToStdout("%3s: %s" % (number, entry[0]))
+ ToStdout("%3s: %s", number, entry[0])
choices.append(("%s" % number, entry[0], entry[0]))
number = number + 1
choices)
if selected == 'exit':
- logger.ToStdout("User aborted reinstall, exiting")
+ ToStdout("User aborted reinstall, exiting")
return 1
- os = selected
+ os_name = selected
else:
- os = opts.os
+ os_name = opts.os
if not opts.force:
usertext = ("This will reinstall the instance %s and remove"
return 1
op = opcodes.OpReinstallInstance(instance_name=instance_name,
- os_type=os)
+ os_type=os_name)
SubmitOrSend(op, opts)
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]
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
"""
op = opcodes.OpRenameInstance(instance_name=args[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 = 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)
def GrowDisk(opts, args):
- """Command-line interface for _ShutdownInstanceBlockDevices.
+ """Grow 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 two elements, the instance name
+ whose disks we grow and the disk name, e.g. I{sda}
+ @rtype: int
+ @return: the desired exit code
"""
instance = args[0]
disk = args[1]
+ try:
+ disk = int(disk)
+ except ValueError, err:
+ raise errors.OpPrereqError("Invalid disk index: %s" % str(err))
amount = utils.ParseUnit(args[2])
- op = opcodes.OpGrowDisk(instance_name=instance, disk=disk, amount=amount)
+ op = opcodes.OpGrowDisk(instance_name=instance, disk=disk, amount=amount,
+ wait_for_sync=opts.wait_for_sync)
SubmitOrSend(op, opts)
return 0
def StartupInstance(opts, args):
- """Startup an instance.
+ """Startup instances.
+
+ Depending on the options given, this will start one or more
+ instances.
- 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: the instance or node names based on which we
+ create the final selection (in conjunction with the
+ opts argument)
+ @rtype: int
+ @return: the desired exit code
"""
if opts.multi_mode is None:
force=opts.force,
extra_args=opts.extra_args)
if multi_on:
- logger.ToStdout("Starting up %s" % name)
+ ToStdout("Starting up %s", name)
try:
SubmitOrSend(op, opts)
except JobSubmittedException, err:
_, txt = FormatError(err)
- logger.ToStdout("%s" % txt)
+ ToStdout("%s", txt)
return 0
def RebootInstance(opts, args):
- """Reboot an instance
+ """Reboot instance(s).
+
+ Depending on the parameters given, this will reboot one or more
+ instances.
- 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: the instance or node names based on which we
+ create the final selection (in conjunction with the
+ opts argument)
+ @rtype: int
+ @return: the desired exit code
"""
if opts.multi_mode is None:
def ShutdownInstance(opts, args):
"""Shutdown 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: the instance or node names based on which we
+ create the final selection (in conjunction with the
+ opts argument)
+ @rtype: int
+ @return: the desired exit code
"""
if opts.multi_mode is None:
for name in inames:
op = opcodes.OpShutdownInstance(instance_name=name)
if multi_on:
- logger.ToStdout("Shutting down %s" % name)
+ ToStdout("Shutting down %s", name)
try:
SubmitOrSend(op, opts)
except JobSubmittedException, err:
_, txt = FormatError(err)
- logger.ToStdout("%s" % txt)
+ ToStdout("%s", txt)
return 0
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
iallocator = opts.iallocator
if opts.disks is None:
- disks = ["sda", "sdb"]
+ disks = []
else:
- disks = opts.disks.split(",")
+ try:
+ disks = [int(i) for i in opts.disks.split(",")]
+ except ValueError, err:
+ raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
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:
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
"""
instance_name = args[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]
cmd = SubmitOpCode(op)
if opts.show_command:
- print utils.ShellQuoteArgs(cmd)
+ ToStdout("%s", utils.ShellQuoteArgs(cmd))
else:
try:
os.execvp(cmd[0], cmd)
finally:
- sys.stderr.write("Can't run console command %s with arguments:\n'%s'" %
- (cmd, " ".join(argv)))
+ ToStderr("Can't run console command %s with arguments:\n'%s'",
+ cmd[0], " ".join(cmd))
os._exit(1)
-def _FormatBlockDevInfo(buf, dev, indent_level):
+def _FormatBlockDevInfo(buf, dev, indent_level, static):
"""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 buf: StringIO
+ @param buf: buffer that will accumulate the output
+ @type dev: dict
+ @param dev: dictionary with disk information
+ @type indent_level: int
+ @param indent_level: the indendation level we are at, used for
+ the layout of the device tree
+ @type static: boolean
+ @param static: wheter the device information doesn't contain
+ runtime information but only static data
+
"""
def helper(buf, dtype, status):
- """Format one line for physical device status."""
+ """Format one line for physical device status.
+
+ @type buf: StringIO
+ @param buf: buffer that will accumulate the output
+ @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}
+
+ """
if not status:
buf.write("not active\n")
else:
data = " - %s, " % dev["iv_name"]
else:
data = " - "
+ data += "access mode: %s, " % dev["mode"]
data += "type: %s" % dev["dev_type"]
if dev["logical_id"] is not None:
data += ", logical_id: %s" % (dev["logical_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 not static:
+ buf.write("%*s primary: " % (2*indent_level, ""))
+ helper(buf, dev["dev_type"], dev["pstatus"])
- if dev["sstatus"]:
+ if dev["sstatus"] and not static:
buf.write("%*s secondary: " % (2*indent_level, ""))
helper(buf, dev["dev_type"], dev["sstatus"])
if dev["children"]:
for child in dev["children"]:
- _FormatBlockDevInfo(buf, child, indent_level+1)
+ _FormatBlockDevInfo(buf, child, indent_level+1, static)
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)
+ op = opcodes.OpQueryInstanceData(instances=args, static=opts.static)
result = SubmitOpCode(op)
- hvm_parameters = ("hvm_acpi", "hvm_pae", "hvm_cdrom_image_path",
- "hvm_boot_order", "hvm_nic_type", "hvm_disk_type")
-
- pvm_parameters = ("kernel_path", "initrd_path")
-
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("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(" Operating system: %s\n" % instance["os"])
if instance.has_key("network_port"):
buf.write(" Allocated network port: %s\n" % instance["network_port"])
- if False not in map(instance.has_key, pvm_parameters):
- if instance["kernel_path"] in (None, constants.VALUE_DEFAULT):
- kpath = "(default: %s)" % constants.XEN_KERNEL
+ buf.write(" Hypervisor: %s\n" % instance["hypervisor"])
+ if instance["hypervisor"] == constants.HT_XEN_PVM:
+ hvattrs = ((constants.HV_KERNEL_PATH, "kernel path"),
+ (constants.HV_INITRD_PATH, "initrd path"))
+ elif instance["hypervisor"] == constants.HT_XEN_HVM:
+ hvattrs = ((constants.HV_BOOT_ORDER, "boot order"),
+ (constants.HV_ACPI, "ACPI"),
+ (constants.HV_PAE, "PAE"),
+ (constants.HV_CDROM_IMAGE_PATH, "virtual CDROM"),
+ (constants.HV_NIC_TYPE, "NIC type"),
+ (constants.HV_DISK_TYPE, "Disk type"),
+ (constants.HV_VNC_BIND_ADDRESS, "VNC bind address"),
+ )
+ # custom console information for HVM
+ vnc_bind_address = instance["hv_actual"][constants.HV_VNC_BIND_ADDRESS]
+ if vnc_bind_address == constants.BIND_ADDRESS_GLOBAL:
+ vnc_console_port = "%s:%s" % (instance["pnode"],
+ instance["network_port"])
+ elif vnc_bind_address == constants.LOCALHOST_IP_ADDRESS:
+ vnc_console_port = "%s:%s on node %s" % (vnc_bind_address,
+ instance["network_port"],
+ instance["pnode"])
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)"
+ vnc_console_port = "%s:%s" % (vnc_bind_address,
+ instance["network_port"])
+ buf.write(" - console connection: vnc to %s\n" % vnc_console_port)
+
+ else:
+ # auto-handle other hypervisor types
+ hvattrs = [(key, key) for key in instance["hv_actual"]]
+
+ for key, desc in hvattrs:
+ if key in instance["hv_instance"]:
+ val = instance["hv_instance"][key]
else:
- initrd = instance["initrd_path"]
- buf.write(" initrd: %s\n" % initrd)
- if False not in map(instance.has_key, hvm_parameters):
- 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(" - virtual NIC type: %s\n" % instance["hvm_nic_type"])
- buf.write(" - virtual disk type: %s\n" % instance["hvm_disk_type"])
- if instance.has_key("vnc_bind_address"):
- buf.write(" VNC bind address: %s\n" % instance["vnc_bind_address"])
- buf.write(" VNC console port: %s\n" % instance["vnc_console_port"])
+ val = "default (%s)" % instance["hv_actual"][key]
+ buf.write(" - %s: %s\n" % (desc, val))
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(" - VCPUs: %d\n" %
+ instance["be_actual"][constants.BE_VCPUS])
+ buf.write(" - memory: %dMiB\n" %
+ instance["be_actual"][constants.BE_MEMORY])
+ buf.write(" - NICs:\n")
+ for idx, (mac, ip, bridge) in enumerate(instance["nics"]):
+ buf.write(" - nic/%d: MAC: %s, IP: %s, bridge: %s\n" %
+ (idx, mac, ip, bridge))
buf.write(" Block devices:\n")
for device in instance["disks"]:
- _FormatBlockDevInfo(buf, device, 1)
+ _FormatBlockDevInfo(buf, device, 1, opts.static)
- logger.ToStdout(buf.getvalue().rstrip('\n'))
+ 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_pae or opts.hvm_cdrom_image_path or
- opts.vnc_bind_address or opts.hvm_nic_type or opts.hvm_disk_type):
- logger.ToStdout("Please give at least one of the parameters.")
+ if not (opts.nics or opts.disks or
+ opts.hypervisor or opts.beparams):
+ 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
+ if constants.BE_MEMORY in opts.beparams:
+ opts.beparams[constants.BE_MEMORY] = utils.ParseUnit(
+ opts.beparams[constants.BE_MEMORY])
- if opts.hvm_acpi is None:
- hvm_acpi = opts.hvm_acpi
- else:
- hvm_acpi = opts.hvm_acpi == _VALUE_TRUE
-
- if opts.hvm_pae is None:
- hvm_pae = opts.hvm_pae
- else:
- hvm_pae = opts.hvm_pae == _VALUE_TRUE
-
- if opts.hvm_nic_type == constants.VALUE_NONE:
- hvm_nic_type = None
- else:
- hvm_nic_type = opts.hvm_nic_type
+ for idx, (nic_op, nic_dict) in enumerate(opts.nics):
+ try:
+ nic_op = int(nic_op)
+ opts.nics[idx] = (nic_op, nic_dict)
+ except ValueError:
+ pass
- if opts.hvm_disk_type == constants.VALUE_NONE:
- hvm_disk_type = None
- else:
- hvm_disk_type = opts.hvm_disk_type
-
- 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=
- opts.hvm_cdrom_image_path,
- vnc_bind_address=opts.vnc_bind_address,
- hvm_nic_type=hvm_nic_type,
- hvm_disk_type=hvm_disk_type,
+ for idx, (disk_op, disk_dict) in enumerate(opts.disks):
+ try:
+ disk_op = int(disk_op)
+ opts.disks[idx] = (disk_op, disk_dict)
+ except ValueError:
+ pass
+ if disk_op == constants.DDM_ADD:
+ if 'size' not in disk_dict:
+ raise errors.OpPrereqError("Missing required parameter 'size'")
+ disk_dict['size'] = utils.ParseUnit(disk_dict['size'])
+
+ op = opcodes.OpSetInstanceParams(instance_name=args[0],
+ nics=opts.nics,
+ disks=opts.disks,
+ hvparams=opts.hypervisor,
+ beparams=opts.beparams,
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 these parameters take effect"
+ " only at the next start of the instance.")
return 0
" 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>"),
+ keyval_option("-B", "--backend", dest="beparams",
+ type="keyval", default={},
+ help="Backend parameters"),
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>"),
+ ikv_option("--disk", help="Disk information",
+ default=[], dest="disks",
+ action="append",
+ type="identkeyval"),
+ ikv_option("--net", help="NIC information",
+ default=[], dest="nics",
+ action="append",
+ type="identkeyval"),
+ make_option("--no-nics", default=False, action="store_true",
+ help="Do not create any network cards for the instance"),
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,
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-nic-type", dest="hvm_nic_type",
- help="Type of virtual NIC for HVM "
- "(rtl8139,ne2k_pci,ne2k_isa,paravirtual)",
- metavar="NICTYPE", choices=[constants.HT_HVM_NIC_RTL8139,
- constants.HT_HVM_NIC_NE2K_PCI,
- constants.HT_HVM_NIC_NE2K_ISA,
- constants.HT_HVM_DEV_PARAVIRTUAL],
- default=constants.HT_HVM_NIC_RTL8139),
- make_option("--hvm-disk-type", dest="hvm_disk_type",
- help="Type of virtual disks for HVM (ioemu,paravirtual)",
- metavar="DISKTYPE", choices=[constants.HT_HVM_DEV_IOEMU,
- constants.HT_HVM_DEV_PARAVIRTUAL],
- default=constants.HT_HVM_DEV_IOEMU,),
- 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>"),
+ ikv_option("-H", "--hypervisor", dest="hypervisor",
+ help="Hypervisor and hypervisor options, in the format"
+ " hypervisor:option=value,option=value,...", default=None,
+ type="identkeyval"),
SUBMIT_OPT,
]
'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"),
+ 'batch-create': (BatchCreate, ARGS_ONE,
+ [DEBUG_OPT],
+ "<instances_file.json>",
+ "Create a bunch of instances based on specs in the file."),
'console': (ConnectToInstanceConsole, ARGS_ONE,
[DEBUG_OPT,
make_option("--show-cmd", dest="show_command",
"[-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"),
+ 'info': (ShowInstanceConfig, ARGS_ANY,
+ [DEBUG_OPT,
+ make_option("-s", "--static", dest="static",
+ action="store_true", default=False,
+ help="Only show configuration data, not runtime data"),
+ ], "[-s] [<instance>...]",
+ "Show information on the specified instance(s)"),
'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"
+ " ip, mac, bridge, sda_size, sdb_size, vcpus, serial_no,"
+ " hypervisor."
+ " The default field"
" list is (in order): %s." % ", ".join(_LIST_DEF_FIELDS),
),
'reinstall': (ReinstallInstance, ARGS_ONE,
"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("--hvm-nic-type", dest="hvm_nic_type",
- help="Type of virtual NIC for HVM "
- "(rtl8139,ne2k_pci,ne2k_isa,paravirtual)",
- metavar="NICTYPE",
- choices=[constants.HT_HVM_NIC_RTL8139,
- constants.HT_HVM_NIC_NE2K_PCI,
- constants.HT_HVM_NIC_NE2K_ISA,
- constants.HT_HVM_DEV_PARAVIRTUAL],
- default=None),
- make_option("--hvm-disk-type", dest="hvm_disk_type",
- help="Type of virtual disks for HVM "
- "(ioemu,paravirtual)",
- metavar="DISKTYPE",
- choices=[constants.HT_HVM_DEV_IOEMU,
- constants.HT_HVM_DEV_PARAVIRTUAL],
- default=None),
- make_option("--vnc-bind-address", dest="vnc_bind_address",
- help="bind address for VNC (IP address)",
- default=None, type="string", metavar="<VNCADDRESS>"),
+ keyval_option("-H", "--hypervisor", type="keyval",
+ default={}, dest="hypervisor",
+ help="Change hypervisor parameters"),
+ keyval_option("-B", "--backend", type="keyval",
+ default={}, dest="beparams",
+ help="Change backend parameters"),
+ ikv_option("--disk", help="Disk changes",
+ default=[], dest="disks",
+ action="append",
+ type="identkeyval"),
+ ikv_option("--net", help="NIC changes",
+ default=[], dest="nics",
+ action="append",
+ type="identkeyval"),
SUBMIT_OPT,
],
"<instance>", "Alters the parameters of an instance"),
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,
+ default=constants.INSTANCE_REBOOT_HARD,
type="string", metavar="<REBOOT>"),
make_option("--ignore-secondaries", dest="ignore_secondaries",
default=False, action="store_true",
'deactivate-disks': (DeactivateDisks, ARGS_ONE, [DEBUG_OPT, SUBMIT_OPT],
"<instance>",
"Deactivate an instance's disks"),
- 'grow-disk': (GrowDisk, ARGS_FIXED(3), [DEBUG_OPT, SUBMIT_OPT],
+ 'grow-disk': (GrowDisk, ARGS_FIXED(3),
+ [DEBUG_OPT, SUBMIT_OPT,
+ make_option("--no-wait-for-sync",
+ dest="wait_for_sync", default=True,
+ action="store_false",
+ help="Don't wait for sync (DANGEROUS!)"),
+ ],
"<instance> <disk> <size>", "Grow an instance's disk"),
'list-tags': (ListTags, ARGS_ONE, [DEBUG_OPT],
- "<node_name>", "List the tags of the given instance"),
+ "<instance_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"),
+ "<instance_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"),
+ "<instance_name> tag...", "Remove tags from given instance"),
}
+#: dictionary with aliases for commands
aliases = {
'activate_block_devs': 'activate-disks',
'replace_disks': 'replace-disks',
projects / ganeti-local / blobdiff