4 # Copyright (C) 2006, 2007 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 # pylint: disable-msg=W0401,W0614
23 # W0401: Wildcard import ganeti.cli
24 # W0614: Unused import %s from wildcard import (since we need cli)
28 from ganeti.cli import *
29 from ganeti import opcodes
30 from ganeti import constants
31 from ganeti import errors
32 from ganeti import utils
38 def PrintExportList(opts, args):
39 """Prints a list of all the exported system images.
41 @param opts: the command line options selected by the user
43 @param args: should be an empty list
45 @return: the desired exit code
48 exports = GetClient().QueryExports(opts.nodes, False)
51 ToStdout("Node: %s", node)
53 if isinstance(exports[node], list):
54 for instance_name in exports[node]:
55 ToStdout("\t%s", instance_name)
57 ToStdout(" Could not get exports list")
62 def ExportInstance(opts, args):
63 """Export an instance to an image in the cluster.
65 @param opts: the command line options selected by the user
67 @param args: should contain only one element, the name
68 of the instance to be exported
70 @return: the desired exit code
73 op = opcodes.OpExportInstance(instance_name=args[0],
74 target_node=opts.node,
75 shutdown=opts.shutdown)
77 fin_resu, dlist = SubmitOpCode(op)
78 if not isinstance(dlist, list):
79 ToStderr("Cannot parse execution results")
82 # TODO: handle diskless instances
83 if dlist.count(False) == 0:
86 elif dlist.count(True) == 0:
87 ToStderr("Error: No disks were backed up successfully."
88 " The export doesn't have any valid data,"
89 " it is recommended to retry the operation.")
92 ToStderr("Partial export failure: %d disks backed up, %d disks failed.",
93 dlist.count(True), dlist.count(False))
99 def ImportInstance(opts, args):
100 """Add an instance to the cluster.
102 @param opts: the command line options selected by the user
104 @param args: should contain only one element, the new instance name
106 @return: the desired exit code
111 (pnode, snode) = SplitNodeOption(opts.node)
116 hypervisor, hvparams = opts.hypervisor
120 nic_max = max(int(nidx[0])+1 for nidx in opts.nics)
121 except ValueError, err:
122 raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err))
123 nics = [{}] * nic_max
124 for nidx, ndict in opts.nics:
126 if not isinstance(ndict, dict):
127 msg = "Invalid nic/%d value: expected dict, got %s" % (nidx, ndict)
128 raise errors.OpPrereqError(msg)
134 # default of one nic, all auto
137 if opts.disk_template == constants.DT_DISKLESS:
138 if opts.disks or opts.sd_size is not None:
139 raise errors.OpPrereqError("Diskless instance but disk"
140 " information passed")
143 if not opts.disks and not opts.sd_size:
144 raise errors.OpPrereqError("No disk information specified")
145 if opts.disks and opts.sd_size is not None:
146 raise errors.OpPrereqError("Please use either the '--disk' or"
148 if opts.sd_size is not None:
149 opts.disks = [(0, {"size": opts.sd_size})]
151 disk_max = max(int(didx[0])+1 for didx in opts.disks)
152 except ValueError, err:
153 raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
154 disks = [{}] * disk_max
155 for didx, ddict in opts.disks:
157 if not isinstance(ddict, dict):
158 msg = "Invalid disk/%d value: expected dict, got %s" % (didx, ddict)
159 raise errors.OpPrereqError(msg)
160 elif "size" not in ddict:
161 raise errors.OpPrereqError("Missing size for disk %d" % didx)
163 ddict["size"] = utils.ParseUnit(ddict["size"])
164 except ValueError, err:
165 raise errors.OpPrereqError("Invalid disk size for disk %d: %s" %
169 utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES)
170 utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)
172 op = opcodes.OpCreateInstance(instance_name=instance,
173 disk_template=opts.disk_template,
176 mode=constants.INSTANCE_IMPORT,
177 pnode=pnode, snode=snode,
178 ip_check=opts.ip_check,
180 src_node=opts.src_node, src_path=opts.src_dir,
181 wait_for_sync=opts.wait_for_sync,
182 file_storage_dir=opts.file_storage_dir,
183 file_driver=opts.file_driver,
184 iallocator=opts.iallocator,
185 hypervisor=hypervisor,
187 beparams=opts.beparams)
193 def RemoveExport(opts, args):
194 """Remove an export from the cluster.
196 @param opts: the command line options selected by the user
198 @param args: should contain only one element, the name of the
199 instance whose backup should be removed
201 @return: the desired exit code
205 op = opcodes.OpRemoveExport(instance_name=args[0])
211 # this is defined separately due to readability only
214 cli_option("-n", "--node", dest="node",
215 help="Target node and optional secondary node",
216 metavar="<pnode>[:<snode>]",
217 completion_suggest=OPT_COMPL_INST_ADD_NODES),
218 cli_option("-B", "--backend", dest="beparams",
219 type="keyval", default={},
220 help="Backend parameters"),
222 cli_option("--disk", help="Disk information",
223 default=[], dest="disks",
226 cli_option("-s", "--os-size", dest="sd_size", help="Disk size for a"
227 " single-disk configuration, when not using the --disk option,"
228 " in MiB unless a suffix is used",
229 default=None, type="unit", metavar="<size>"),
230 cli_option("--net", help="NIC information",
231 default=[], dest="nics",
234 cli_option("--no-nics", default=False, action="store_true",
235 help="Do not create any network cards for the instance"),
237 cli_option("--src-node", dest="src_node", help="Source node",
239 completion_suggest=OPT_COMPL_ONE_NODE),
240 cli_option("--src-dir", dest="src_dir", help="Source directory",
242 cli_option("--no-ip-check", dest="ip_check", default=True,
243 action="store_false", help="Don't check that the instance's IP"
245 cli_option("-I", "--iallocator", metavar="<NAME>",
246 help="Select nodes for the instance automatically using the"
247 " <NAME> iallocator plugin", default=None, type="string",
248 completion_suggest=OPT_COMPL_ONE_IALLOCATOR),
249 cli_option("--file-storage-dir", dest="file_storage_dir",
250 help="Relative path under default cluster-wide file storage dir"
251 " to store file-based disks", default=None,
253 cli_option("--file-driver", dest="file_driver", help="Driver to use"
254 " for image files", default="loop", metavar="<DRIVER>",
255 choices=list(constants.FILE_DRIVER)),
256 cli_option("-H", "--hypervisor", dest="hypervisor",
257 help="Hypervisor and hypervisor options, in the format"
258 " hypervisor:option=value,option=value,...", default=None,
263 'list': (PrintExportList, ARGS_NONE,
265 cli_option("--node", dest="nodes", default=[], action="append",
266 help="List only backups stored on this node"
267 " (can be used multiple times)",
268 completion_suggest=OPT_COMPL_ONE_NODE),
270 "", "Lists instance exports available in the ganeti cluster"),
271 'export': (ExportInstance, ARGS_ONE_INSTANCE,
272 [DEBUG_OPT, FORCE_OPT,
273 cli_option("-n", "--node", dest="node", help="Target node",
275 completion_suggest=OPT_COMPL_ONE_NODE),
276 cli_option("","--noshutdown", dest="shutdown",
277 action="store_false", default=True,
278 help="Don't shutdown the instance (unsafe)"), ],
279 "-n <target_node> [opts...] <name>",
280 "Exports an instance to an image"),
281 'import': (ImportInstance, ARGS_ONE_INSTANCE, import_opts,
282 ("[...] -t disk-type -n node[:secondary-node]"
284 "Imports an instance from an exported image"),
285 'remove': (RemoveExport, [ArgUnknown(min=1, max=1)],
288 "Remove exports of named instance from the filesystem."),
292 if __name__ == '__main__':
293 sys.exit(GenericMain(commands))