Convert “gnt-group list” to query2
[ganeti-local] / lib / client / gnt_group.py
1 #
2 #
3
4 # Copyright (C) 2010 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 """Node group related commands"""
22
23 # pylint: disable-msg=W0401,W0614
24 # W0401: Wildcard import ganeti.cli
25 # W0614: Unused import %s from wildcard import (since we need cli)
26
27 from ganeti.cli import *
28 from ganeti import constants
29 from ganeti import opcodes
30 from ganeti import utils
31
32
33 #: default list of fields for L{ListGroups}
34 _LIST_DEF_FIELDS = ["name", "node_cnt", "pinst_cnt", "alloc_policy"]
35
36
37 def AddGroup(opts, args):
38   """Add a node group to the cluster.
39
40   @param opts: the command line options selected by the user
41   @type args: list
42   @param args: a list of length 1 with the name of the group to create
43   @rtype: int
44   @return: the desired exit code
45
46   """
47   (group_name,) = args
48   op = opcodes.OpAddGroup(group_name=group_name, ndparams=opts.ndparams,
49                           alloc_policy=opts.alloc_policy)
50   SubmitOpCode(op, opts=opts)
51
52
53 def ListGroups(opts, args):
54   """List node groups and their properties.
55
56   @param opts: the command line options selected by the user
57   @type args: list
58   @param args: groups to list, or empty for all
59   @rtype: int
60   @return: the desired exit code
61
62   """
63   desired_fields = ParseFields(opts.output, _LIST_DEF_FIELDS)
64   fmtoverride = dict.fromkeys(["node_list", "pinst_list"], (",".join, False))
65
66   return GenericList(constants.QR_GROUP, desired_fields, args, None,
67                      opts.separator, not opts.no_headers,
68                      format_override=fmtoverride)
69
70
71 def ListGroupFields(opts, args):
72   """List node fields.
73
74   @param opts: the command line options selected by the user
75   @type args: list
76   @param args: fields to list, or empty for all
77   @rtype: int
78   @return: the desired exit code
79
80   """
81   return GenericListFields(constants.QR_GROUP, args, opts.separator,
82                            not opts.no_headers)
83
84
85 def SetGroupParams(opts, args):
86   """Modifies a node group's parameters.
87
88   @param opts: the command line options seletect by the user
89   @type args: list
90   @param args: should contain only one element, the node group name
91
92   @rtype: int
93   @return: the desired exit code
94
95   """
96   all_changes = {
97     "ndparams": opts.ndparams,
98     "alloc_policy": opts.alloc_policy,
99   }
100
101   if all_changes.values().count(None) == len(all_changes):
102     ToStderr("Please give at least one of the parameters.")
103     return 1
104
105   op = opcodes.OpSetGroupParams(group_name=args[0], # pylint: disable-msg=W0142
106                                 **all_changes)
107   result = SubmitOrSend(op, opts)
108
109   if result:
110     ToStdout("Modified node group %s", args[0])
111     for param, data in result:
112       ToStdout(" - %-5s -> %s", param, data)
113
114   return 0
115
116
117 def RemoveGroup(opts, args):
118   """Remove a node group from the cluster.
119
120   @param opts: the command line options selected by the user
121   @type args: list
122   @param args: a list of length 1 with the name of the group to remove
123   @rtype: int
124   @return: the desired exit code
125
126   """
127   (group_name,) = args
128   op = opcodes.OpRemoveGroup(group_name=group_name)
129   SubmitOpCode(op, opts=opts)
130
131
132 def RenameGroup(opts, args):
133   """Rename a node group.
134
135   @param opts: the command line options selected by the user
136   @type args: list
137   @param args: a list of length 2, [old_name, new_name]
138   @rtype: int
139   @return: the desired exit code
140
141   """
142   old_name, new_name = args
143   op = opcodes.OpRenameGroup(old_name=old_name, new_name=new_name)
144   SubmitOpCode(op, opts=opts)
145
146
147 commands = {
148   "add": (
149     AddGroup, ARGS_ONE_GROUP, [DRY_RUN_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT],
150     "<group_name>", "Add a new node group to the cluster"),
151   "list": (
152     ListGroups, ARGS_MANY_GROUPS,
153     [NOHDR_OPT, SEP_OPT, FIELDS_OPT],
154     "[<group_name>...]",
155     "Lists the node groups in the cluster. The available fields can be shown"
156     " using the \"list-fields\" command (see the man page for details)."
157     " The default list is (in order): %s." % utils.CommaJoin(_LIST_DEF_FIELDS)),
158   "list-fields": (
159     ListGroupFields, [ArgUnknown()], [NOHDR_OPT, SEP_OPT], "[fields...]",
160     "Lists all available fields for node groups"),
161   "modify": (
162     SetGroupParams, ARGS_ONE_GROUP,
163     [DRY_RUN_OPT, SUBMIT_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT],
164     "<group_name>", "Alters the parameters of a node group"),
165   "remove": (
166     RemoveGroup, ARGS_ONE_GROUP, [DRY_RUN_OPT],
167     "[--dry-run] <group_name>",
168     "Remove an (empty) node group from the cluster"),
169   "rename": (
170     RenameGroup, [ArgGroup(min=2, max=2)], [DRY_RUN_OPT],
171     "[--dry-run] <old_name> <new_name>", "Rename a node group"),
172 }
173
174
175 def Main():
176   return GenericMain(commands)