Further pylint disables, mostly for Unused args
[ganeti-local] / scripts / gnt-backup
1 #!/usr/bin/python
2 #
3
4 # Copyright (C) 2006, 2007 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-msg=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 import sys
30
31 from ganeti.cli import *
32 from ganeti import opcodes
33 from ganeti import constants
34 from ganeti import errors
35 from ganeti import utils
36
37
38 _VALUE_TRUE = "true"
39
40
41 def PrintExportList(opts, args):
42   """Prints a list of all the exported system images.
43
44   @param opts: the command line options selected by the user
45   @type args: list
46   @param args: should be an empty list
47   @rtype: int
48   @return: the desired exit code
49
50   """
51   exports = GetClient().QueryExports(opts.nodes, False)
52   retcode = 0
53   for node in exports:
54     ToStdout("Node: %s", node)
55     ToStdout("Exports:")
56     if isinstance(exports[node], list):
57       for instance_name in exports[node]:
58         ToStdout("\t%s", instance_name)
59     else:
60       ToStdout("  Could not get exports list")
61       retcode = 1
62   return retcode
63
64
65 def ExportInstance(opts, args):
66   """Export an instance to an image in the cluster.
67
68   @param opts: the command line options selected by the user
69   @type args: list
70   @param args: should contain only one element, the name
71       of the instance to be exported
72   @rtype: int
73   @return: the desired exit code
74
75   """
76   op = opcodes.OpExportInstance(instance_name=args[0],
77                                 target_node=opts.node,
78                                 shutdown=opts.shutdown,
79                                 shutdown_timeout=opts.shutdown_timeout)
80
81   fin_resu, dlist = SubmitOpCode(op)
82   if not isinstance(dlist, list):
83     ToStderr("Cannot parse execution results")
84     return 1
85   # TODO: handle diskless instances
86   if dlist.count(False) == 0:
87     # all OK
88     rcode = 0
89   elif dlist.count(True) == 0:
90     ToStderr("Error: No disks were backed up successfully."
91              " The export doesn't have any valid data,"
92              " it is recommended to retry the operation.")
93     rcode = 1
94   else:
95     ToStderr("Partial export failure: %d disks backed up, %d disks failed.",
96              dlist.count(True), dlist.count(False))
97     rcode = 2
98   if not fin_resu:
99     rcode = 1
100   return rcode
101
102 def ImportInstance(opts, args):
103   """Add an instance to the cluster.
104
105   This is just a wrapper over GenericInstanceCreate.
106
107   """
108   return GenericInstanceCreate(constants.INSTANCE_IMPORT, opts, args)
109
110
111 def RemoveExport(opts, args):
112   """Remove an export from the cluster.
113
114   @param opts: the command line options selected by the user
115   @type args: list
116   @param args: should contain only one element, the name of the
117       instance whose backup should be removed
118   @rtype: int
119   @return: the desired exit code
120
121   """
122   op = opcodes.OpRemoveExport(instance_name=args[0])
123
124   SubmitOpCode(op)
125   return 0
126
127
128 # this is defined separately due to readability only
129 import_opts = [
130   NODE_PLACEMENT_OPT,
131   BACKEND_OPT,
132   DISK_TEMPLATE_OPT,
133   DISK_OPT,
134   OS_SIZE_OPT,
135   NET_OPT,
136   NONICS_OPT,
137   NWSYNC_OPT,
138   SRC_DIR_OPT,
139   SRC_NODE_OPT,
140   NOIPCHECK_OPT,
141   NONAMECHECK_OPT,
142   IALLOCATOR_OPT,
143   FILESTORE_DIR_OPT,
144   FILESTORE_DRIVER_OPT,
145   HYPERVISOR_OPT,
146   SUBMIT_OPT,
147   ]
148
149 commands = {
150   'list': (
151     PrintExportList, ARGS_NONE,
152     [NODE_LIST_OPT],
153     "", "Lists instance exports available in the ganeti cluster"),
154   'export': (
155     ExportInstance, ARGS_ONE_INSTANCE,
156     [FORCE_OPT, SINGLE_NODE_OPT, NOSHUTDOWN_OPT, SHUTDOWN_TIMEOUT_OPT],
157     "-n <target_node> [opts...] <name>",
158     "Exports an instance to an image"),
159   'import': (
160     ImportInstance, ARGS_ONE_INSTANCE, import_opts,
161     "[...] -t disk-type -n node[:secondary-node] <name>",
162     "Imports an instance from an exported image"),
163   'remove': (
164     RemoveExport, [ArgUnknown(min=1, max=1)], [],
165     "<name>", "Remove exports of named instance from the filesystem."),
166   }
167
168
169 if __name__ == '__main__':
170   sys.exit(GenericMain(commands))