_VALUE_TRUE = "true"
+#: default list of options for L{ListInstances}
_LIST_DEF_FIELDS = [
"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
"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 = ["be/memory", "oper_ram", "sda_size", "sdb_size"]
- else:
- unitfields = None
-
- numfields = ["be/memory", "oper_ram", "sda_size", "sdb_size", "be/vcpus",
- "serial_no"]
+ 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:
ToStdout(line)
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]
if opts.hypervisor:
hypervisor, hvparams = opts.hypervisor
+ 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:
+ # 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)
## hvm_cdrom_image_path = opts.hvm_cdrom_image_path
op = opcodes.OpCreateInstance(instance_name=instance,
- disk_size=opts.size, swap_size=opts.swap,
+ disks=disks,
disk_template=opts.disk_template,
+ nics=nics,
mode=constants.INSTANCE_CREATE,
os_type=opts.os, pnode=pnode,
snode=snode,
- ip=opts.ip, bridge=opts.bridge,
start=opts.start, ip_check=opts.ip_check,
wait_for_sync=opts.wait_for_sync,
- mac=opts.mac,
hypervisor=hypervisor,
hvparams=hvparams,
beparams=opts.beparams,
def BatchCreate(opts, args):
- """Create instances on a batched base.
-
- This function reads a json 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"}}
-
- primary_node and secondary_node has precedence over iallocator.
-
- Args:
- opts: The parsed command line options
- args: Argument passed to the command in our case the json file
+ """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,
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]
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)
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,
wait_for_sync=opts.wait_for_sync)
def StartupInstance(opts, args):
- """Startup an instance.
+ """Startup instances.
- Args:
- opts - class with options as members
- args - list containing a single element, the instance name
+ Depending on the options given, this will start one or more
+ instances.
+
+ @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 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:
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]
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"],)
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, static=opts.static)
instance["be_actual"][constants.BE_VCPUS])
buf.write(" - memory: %dMiB\n" %
instance["be_actual"][constants.BE_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(" - 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"]:
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:
- 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.ip or opts.bridge or opts.mac or
+ if not (opts.nics or opts.disks or
opts.hypervisor or opts.beparams):
ToStderr("Please give at least one of the parameters.")
return 1
opts.beparams[constants.BE_MEMORY] = utils.ParseUnit(
opts.beparams[constants.BE_MEMORY])
+ 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
+
+ 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],
- ip=opts.ip,
- bridge=opts.bridge, mac=opts.mac,
+ nics=opts.nics,
+ disks=opts.disks,
hvparams=opts.hypervisor,
beparams=opts.beparams,
force=opts.force)
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"),
"Replaces all disks for the instance"),
'modify': (SetInstanceParams, ARGS_ONE,
[DEBUG_OPT, FORCE_OPT,
- 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>"),
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"),
"<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