code.grnet.gr Git - ganeti-local/blob - lib/client/gnt_backup.py

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007, 2010, 2011, 2013 Google Inc.
   5 #
   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.
  10 #
  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.
  15 #
  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
  19 # 02110-1301, USA.
  20
  21 """Backup related commands"""
  22
  23 # pylint: disable=W0401,W0613,W0614,C0103
  24 # W0401: Wildcard import ganeti.cli
  25 # W0613: Unused argument, since all functions follow the same API
  26 # W0614: Unused import %s from wildcard import (since we need cli)
  27 # C0103: Invalid name gnt-backup
  28
  29 from ganeti.cli import *
  30 from ganeti import opcodes
  31 from ganeti import constants
  32 from ganeti import errors
  33 from ganeti import qlang
  34
  35
  36 _LIST_DEF_FIELDS = ["node", "export"]
  37
  38
  39 def PrintExportList(opts, args):
  40   """Prints a list of all the exported system images.
  41
  42   @param opts: the command line options selected by the user
  43   @type args: list
  44   @param args: should be an empty list
  45   @rtype: int
  46   @return: the desired exit code
  47
  48   """
  49   selected_fields = ParseFields(opts.output, _LIST_DEF_FIELDS)
  50
  51   qfilter = qlang.MakeSimpleFilter("node", opts.nodes)
  52
  53   cl = GetClient(query=True)
  54
  55   return GenericList(constants.QR_EXPORT, selected_fields, None, opts.units,
  56                      opts.separator, not opts.no_headers,
  57                      verbose=opts.verbose, qfilter=qfilter, cl=cl)
  58
  59
  60 def ListExportFields(opts, args):
  61   """List export fields.
  62
  63   @param opts: the command line options selected by the user
  64   @type args: list
  65   @param args: fields to list, or empty for all
  66   @rtype: int
  67   @return: the desired exit code
  68
  69   """
  70   cl = GetClient(query=True)
  71
  72   return GenericListFields(constants.QR_EXPORT, args, opts.separator,
  73                            not opts.no_headers, cl=cl)
  74
  75
  76 def ExportInstance(opts, args):
  77   """Export an instance to an image in the cluster.
  78
  79   @param opts: the command line options selected by the user
  80   @type args: list
  81   @param args: should contain only one element, the name
  82       of the instance to be exported
  83   @rtype: int
  84   @return: the desired exit code
  85
  86   """
  87   ignore_remove_failures = opts.ignore_remove_failures
  88
  89   if not opts.node:
  90     raise errors.OpPrereqError("Target node must be specified",
  91                                errors.ECODE_INVAL)
  92
  93   op = opcodes.OpBackupExport(instance_name=args[0],
  94                               target_node=opts.node,
  95                               shutdown=opts.shutdown,
  96                               shutdown_timeout=opts.shutdown_timeout,
  97                               remove_instance=opts.remove_instance,
  98                               ignore_remove_failures=ignore_remove_failures)
  99
 100   SubmitOrSend(op, opts)
 101   return 0
 102
 103
 104 def ImportInstance(opts, args):
 105   """Add an instance to the cluster.
 106
 107   This is just a wrapper over GenericInstanceCreate.
 108
 109   """
 110   return GenericInstanceCreate(constants.INSTANCE_IMPORT, opts, args)
 111
 112
 113 def RemoveExport(opts, args):
 114   """Remove an export from the cluster.
 115
 116   @param opts: the command line options selected by the user
 117   @type args: list
 118   @param args: should contain only one element, the name of the
 119       instance whose backup should be removed
 120   @rtype: int
 121   @return: the desired exit code
 122
 123   """
 124   op = opcodes.OpBackupRemove(instance_name=args[0])
 125
 126   SubmitOrSend(op, opts)
 127   return 0
 128
 129
 130 # this is defined separately due to readability only
 131 import_opts = [
 132   IDENTIFY_DEFAULTS_OPT,
 133   SRC_DIR_OPT,
 134   SRC_NODE_OPT,
 135   IGNORE_IPOLICY_OPT,
 136   ]
 137
 138
 139 commands = {
 140   "list": (
 141     PrintExportList, ARGS_NONE,
 142     [NODE_LIST_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, VERBOSE_OPT],
 143     "", "Lists instance exports available in the ganeti cluster"),
 144   "list-fields": (
 145     ListExportFields, [ArgUnknown()],
 146     [NOHDR_OPT, SEP_OPT],
 147     "[fields...]",
 148     "Lists all available fields for exports"),
 149   "export": (
 150     ExportInstance, ARGS_ONE_INSTANCE,
 151     [FORCE_OPT, SINGLE_NODE_OPT, NOSHUTDOWN_OPT, SHUTDOWN_TIMEOUT_OPT,
 152      REMOVE_INSTANCE_OPT, IGNORE_REMOVE_FAILURES_OPT, DRY_RUN_OPT,
 153      PRIORITY_OPT] + SUBMIT_OPTS,
 154     "-n <target_node> [opts...] <name>",
 155     "Exports an instance to an image"),
 156   "import": (
 157     ImportInstance, ARGS_ONE_INSTANCE, COMMON_CREATE_OPTS + import_opts,
 158     "[...] -t disk-type -n node[:secondary-node] <name>",
 159     "Imports an instance from an exported image"),
 160   "remove": (
 161     RemoveExport, [ArgUnknown(min=1, max=1)],
 162     [DRY_RUN_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
 163     "<name>", "Remove exports of named instance from the filesystem."),
 164   }
 165
 166
 167 def Main():
 168   return GenericMain(commands)