-
Notifications
You must be signed in to change notification settings - Fork 26
/
_cmd_vfunction.py
291 lines (234 loc) · 11 KB
/
_cmd_vfunction.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# Copyright 2016-2017 IBM Corp. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import
import click
import zhmcclient
from .zhmccli import cli
from ._helper import print_properties, print_resources, abort_if_false, \
options_to_properties, original_options, COMMAND_OPTIONS_METAVAR, \
raise_click_exception
from ._cmd_partition import find_partition
def find_vfunction(cmd_ctx, client, cpc_name, partition_name, vfunction_name):
"""
Find a virtual function by name and return its resource object.
"""
partition = find_partition(cmd_ctx, client, cpc_name, partition_name)
try:
vfunction = partition.virtual_functions.find(name=vfunction_name)
except zhmcclient.Error as exc:
raise_click_exception(exc, cmd_ctx.error_format)
return vfunction
@cli.group('vfunction', options_metavar=COMMAND_OPTIONS_METAVAR)
def vfunction_group():
"""
Command group for managing virtual functions.
In addition to the command-specific options shown in this help text, the
general options (see 'zhmc --help') can also be specified right after the
'zhmc' command name.
"""
@vfunction_group.command('list', options_metavar=COMMAND_OPTIONS_METAVAR)
@click.argument('CPC', type=str, metavar='CPC')
@click.argument('PARTITION', type=str, metavar='PARTITION')
@click.option('--uri', is_flag=True, required=False,
help='Show additional properties for the resource URI.')
@click.pass_obj
def vfunction_list(cmd_ctx, cpc, partition, **options):
"""
List the virtual functions in a partition.
In addition to the command-specific options shown in this help text, the
general options (see 'zhmc --help') can also be specified right after the
'zhmc' command name.
"""
cmd_ctx.execute_cmd(lambda: cmd_vfunction_list(cmd_ctx, cpc, partition,
options))
@vfunction_group.command('show', options_metavar=COMMAND_OPTIONS_METAVAR)
@click.argument('CPC', type=str, metavar='CPC')
@click.argument('PARTITION', type=str, metavar='PARTITION')
@click.argument('VFUNCTION', type=str, metavar='VFUNCTION')
@click.pass_obj
def vfunction_show(cmd_ctx, cpc, partition, vfunction):
"""
Show the details of a virtual function.
In addition to the command-specific options shown in this help text, the
general options (see 'zhmc --help') can also be specified right after the
'zhmc' command name.
"""
cmd_ctx.execute_cmd(lambda: cmd_vfunction_show(cmd_ctx, cpc, partition,
vfunction))
@vfunction_group.command('create', options_metavar=COMMAND_OPTIONS_METAVAR)
@click.argument('CPC', type=str, metavar='CPC')
@click.argument('PARTITION', type=str, metavar='PARTITION')
@click.option('--name', type=str, required=True,
help='The name of the new virtual function. Must be unique '
'within the virtual functions of the partition')
@click.option('--description', type=str, required=False,
help='The description of the new virtual function. '
'Default: empty')
@click.option('--adapter', type=str, required=True,
help='The name of the adapter backing the virtual function.')
@click.option('--device-number', type=str, required=False,
help='The device number to be used for the new virtual '
'function. Default: auto-generated')
@click.pass_obj
def vfunction_create(cmd_ctx, cpc, partition, **options):
"""
Create a virtual function in a partition.
This assigns a virtual function of an adapter to a partition, creating
a named virtual function resource within that partition.
In addition to the command-specific options shown in this help text, the
general options (see 'zhmc --help') can also be specified right after the
'zhmc' command name.
"""
cmd_ctx.execute_cmd(lambda: cmd_vfunction_create(cmd_ctx, cpc, partition,
options))
@vfunction_group.command('update', options_metavar=COMMAND_OPTIONS_METAVAR)
@click.argument('CPC', type=str, metavar='CPC')
@click.argument('PARTITION', type=str, metavar='PARTITION')
@click.argument('VFUNCTION', type=str, metavar='VFUNCTION')
@click.option('--name', type=str, required=False,
help='The new name of the virtual function. Must be unique '
'within the virtual functions of the partition.')
@click.option('--description', type=str, required=False,
help='The new description of the virtual function.')
@click.option('--adapter', type=str, required=False,
help='The name of the new adapter (in the same CPC) that will '
'back the virtual function.')
@click.option('--device-number', type=str, required=False,
help='The new device number to be used for the virtual '
'function.')
@click.pass_obj
def vfunction_update(cmd_ctx, cpc, partition, vfunction, **options):
"""
Update the properties of a virtual function.
Only the properties will be changed for which a corresponding option is
specified, so the default for all options is not to change properties.
In addition to the command-specific options shown in this help text, the
general options (see 'zhmc --help') can also be specified right after the
'zhmc' command name.
"""
cmd_ctx.execute_cmd(lambda: cmd_vfunction_update(cmd_ctx, cpc, partition,
vfunction, options))
@vfunction_group.command('delete', options_metavar=COMMAND_OPTIONS_METAVAR)
@click.argument('CPC', type=str, metavar='CPC')
@click.argument('PARTITION', type=str, metavar='PARTITION')
@click.argument('VFUNCTION', type=str, metavar='VFUNCTION')
@click.option('-y', '--yes', is_flag=True, callback=abort_if_false,
expose_value=False,
help='Skip prompt to confirm deletion of the virtual function.',
prompt='Are you sure you want to delete this virtual function ?')
@click.pass_obj
def vfunction_delete(cmd_ctx, cpc, partition, vfunction):
"""
Delete a virtual function.
In addition to the command-specific options shown in this help text, the
general options (see 'zhmc --help') can also be specified right after the
'zhmc' command name.
"""
cmd_ctx.execute_cmd(lambda: cmd_vfunction_delete(cmd_ctx, cpc, partition,
vfunction))
def cmd_vfunction_list(cmd_ctx, cpc_name, partition_name, options):
client = zhmcclient.Client(cmd_ctx.session)
partition = find_partition(cmd_ctx, client, cpc_name, partition_name)
try:
vfunctions = partition.virtual_functions.list()
except zhmcclient.Error as exc:
raise_click_exception(exc, cmd_ctx.error_format)
show_list = [
'name',
]
if options['uri']:
show_list.extend([
'element-uri',
])
cmd_ctx.spinner.stop()
print_resources(vfunctions, cmd_ctx.output_format, show_list)
def cmd_vfunction_show(cmd_ctx, cpc_name, partition_name, vfunction_name):
client = zhmcclient.Client(cmd_ctx.session)
vfunction = find_vfunction(cmd_ctx, client, cpc_name, partition_name,
vfunction_name)
try:
vfunction.pull_full_properties()
except zhmcclient.Error as exc:
raise_click_exception(exc, cmd_ctx.error_format)
cmd_ctx.spinner.stop()
print_properties(vfunction.properties, cmd_ctx.output_format)
def cmd_vfunction_create(cmd_ctx, cpc_name, partition_name, options):
client = zhmcclient.Client(cmd_ctx.session)
partition = find_partition(cmd_ctx, client, cpc_name, partition_name)
name_map = {
# The following options are handled in this function:
'adapter': None,
}
options = original_options(options)
properties = options_to_properties(options, name_map)
adapter_name = options['adapter']
try:
adapter = partition.manager.cpc.adapters.find(name=adapter_name)
except zhmcclient.NotFound:
raise_click_exception("Could not find adapter %s in CPC %s." %
(adapter_name, cpc_name), cmd_ctx.error_format)
properties['adapter-uri'] = adapter.uri
try:
new_vfunction = partition.virtual_functions.create(properties)
except zhmcclient.Error as exc:
raise_click_exception(exc, cmd_ctx.error_format)
cmd_ctx.spinner.stop()
click.echo("New virtual function %s has been created." %
new_vfunction.properties['name'])
def cmd_vfunction_update(cmd_ctx, cpc_name, partition_name, vfunction_name,
options):
client = zhmcclient.Client(cmd_ctx.session)
vfunction = find_vfunction(cmd_ctx, client, cpc_name, partition_name,
vfunction_name)
name_map = {
# The following options are handled in this function:
'adapter': None,
}
options = original_options(options)
properties = options_to_properties(options, name_map)
if options['adapter'] is not None:
adapter_name = options['adapter']
try:
adapter = vfunction.manager.partition.manager.cpc.adapters.find(
name=adapter_name)
except zhmcclient.NotFound:
raise_click_exception("Could not find adapter %s in CPC %s." %
(adapter_name, cpc_name),
cmd_ctx.error_format)
properties['adapter-uri'] = adapter.uri
if not properties:
cmd_ctx.spinner.stop()
click.echo("No properties specified for updating virtual function "
"%s." % vfunction_name)
return
try:
vfunction.update_properties(properties)
except zhmcclient.Error as exc:
raise_click_exception(exc, cmd_ctx.error_format)
cmd_ctx.spinner.stop()
if 'name' in properties and properties['name'] != vfunction_name:
click.echo("Virtual function %s has been renamed to %s and was "
"updated." % (vfunction_name, properties['name']))
else:
click.echo("Virtual function %s has been updated." % vfunction_name)
def cmd_vfunction_delete(cmd_ctx, cpc_name, partition_name, vfunction_name):
client = zhmcclient.Client(cmd_ctx.session)
vfunction = find_vfunction(cmd_ctx, client, cpc_name, partition_name,
vfunction_name)
try:
vfunction.delete()
except zhmcclient.Error as exc:
raise_click_exception(exc, cmd_ctx.error_format)
cmd_ctx.spinner.stop()
click.echo('Virtual function %s has been deleted.' % vfunction_name)