allow disassociate sdn_controller from a VIM
[osm/osmclient.git] / osmclient / scripts / osm.py
1 # Copyright 2017-2018 Sandvine
2 # Copyright 2018 Telefonica
3 #
4 # All Rights Reserved.
5 #
6 # Licensed under the Apache License, Version 2.0 (the "License"); you may
7 # not use this file except in compliance with the License. You may obtain
8 # a copy of the License at
9 #
10 # http://www.apache.org/licenses/LICENSE-2.0
11 #
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 # License for the specific language governing permissions and limitations
16 # under the License.
17 """
18 OSM shell/cli
19 """
20
21 import click
22 from osmclient import client
23 from osmclient.common.exceptions import ClientException
24 from prettytable import PrettyTable
25 import yaml
26 import json
27 import time
28 import pycurl
29 import os
30 import textwrap
31 import pkg_resources
32 import logging
33 from datetime import datetime
34
35
36 # Global variables
37
38 CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'], max_content_width=160)
39
40 def wrap_text(text, width):
41 wrapper = textwrap.TextWrapper(width=width)
42 lines = text.splitlines()
43 return "\n".join(map(wrapper.fill, lines))
44
45
46 def trunc_text(text, length):
47 if len(text) > length:
48 return text[:(length - 3)] + '...'
49 else:
50 return text
51
52
53 def check_client_version(obj, what, version='sol005'):
54 """
55 Checks the version of the client object and raises error if it not the expected.
56
57 :param obj: the client object
58 :what: the function or command under evaluation (used when an error is raised)
59 :return: -
60 :raises ClientError: if the specified version does not match the client version
61 """
62 logger.debug("")
63 fullclassname = obj.__module__ + "." + obj.__class__.__name__
64 message = 'The following commands or options are only supported with the option "--sol005": {}'.format(what)
65 if version == 'v1':
66 message = 'The following commands or options are not supported when using option "--sol005": {}'.format(what)
67 if fullclassname != 'osmclient.{}.client.Client'.format(version):
68 raise ClientException(message)
69 return
70
71
72 @click.group(context_settings=dict(help_option_names=['-h', '--help'], max_content_width=160))
73 @click.option('--hostname',
74 default="127.0.0.1",
75 envvar='OSM_HOSTNAME',
76 help='hostname of server. ' +
77 'Also can set OSM_HOSTNAME in environment')
78 #@click.option('--sol005/--no-sol005',
79 # default=True,
80 # envvar='OSM_SOL005',
81 # help='Use ETSI NFV SOL005 API (default) or the previous SO API. ' +
82 # 'Also can set OSM_SOL005 in environment')
83 @click.option('--user',
84 default=None,
85 envvar='OSM_USER',
86 help='user (defaults to admin). ' +
87 'Also can set OSM_USER in environment')
88 @click.option('--password',
89 default=None,
90 envvar='OSM_PASSWORD',
91 help='password (defaults to admin). ' +
92 'Also can set OSM_PASSWORD in environment')
93 @click.option('--project',
94 default=None,
95 envvar='OSM_PROJECT',
96 help='project (defaults to admin). ' +
97 'Also can set OSM_PROJECT in environment')
98 @click.option('-v', '--verbose', count=True,
99 help='increase verbosity (-v INFO, -vv VERBOSE, -vvv DEBUG)')
100 @click.option('--all-projects',
101 default=None,
102 is_flag=True,
103 help='include all projects')
104 @click.option('--public/--no-public', default=None,
105 help='flag for public items (packages, instances, VIM accounts, etc.)')
106 @click.option('--project-domain-name', 'project_domain_name',
107 default=None,
108 envvar='OSM_PROJECT_DOMAIN_NAME',
109 help='project domain name for keystone authentication (default to None). ' +
110 'Also can set OSM_PROJECT_DOMAIN_NAME in environment')
111 @click.option('--user-domain-name', 'user_domain_name',
112 default=None,
113 envvar='OSM_USER_DOMAIN_NAME',
114 help='user domain name for keystone authentication (default to None). ' +
115 'Also can set OSM_USER_DOMAIN_NAME in environment')
116 #@click.option('--so-port',
117 # default=None,
118 # envvar='OSM_SO_PORT',
119 # help='hostname of server. ' +
120 # 'Also can set OSM_SO_PORT in environment')
121 #@click.option('--so-project',
122 # default=None,
123 # envvar='OSM_SO_PROJECT',
124 # help='Project Name in SO. ' +
125 # 'Also can set OSM_SO_PROJECT in environment')
126 #@click.option('--ro-hostname',
127 # default=None,
128 # envvar='OSM_RO_HOSTNAME',
129 # help='hostname of RO server. ' +
130 # 'Also can set OSM_RO_HOSTNAME in environment')
131 #@click.option('--ro-port',
132 # default=None,
133 # envvar='OSM_RO_PORT',
134 # help='hostname of RO server. ' +
135 # 'Also can set OSM_RO_PORT in environment')
136 @click.pass_context
137 def cli_osm(ctx, **kwargs):
138 global logger
139 hostname = kwargs.pop("hostname", None)
140 if hostname is None:
141 print((
142 "either hostname option or OSM_HOSTNAME " +
143 "environment variable needs to be specified"))
144 exit(1)
145 # Remove None values
146 kwargs = {k: v for k, v in kwargs.items() if v is not None}
147 # if so_port is not None:
148 # kwargs['so_port']=so_port
149 # if so_project is not None:
150 # kwargs['so_project']=so_project
151 # if ro_hostname is not None:
152 # kwargs['ro_host']=ro_hostname
153 # if ro_port is not None:
154 # kwargs['ro_port']=ro_port
155 sol005 = os.getenv('OSM_SOL005', True)
156 # if user is not None:
157 # kwargs['user']=user
158 # if password is not None:
159 # kwargs['password']=password
160 # if project is not None:
161 # kwargs['project']=project
162 # if all_projects:
163 # kwargs['all_projects']=all_projects
164 # if public is not None:
165 # kwargs['public']=public
166 ctx.obj = client.Client(host=hostname, sol005=sol005, **kwargs)
167 logger = logging.getLogger('osmclient')
168
169
170 ####################
171 # LIST operations
172 ####################
173
174 @cli_osm.command(name='ns-list', short_help='list all NS instances')
175 @click.option('--filter', default=None,
176 help='restricts the list to the NS instances matching the filter.')
177 @click.option('--long', is_flag=True,
178 help='get more details of the NS (project, vim, deployment status, configuration status.')
179 @click.pass_context
180 def ns_list(ctx, filter, long):
181 """list all NS instances
182
183 \b
184 Options:
185 --filter filterExpr Restricts the list to the NS instances matching the filter
186
187 \b
188 filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
189 concatenated using the "&" character:
190
191 \b
192 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
193 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
194 op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
195 attrName := string
196 value := scalar value
197
198 \b
199 where:
200 * zero or more occurrences
201 ? zero or one occurrence
202 [] grouping of expressions to be used with ? and *
203 "" quotation marks for marking string constants
204 <> name separator
205
206 \b
207 "AttrName" is the name of one attribute in the data type that defines the representation
208 of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
209 <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
210 "Op" stands for the comparison operator. If the expression has concatenated <attrName>
211 entries, it means that the operator "op" is applied to the attribute addressed by the last
212 <attrName> entry included in the concatenation. All simple filter expressions are combined
213 by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
214 the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
215 concatenation of all "attrName" entries except the leaf attribute is called the "attribute
216 prefix". If an attribute referenced in an expression is an array, an object that contains a
217 corresponding array shall be considered to match the expression if any of the elements in the
218 array matches all expressions that have the same attribute prefix.
219
220 \b
221 Filter examples:
222 --filter admin-status=ENABLED
223 --filter nsd-ref=<NSD_NAME>
224 --filter nsd.vendor=<VENDOR>
225 --filter nsd.vendor=<VENDOR>&nsd-ref=<NSD_NAME>
226 --filter nsd.constituent-vnfd.vnfd-id-ref=<VNFD_NAME>
227 """
228 def summarize_deployment_status(status_dict):
229 #Nets
230 summary = ""
231 n_nets = 0
232 status_nets = {}
233 net_list = status_dict['nets']
234 for net in net_list:
235 n_nets += 1
236 if net['status'] not in status_nets:
237 status_nets[net['status']] = 1
238 else:
239 status_nets[net['status']] +=1
240 message = "Nets: "
241 for k,v in status_nets.items():
242 message += "{}:{},".format(k,v)
243 message += "TOTAL:{}".format(n_nets)
244 summary += "{}".format(message)
245 #VMs and VNFs
246 n_vms = 0
247 status_vms = {}
248 status_vnfs = {}
249 vnf_list = status_dict['vnfs']
250 for vnf in vnf_list:
251 member_vnf_index = vnf['member_vnf_index']
252 if member_vnf_index not in status_vnfs:
253 status_vnfs[member_vnf_index] = {}
254 for vm in vnf['vms']:
255 n_vms += 1
256 if vm['status'] not in status_vms:
257 status_vms[vm['status']] = 1
258 else:
259 status_vms[vm['status']] +=1
260 if vm['status'] not in status_vnfs[member_vnf_index]:
261 status_vnfs[member_vnf_index][vm['status']] = 1
262 else:
263 status_vnfs[member_vnf_index][vm['status']] += 1
264 message = "VMs: "
265 for k,v in status_vms.items():
266 message += "{}:{},".format(k,v)
267 message += "TOTAL:{}".format(n_vms)
268 summary += "\n{}".format(message)
269 summary += "\nNFs:"
270 for k,v in status_vnfs.items():
271 total = 0
272 message = "\n {} VMs: ".format(k)
273 for k2,v2 in v.items():
274 message += "{}:{},".format(k2,v2)
275 total += v2
276 message += "TOTAL:{}".format(total)
277 summary += message
278 return summary
279
280 def summarize_config_status(ee_list):
281 n_ee = 0
282 status_ee = {}
283 for ee in ee_list:
284 n_ee += 1
285 if ee['elementType'] not in status_ee:
286 status_ee[ee['elementType']] = {}
287 status_ee[ee['elementType']][ee['status']] = 1
288 continue;
289 if ee['status'] in status_ee[ee['elementType']]:
290 status_ee[ee['elementType']][ee['status']] += 1
291 else:
292 status_ee[ee['elementType']][ee['status']] = 1
293 summary = ""
294 for elementType in ["KDU", "VDU", "PDU", "VNF", "NS"]:
295 if elementType in status_ee:
296 message = ""
297 total = 0
298 for k,v in status_ee[elementType].items():
299 message += "{}:{},".format(k,v)
300 total += v
301 message += "TOTAL:{}\n".format(total)
302 summary += "{}: {}".format(elementType, message)
303 summary += "TOTAL Exec. Env.: {}".format(n_ee)
304 return summary
305 logger.debug("")
306 if filter:
307 check_client_version(ctx.obj, '--filter')
308 resp = ctx.obj.ns.list(filter)
309 else:
310 resp = ctx.obj.ns.list()
311 if long:
312 table = PrettyTable(
313 ['ns instance name',
314 'id',
315 'date',
316 'ns state',
317 'current operation',
318 'error details',
319 'project',
320 'vim (inst param)',
321 'deployment status',
322 'configuration status'])
323 project_list = ctx.obj.project.list()
324 vim_list = ctx.obj.vim.list()
325 else:
326 table = PrettyTable(
327 ['ns instance name',
328 'id',
329 'date',
330 'ns state',
331 'current operation',
332 'error details'])
333 for ns in resp:
334 fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
335 if fullclassname == 'osmclient.sol005.client.Client':
336 nsr = ns
337 nsr_name = nsr['name']
338 nsr_id = nsr['_id']
339 date = datetime.fromtimestamp(nsr['create-time']).strftime("%Y-%m-%dT%H:%M:%S")
340 ns_state = nsr['nsState']
341 if long:
342 deployment_status = summarize_deployment_status(nsr['deploymentStatus'])
343 config_status = summarize_config_status(nsr['configurationStatus'])
344 project_id = nsr.get('_admin').get('projects_read')[0]
345 project_name = '-'
346 for p in project_list:
347 if p['_id'] == project_id:
348 project_name = p['name']
349 break
350 #project = '{} ({})'.format(project_name, project_id)
351 project = project_name
352 vim_id = nsr.get('datacenter')
353 vim_name = '-'
354 for v in vim_list:
355 if v['uuid'] == vim_id:
356 vim_name = v['name']
357 break
358 #vim = '{} ({})'.format(vim_name, vim_id)
359 vim = vim_name
360 current_operation = "{} ({})".format(nsr['currentOperation'],nsr['currentOperationID'])
361 error_details = "N/A"
362 if ns_state == "BROKEN" or ns_state == "DEGRADED":
363 error_details = "{}\nDetail: {}".format(nsr['errorDescription'],nsr['errorDetail'])
364 else:
365 nsopdata = ctx.obj.ns.get_opdata(ns['id'])
366 nsr = nsopdata['nsr:nsr']
367 nsr_name = nsr['name-ref']
368 nsr_id = nsr['ns-instance-config-ref']
369 date = '-'
370 project = '-'
371 deployment_status = nsr['operational-status'] if 'operational-status' in nsr else 'Not found'
372 ns_state = deployment_status
373 config_status = nsr['config-status'] if 'config-status' in nsr else 'Not found'
374 current_operation = "Unknown"
375 error_details = nsr['detailed-status'] if 'detailed-status' in nsr else 'Not found'
376 if config_status == "config_not_needed":
377 config_status = "configured (no charms)"
378
379 if long:
380 table.add_row(
381 [nsr_name,
382 nsr_id,
383 date,
384 ns_state,
385 current_operation,
386 wrap_text(text=error_details,width=40),
387 project,
388 vim,
389 deployment_status,
390 config_status])
391 else:
392 table.add_row(
393 [nsr_name,
394 nsr_id,
395 date,
396 ns_state,
397 current_operation,
398 wrap_text(text=error_details,width=40)])
399 table.align = 'l'
400 print(table)
401 print('To get the history of all operations over a NS, run "osm ns-op-list NS_ID"')
402 print('For more details on the current operation, run "osm ns-op-show OPERATION_ID"')
403
404 def nsd_list(ctx, filter, long):
405 logger.debug("")
406 if filter:
407 check_client_version(ctx.obj, '--filter')
408 resp = ctx.obj.nsd.list(filter)
409 else:
410 resp = ctx.obj.nsd.list()
411 # print(yaml.safe_dump(resp))
412 fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
413 if fullclassname == 'osmclient.sol005.client.Client':
414 if long:
415 table = PrettyTable(['nsd name', 'id', 'onboarding state', 'operational state',
416 'usage state', 'date', 'last update'])
417 else:
418 table = PrettyTable(['nsd name', 'id'])
419 for nsd in resp:
420 name = nsd.get('name','-')
421 if long:
422 onb_state = nsd['_admin'].get('onboardingState','-')
423 op_state = nsd['_admin'].get('operationalState','-')
424 usage_state = nsd['_admin'].get('usageState','-')
425 date = datetime.fromtimestamp(nsd['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S")
426 last_update = datetime.fromtimestamp(nsd['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S")
427 table.add_row([name, nsd['_id'], onb_state, op_state, usage_state, date, last_update])
428 else:
429 table.add_row([name, nsd['_id']])
430 else:
431 table = PrettyTable(['nsd name', 'id'])
432 for nsd in resp:
433 table.add_row([nsd['name'], nsd['id']])
434 table.align = 'l'
435 print(table)
436
437
438 @cli_osm.command(name='nsd-list', short_help='list all NS packages')
439 @click.option('--filter', default=None,
440 help='restricts the list to the NSD/NSpkg matching the filter')
441 @click.option('--long', is_flag=True, help='get more details')
442 @click.pass_context
443 def nsd_list1(ctx, filter, long):
444 """list all NSD/NS pkg in the system"""
445 logger.debug("")
446 nsd_list(ctx, filter, long)
447
448
449 @cli_osm.command(name='nspkg-list', short_help='list all NS packages')
450 @click.option('--filter', default=None,
451 help='restricts the list to the NSD/NSpkg matching the filter')
452 @click.option('--long', is_flag=True, help='get more details')
453 @click.pass_context
454 def nsd_list2(ctx, filter, long):
455 """list all NS packages"""
456 logger.debug("")
457 nsd_list(ctx, filter, long)
458
459
460 def vnfd_list(ctx, nf_type, filter, long):
461 logger.debug("")
462 if nf_type:
463 check_client_version(ctx.obj, '--nf_type')
464 elif filter:
465 check_client_version(ctx.obj, '--filter')
466 if nf_type:
467 if nf_type == "vnf":
468 nf_filter = "_admin.type=vnfd"
469 elif nf_type == "pnf":
470 nf_filter = "_admin.type=pnfd"
471 elif nf_type == "hnf":
472 nf_filter = "_admin.type=hnfd"
473 else:
474 raise ClientException('wrong value for "--nf_type" option, allowed values: vnf, pnf, hnf')
475 if filter:
476 filter = '{}&{}'.format(nf_filter, filter)
477 else:
478 filter = nf_filter
479 if filter:
480 resp = ctx.obj.vnfd.list(filter)
481 else:
482 resp = ctx.obj.vnfd.list()
483 # print(yaml.safe_dump(resp))
484 fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
485 if fullclassname == 'osmclient.sol005.client.Client':
486 if long:
487 table = PrettyTable(['nfpkg name', 'id', 'onboarding state', 'operational state',
488 'usage state', 'date', 'last update'])
489 else:
490 table = PrettyTable(['nfpkg name', 'id'])
491 for vnfd in resp:
492 name = vnfd['name'] if 'name' in vnfd else '-'
493 if long:
494 onb_state = vnfd['_admin'].get('onboardingState','-')
495 op_state = vnfd['_admin'].get('operationalState','-')
496 usage_state = vnfd['_admin'].get('usageState','-')
497 date = datetime.fromtimestamp(vnfd['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S")
498 last_update = datetime.fromtimestamp(vnfd['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S")
499 table.add_row([name, vnfd['_id'], onb_state, op_state, usage_state, date, last_update])
500 else:
501 table.add_row([name, vnfd['_id']])
502 else:
503 table = PrettyTable(['nfpkg name', 'id'])
504 for vnfd in resp:
505 table.add_row([vnfd['name'], vnfd['id']])
506 table.align = 'l'
507 print(table)
508
509
510 @cli_osm.command(name='vnfd-list', short_help='list all xNF packages (VNF, HNF, PNF)')
511 @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)')
512 @click.option('--filter', default=None,
513 help='restricts the list to the NF pkg matching the filter')
514 @click.option('--long', is_flag=True, help='get more details')
515 @click.pass_context
516 def vnfd_list1(ctx, nf_type, filter, long):
517 """list all xNF packages (VNF, HNF, PNF)"""
518 logger.debug("")
519 vnfd_list(ctx, nf_type, filter, long)
520
521
522 @cli_osm.command(name='vnfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)')
523 @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)')
524 @click.option('--filter', default=None,
525 help='restricts the list to the NFpkg matching the filter')
526 @click.option('--long', is_flag=True, help='get more details')
527 @click.pass_context
528 def vnfd_list2(ctx, nf_type, filter, long):
529 """list all xNF packages (VNF, HNF, PNF)"""
530 logger.debug("")
531 vnfd_list(ctx, nf_type, filter, long)
532
533
534 @cli_osm.command(name='nfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)')
535 @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)')
536 @click.option('--filter', default=None,
537 help='restricts the list to the NFpkg matching the filter')
538 @click.option('--long', is_flag=True, help='get more details')
539 @click.pass_context
540 def nfpkg_list(ctx, nf_type, filter, long):
541 """list all xNF packages (VNF, HNF, PNF)"""
542 logger.debug("")
543 # try:
544 check_client_version(ctx.obj, ctx.command.name)
545 vnfd_list(ctx, nf_type, filter, long)
546 # except ClientException as e:
547 # print(str(e))
548 # exit(1)
549
550
551 def vnf_list(ctx, ns, filter, long):
552 # try:
553 if ns or filter:
554 if ns:
555 check_client_version(ctx.obj, '--ns')
556 if filter:
557 check_client_version(ctx.obj, '--filter')
558 resp = ctx.obj.vnf.list(ns, filter)
559 else:
560 resp = ctx.obj.vnf.list()
561 # except ClientException as e:
562 # print(str(e))
563 # exit(1)
564 fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
565 if fullclassname == 'osmclient.sol005.client.Client':
566 field_names = ['vnf id', 'name', 'ns id', 'vnf member index',
567 'vnfd name', 'vim account id', 'ip address']
568 if long:
569 field_names = ['vnf id', 'name', 'ns id', 'vnf member index',
570 'vnfd name', 'vim account id', 'ip address',
571 'date', 'last update']
572 table = PrettyTable(field_names)
573 for vnfr in resp:
574 name = vnfr['name'] if 'name' in vnfr else '-'
575 new_row = [vnfr['_id'], name, vnfr['nsr-id-ref'],
576 vnfr['member-vnf-index-ref'], vnfr['vnfd-ref'],
577 vnfr['vim-account-id'], vnfr['ip-address']]
578 if long:
579 date = datetime.fromtimestamp(vnfr['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S")
580 last_update = datetime.fromtimestamp(vnfr['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S")
581 new_row.extend([date, last_update])
582 table.add_row(new_row)
583 else:
584 table = PrettyTable(
585 ['vnf name',
586 'id',
587 'operational status',
588 'config status'])
589 for vnfr in resp:
590 if 'mgmt-interface' not in vnfr:
591 vnfr['mgmt-interface'] = {}
592 vnfr['mgmt-interface']['ip-address'] = None
593 table.add_row(
594 [vnfr['name'],
595 vnfr['id'],
596 vnfr['operational-status'],
597 vnfr['config-status']])
598 table.align = 'l'
599 print(table)
600
601
602 @cli_osm.command(name='vnf-list', short_help='list all NF instances')
603 @click.option('--ns', default=None, help='NS instance id or name to restrict the NF list')
604 @click.option('--filter', default=None,
605 help='restricts the list to the NF instances matching the filter.')
606 @click.option('--long', is_flag=True, help='get more details')
607 @click.pass_context
608 def vnf_list1(ctx, ns, filter, long):
609 """list all NF instances"""
610 logger.debug("")
611 vnf_list(ctx, ns, filter, long)
612
613
614 @cli_osm.command(name='nf-list', short_help='list all NF instances')
615 @click.option('--ns', default=None, help='NS instance id or name to restrict the NF list')
616 @click.option('--filter', default=None,
617 help='restricts the list to the NF instances matching the filter.')
618 @click.option('--long', is_flag=True, help='get more details')
619 @click.pass_context
620 def nf_list(ctx, ns, filter, long):
621 """list all NF instances
622
623 \b
624 Options:
625 --ns TEXT NS instance id or name to restrict the VNF list
626 --filter filterExpr Restricts the list to the VNF instances matching the filter
627
628 \b
629 filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
630 concatenated using the "&" character:
631
632 \b
633 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
634 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
635 op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
636 attrName := string
637 value := scalar value
638
639 \b
640 where:
641 * zero or more occurrences
642 ? zero or one occurrence
643 [] grouping of expressions to be used with ? and *
644 "" quotation marks for marking string constants
645 <> name separator
646
647 \b
648 "AttrName" is the name of one attribute in the data type that defines the representation
649 of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
650 <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
651 "Op" stands for the comparison operator. If the expression has concatenated <attrName>
652 entries, it means that the operator "op" is applied to the attribute addressed by the last
653 <attrName> entry included in the concatenation. All simple filter expressions are combined
654 by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
655 the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
656 concatenation of all "attrName" entries except the leaf attribute is called the "attribute
657 prefix". If an attribute referenced in an expression is an array, an object that contains a
658 corresponding array shall be considered to match the expression if any of the elements in the
659 array matches all expressions that have the same attribute prefix.
660
661 \b
662 Filter examples:
663 --filter vim-account-id=<VIM_ACCOUNT_ID>
664 --filter vnfd-ref=<VNFD_NAME>
665 --filter vdur.ip-address=<IP_ADDRESS>
666 --filter vnfd-ref=<VNFD_NAME>,vdur.ip-address=<IP_ADDRESS>
667 """
668 logger.debug("")
669 vnf_list(ctx, ns, filter)
670
671
672 @cli_osm.command(name='ns-op-list', short_help='shows the history of operations over a NS instance')
673 @click.argument('name')
674 @click.option('--long', is_flag=True,
675 help='get more details of the NS operation (date, ).')
676 @click.pass_context
677 def ns_op_list(ctx, name, long):
678 """shows the history of operations over a NS instance
679
680 NAME: name or ID of the NS instance
681 """
682 def formatParams(params):
683 if params['lcmOperationType']=='instantiate':
684 params.pop('nsDescription')
685 params.pop('nsName')
686 params.pop('nsdId')
687 params.pop('nsr_id')
688 elif params['lcmOperationType']=='action':
689 params.pop('primitive')
690 params.pop('lcmOperationType')
691 params.pop('nsInstanceId')
692 return params
693
694 logger.debug("")
695 # try:
696 check_client_version(ctx.obj, ctx.command.name)
697 resp = ctx.obj.ns.list_op(name)
698 # except ClientException as e:
699 # print(str(e))
700 # exit(1)
701
702 if long:
703 table = PrettyTable(['id', 'operation', 'action_name', 'operation_params', 'status', 'date', 'last update', 'detail'])
704 else:
705 table = PrettyTable(['id', 'operation', 'action_name', 'status', 'date', 'detail'])
706
707 #print(yaml.safe_dump(resp))
708 for op in resp:
709 action_name = "N/A"
710 if op['lcmOperationType']=='action':
711 action_name = op['operationParams']['primitive']
712 detail = "-"
713 if op['operationState']=='PROCESSING':
714 if op['lcmOperationType']=='instantiate':
715 if op['stage']:
716 detail = op['stage']
717 else:
718 detail = "In queue. Current position: {}".format(op['queuePosition'])
719 elif op['operationState']=='FAILED' or op['operationState']=='FAILED_TEMP':
720 detail = op.get('errorMessage','-')
721 date = datetime.fromtimestamp(op['startTime']).strftime("%Y-%m-%dT%H:%M:%S")
722 last_update = datetime.fromtimestamp(op['statusEnteredTime']).strftime("%Y-%m-%dT%H:%M:%S")
723 if long:
724 table.add_row([op['id'],
725 op['lcmOperationType'],
726 action_name,
727 wrap_text(text=json.dumps(formatParams(op['operationParams']),indent=2),width=50),
728 op['operationState'],
729 date,
730 last_update,
731 wrap_text(text=detail,width=50)])
732 else:
733 table.add_row([op['id'], op['lcmOperationType'], action_name,
734 op['operationState'], date, wrap_text(text=detail,width=50)])
735 table.align = 'l'
736 print(table)
737
738
739 def nsi_list(ctx, filter):
740 """list all Network Slice Instances"""
741 logger.debug("")
742 # try:
743 check_client_version(ctx.obj, ctx.command.name)
744 resp = ctx.obj.nsi.list(filter)
745 # except ClientException as e:
746 # print(str(e))
747 # exit(1)
748 table = PrettyTable(
749 ['netslice instance name',
750 'id',
751 'operational status',
752 'config status',
753 'detailed status'])
754 for nsi in resp:
755 nsi_name = nsi['name']
756 nsi_id = nsi['_id']
757 opstatus = nsi['operational-status'] if 'operational-status' in nsi else 'Not found'
758 configstatus = nsi['config-status'] if 'config-status' in nsi else 'Not found'
759 detailed_status = nsi['detailed-status'] if 'detailed-status' in nsi else 'Not found'
760 if configstatus == "config_not_needed":
761 configstatus = "configured (no charms)"
762 table.add_row(
763 [nsi_name,
764 nsi_id,
765 opstatus,
766 configstatus,
767 detailed_status])
768 table.align = 'l'
769 print(table)
770
771
772 @cli_osm.command(name='nsi-list', short_help='list all Network Slice Instances (NSI)')
773 @click.option('--filter', default=None,
774 help='restricts the list to the Network Slice Instances matching the filter')
775 @click.pass_context
776 def nsi_list1(ctx, filter):
777 """list all Network Slice Instances (NSI)"""
778 logger.debug("")
779 nsi_list(ctx, filter)
780
781
782 @cli_osm.command(name='netslice-instance-list', short_help='list all Network Slice Instances (NSI)')
783 @click.option('--filter', default=None,
784 help='restricts the list to the Network Slice Instances matching the filter')
785 @click.pass_context
786 def nsi_list2(ctx, filter):
787 """list all Network Slice Instances (NSI)"""
788 logger.debug("")
789 nsi_list(ctx, filter)
790
791
792 def nst_list(ctx, filter):
793 logger.debug("")
794 # try:
795 check_client_version(ctx.obj, ctx.command.name)
796 resp = ctx.obj.nst.list(filter)
797 # except ClientException as e:
798 # print(str(e))
799 # exit(1)
800 # print(yaml.safe_dump(resp))
801 table = PrettyTable(['nst name', 'id'])
802 for nst in resp:
803 name = nst['name'] if 'name' in nst else '-'
804 table.add_row([name, nst['_id']])
805 table.align = 'l'
806 print(table)
807
808
809 @cli_osm.command(name='nst-list', short_help='list all Network Slice Templates (NST)')
810 @click.option('--filter', default=None,
811 help='restricts the list to the NST matching the filter')
812 @click.pass_context
813 def nst_list1(ctx, filter):
814 """list all Network Slice Templates (NST) in the system"""
815 logger.debug("")
816 nst_list(ctx, filter)
817
818
819 @cli_osm.command(name='netslice-template-list', short_help='list all Network Slice Templates (NST)')
820 @click.option('--filter', default=None,
821 help='restricts the list to the NST matching the filter')
822 @click.pass_context
823 def nst_list2(ctx, filter):
824 """list all Network Slice Templates (NST) in the system"""
825 logger.debug("")
826 nst_list(ctx, filter)
827
828
829 def nsi_op_list(ctx, name):
830 logger.debug("")
831 # try:
832 check_client_version(ctx.obj, ctx.command.name)
833 resp = ctx.obj.nsi.list_op(name)
834 # except ClientException as e:
835 # print(str(e))
836 # exit(1)
837 table = PrettyTable(['id', 'operation', 'status'])
838 for op in resp:
839 table.add_row([op['id'], op['lcmOperationType'],
840 op['operationState']])
841 table.align = 'l'
842 print(table)
843
844
845 @cli_osm.command(name='nsi-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)')
846 @click.argument('name')
847 @click.pass_context
848 def nsi_op_list1(ctx, name):
849 """shows the history of operations over a Network Slice Instance (NSI)
850
851 NAME: name or ID of the Network Slice Instance
852 """
853 logger.debug("")
854 nsi_op_list(ctx, name)
855
856
857 @cli_osm.command(name='netslice-instance-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)')
858 @click.argument('name')
859 @click.pass_context
860 def nsi_op_list2(ctx, name):
861 """shows the history of operations over a Network Slice Instance (NSI)
862
863 NAME: name or ID of the Network Slice Instance
864 """
865 logger.debug("")
866 nsi_op_list(ctx, name)
867
868
869 @cli_osm.command(name='pdu-list', short_help='list all Physical Deployment Units (PDU)')
870 @click.option('--filter', default=None,
871 help='restricts the list to the Physical Deployment Units matching the filter')
872 @click.pass_context
873 def pdu_list(ctx, filter):
874 """list all Physical Deployment Units (PDU)"""
875 logger.debug("")
876 # try:
877 check_client_version(ctx.obj, ctx.command.name)
878 resp = ctx.obj.pdu.list(filter)
879 # except ClientException as e:
880 # print(str(e))
881 # exit(1)
882 table = PrettyTable(
883 ['pdu name',
884 'id',
885 'type',
886 'mgmt ip address'])
887 for pdu in resp:
888 pdu_name = pdu['name']
889 pdu_id = pdu['_id']
890 pdu_type = pdu['type']
891 pdu_ipaddress = "None"
892 for iface in pdu['interfaces']:
893 if iface['mgmt']:
894 pdu_ipaddress = iface['ip-address']
895 break
896 table.add_row(
897 [pdu_name,
898 pdu_id,
899 pdu_type,
900 pdu_ipaddress])
901 table.align = 'l'
902 print(table)
903
904
905 ####################
906 # SHOW operations
907 ####################
908
909 def nsd_show(ctx, name, literal):
910 logger.debug("")
911 # try:
912 resp = ctx.obj.nsd.get(name)
913 # resp = ctx.obj.nsd.get_individual(name)
914 # except ClientException as e:
915 # print(str(e))
916 # exit(1)
917
918 if literal:
919 print(yaml.safe_dump(resp))
920 return
921
922 table = PrettyTable(['field', 'value'])
923 for k, v in list(resp.items()):
924 table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)])
925 table.align = 'l'
926 print(table)
927
928
929 @cli_osm.command(name='nsd-show', short_help='shows the content of a NSD')
930 @click.option('--literal', is_flag=True,
931 help='print literally, no pretty table')
932 @click.argument('name')
933 @click.pass_context
934 def nsd_show1(ctx, name, literal):
935 """shows the content of a NSD
936
937 NAME: name or ID of the NSD/NSpkg
938 """
939 logger.debug("")
940 nsd_show(ctx, name, literal)
941
942
943 @cli_osm.command(name='nspkg-show', short_help='shows the content of a NSD')
944 @click.option('--literal', is_flag=True,
945 help='print literally, no pretty table')
946 @click.argument('name')
947 @click.pass_context
948 def nsd_show2(ctx, name, literal):
949 """shows the content of a NSD
950
951 NAME: name or ID of the NSD/NSpkg
952 """
953 logger.debug("")
954 nsd_show(ctx, name, literal)
955
956
957 def vnfd_show(ctx, name, literal):
958 logger.debug("")
959 # try:
960 resp = ctx.obj.vnfd.get(name)
961 # resp = ctx.obj.vnfd.get_individual(name)
962 # except ClientException as e:
963 # print(str(e))
964 # exit(1)
965
966 if literal:
967 print(yaml.safe_dump(resp))
968 return
969
970 table = PrettyTable(['field', 'value'])
971 for k, v in list(resp.items()):
972 table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)])
973 table.align = 'l'
974 print(table)
975
976
977 @cli_osm.command(name='vnfd-show', short_help='shows the content of a VNFD')
978 @click.option('--literal', is_flag=True,
979 help='print literally, no pretty table')
980 @click.argument('name')
981 @click.pass_context
982 def vnfd_show1(ctx, name, literal):
983 """shows the content of a VNFD
984
985 NAME: name or ID of the VNFD/VNFpkg
986 """
987 logger.debug("")
988 vnfd_show(ctx, name, literal)
989
990
991 @cli_osm.command(name='vnfpkg-show', short_help='shows the content of a VNFD')
992 @click.option('--literal', is_flag=True,
993 help='print literally, no pretty table')
994 @click.argument('name')
995 @click.pass_context
996 def vnfd_show2(ctx, name, literal):
997 """shows the content of a VNFD
998
999 NAME: name or ID of the VNFD/VNFpkg
1000 """
1001 logger.debug("")
1002 vnfd_show(ctx, name, literal)
1003
1004
1005 @cli_osm.command(name='nfpkg-show', short_help='shows the content of a NF Descriptor')
1006 @click.option('--literal', is_flag=True,
1007 help='print literally, no pretty table')
1008 @click.argument('name')
1009 @click.pass_context
1010 def nfpkg_show(ctx, name, literal):
1011 """shows the content of a NF Descriptor
1012
1013 NAME: name or ID of the NFpkg
1014 """
1015 logger.debug("")
1016 vnfd_show(ctx, name, literal)
1017
1018
1019 @cli_osm.command(name='ns-show', short_help='shows the info of a NS instance')
1020 @click.argument('name')
1021 @click.option('--literal', is_flag=True,
1022 help='print literally, no pretty table')
1023 @click.option('--filter', default=None)
1024 @click.pass_context
1025 def ns_show(ctx, name, literal, filter):
1026 """shows the info of a NS instance
1027
1028 NAME: name or ID of the NS instance
1029 """
1030 logger.debug("")
1031 # try:
1032 ns = ctx.obj.ns.get(name)
1033 # except ClientException as e:
1034 # print(str(e))
1035 # exit(1)
1036
1037 if literal:
1038 print(yaml.safe_dump(ns))
1039 return
1040
1041 table = PrettyTable(['field', 'value'])
1042
1043 for k, v in list(ns.items()):
1044 if filter is None or filter in k:
1045 table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)])
1046
1047 fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
1048 if fullclassname != 'osmclient.sol005.client.Client':
1049 nsopdata = ctx.obj.ns.get_opdata(ns['id'])
1050 nsr_optdata = nsopdata['nsr:nsr']
1051 for k, v in list(nsr_optdata.items()):
1052 if filter is None or filter in k:
1053 table.add_row([k, wrap_text(json.dumps(v, indent=2),width=100)])
1054 table.align = 'l'
1055 print(table)
1056
1057
1058 @cli_osm.command(name='vnf-show', short_help='shows the info of a VNF instance')
1059 @click.argument('name')
1060 @click.option('--literal', is_flag=True,
1061 help='print literally, no pretty table')
1062 @click.option('--filter', default=None, help='restricts the information to the fields in the filter')
1063 @click.option('--kdu', default=None, help='KDU name (whose status will be shown)')
1064 @click.pass_context
1065 def vnf_show(ctx, name, literal, filter, kdu):
1066 """shows the info of a VNF instance
1067
1068 NAME: name or ID of the VNF instance
1069 """
1070 def print_kdu_status(op_info_status):
1071 """print KDU status properly formatted
1072 """
1073 try:
1074 op_status = yaml.safe_load(op_info_status)
1075 if "namespace" in op_status and "info" in op_status and \
1076 "last_deployed" in op_status["info"] and "status" in op_status["info"] and \
1077 "code" in op_status["info"]["status"] and "resources" in op_status["info"]["status"] and \
1078 "seconds" in op_status["info"]["last_deployed"]:
1079 last_deployed_time = datetime.fromtimestamp(op_status["info"]["last_deployed"]["seconds"]).strftime("%a %b %d %I:%M:%S %Y")
1080 print("LAST DEPLOYED: {}".format(last_deployed_time))
1081 print("NAMESPACE: {}".format(op_status["namespace"]))
1082 status_code = "UNKNOWN"
1083 if op_status["info"]["status"]["code"]==1:
1084 status_code = "DEPLOYED"
1085 print("STATUS: {}".format(status_code))
1086 print()
1087 print("RESOURCES:")
1088 print(op_status["info"]["status"]["resources"])
1089 if "notes" in op_status["info"]["status"]:
1090 print("NOTES:")
1091 print(op_status["info"]["status"]["notes"])
1092 else:
1093 print(op_info_status)
1094 except Exception:
1095 print(op_info_status)
1096
1097 logger.debug("")
1098 if kdu:
1099 if literal:
1100 raise ClientException('"--literal" option is incompatible with "--kdu" option')
1101 if filter:
1102 raise ClientException('"--filter" option is incompatible with "--kdu" option')
1103
1104 # try:
1105 check_client_version(ctx.obj, ctx.command.name)
1106 resp = ctx.obj.vnf.get(name)
1107
1108 if kdu:
1109 ns_id = resp['nsr-id-ref']
1110 op_data={}
1111 op_data['member_vnf_index'] = resp['member-vnf-index-ref']
1112 op_data['kdu_name'] = kdu
1113 op_data['primitive'] = 'status'
1114 op_data['primitive_params'] = {}
1115 op_id = ctx.obj.ns.exec_op(ns_id, op_name='action', op_data=op_data, wait=False)
1116 t = 0
1117 while t<30:
1118 op_info = ctx.obj.ns.get_op(op_id)
1119 if op_info['operationState'] == 'COMPLETED':
1120 print_kdu_status(op_info['detailed-status'])
1121 return
1122 time.sleep(5)
1123 t += 5
1124 print ("Could not determine KDU status")
1125
1126 if literal:
1127 print(yaml.safe_dump(resp))
1128 return
1129
1130 table = PrettyTable(['field', 'value'])
1131
1132 for k, v in list(resp.items()):
1133 if filter is None or filter in k:
1134 table.add_row([k, wrap_text(text=json.dumps(v,indent=2),width=100)])
1135 table.align = 'l'
1136 print(table)
1137 # except ClientException as e:
1138 # print(str(e))
1139 # exit(1)
1140
1141
1142 #@cli_osm.command(name='vnf-monitoring-show')
1143 #@click.argument('vnf_name')
1144 #@click.pass_context
1145 #def vnf_monitoring_show(ctx, vnf_name):
1146 # try:
1147 # check_client_version(ctx.obj, ctx.command.name, 'v1')
1148 # resp = ctx.obj.vnf.get_monitoring(vnf_name)
1149 # except ClientException as e:
1150 # print(str(e))
1151 # exit(1)
1152 #
1153 # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
1154 # if resp is not None:
1155 # for monitor in resp:
1156 # table.add_row(
1157 # [vnf_name,
1158 # monitor['name'],
1159 # monitor['value-integer'],
1160 # monitor['units']])
1161 # table.align = 'l'
1162 # print(table)
1163
1164
1165 #@cli_osm.command(name='ns-monitoring-show')
1166 #@click.argument('ns_name')
1167 #@click.pass_context
1168 #def ns_monitoring_show(ctx, ns_name):
1169 # try:
1170 # check_client_version(ctx.obj, ctx.command.name, 'v1')
1171 # resp = ctx.obj.ns.get_monitoring(ns_name)
1172 # except ClientException as e:
1173 # print(str(e))
1174 # exit(1)
1175 #
1176 # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
1177 # for key, val in list(resp.items()):
1178 # for monitor in val:
1179 # table.add_row(
1180 # [key,
1181 # monitor['name'],
1182 # monitor['value-integer'],
1183 # monitor['units']])
1184 # table.align = 'l'
1185 # print(table)
1186
1187
1188 @cli_osm.command(name='ns-op-show', short_help='shows the info of a NS operation')
1189 @click.argument('id')
1190 @click.option('--filter', default=None)
1191 @click.option('--literal', is_flag=True,
1192 help='print literally, no pretty table')
1193 @click.pass_context
1194 def ns_op_show(ctx, id, filter, literal):
1195 """shows the detailed info of a NS operation
1196
1197 ID: operation identifier
1198 """
1199 logger.debug("")
1200 # try:
1201 check_client_version(ctx.obj, ctx.command.name)
1202 op_info = ctx.obj.ns.get_op(id)
1203 # except ClientException as e:
1204 # print(str(e))
1205 # exit(1)
1206
1207 if literal:
1208 print(yaml.safe_dump(op_info))
1209 return
1210
1211 table = PrettyTable(['field', 'value'])
1212 for k, v in list(op_info.items()):
1213 if filter is None or filter in k:
1214 table.add_row([k, wrap_text(json.dumps(v, indent=2), 100)])
1215 table.align = 'l'
1216 print(table)
1217
1218
1219 def nst_show(ctx, name, literal):
1220 logger.debug("")
1221 # try:
1222 check_client_version(ctx.obj, ctx.command.name)
1223 resp = ctx.obj.nst.get(name)
1224 #resp = ctx.obj.nst.get_individual(name)
1225 # except ClientException as e:
1226 # print(str(e))
1227 # exit(1)
1228
1229 if literal:
1230 print(yaml.safe_dump(resp))
1231 return
1232
1233 table = PrettyTable(['field', 'value'])
1234 for k, v in list(resp.items()):
1235 table.add_row([k, wrap_text(json.dumps(v, indent=2), 100)])
1236 table.align = 'l'
1237 print(table)
1238
1239
1240 @cli_osm.command(name='nst-show', short_help='shows the content of a Network Slice Template (NST)')
1241 @click.option('--literal', is_flag=True,
1242 help='print literally, no pretty table')
1243 @click.argument('name')
1244 @click.pass_context
1245 def nst_show1(ctx, name, literal):
1246 """shows the content of a Network Slice Template (NST)
1247
1248 NAME: name or ID of the NST
1249 """
1250 logger.debug("")
1251 nst_show(ctx, name, literal)
1252
1253
1254 @cli_osm.command(name='netslice-template-show', short_help='shows the content of a Network Slice Template (NST)')
1255 @click.option('--literal', is_flag=True,
1256 help='print literally, no pretty table')
1257 @click.argument('name')
1258 @click.pass_context
1259 def nst_show2(ctx, name, literal):
1260 """shows the content of a Network Slice Template (NST)
1261
1262 NAME: name or ID of the NST
1263 """
1264 logger.debug("")
1265 nst_show(ctx, name, literal)
1266
1267
1268 def nsi_show(ctx, name, literal, filter):
1269 logger.debug("")
1270 # try:
1271 check_client_version(ctx.obj, ctx.command.name)
1272 nsi = ctx.obj.nsi.get(name)
1273 # except ClientException as e:
1274 # print(str(e))
1275 # exit(1)
1276
1277 if literal:
1278 print(yaml.safe_dump(nsi))
1279 return
1280
1281 table = PrettyTable(['field', 'value'])
1282
1283 for k, v in list(nsi.items()):
1284 if filter is None or filter in k:
1285 table.add_row([k, json.dumps(v, indent=2)])
1286
1287 table.align = 'l'
1288 print(table)
1289
1290
1291 @cli_osm.command(name='nsi-show', short_help='shows the content of a Network Slice Instance (NSI)')
1292 @click.argument('name')
1293 @click.option('--literal', is_flag=True,
1294 help='print literally, no pretty table')
1295 @click.option('--filter', default=None)
1296 @click.pass_context
1297 def nsi_show1(ctx, name, literal, filter):
1298 """shows the content of a Network Slice Instance (NSI)
1299
1300 NAME: name or ID of the Network Slice Instance
1301 """
1302 logger.debug("")
1303 nsi_show(ctx, name, literal, filter)
1304
1305
1306 @cli_osm.command(name='netslice-instance-show', short_help='shows the content of a Network Slice Instance (NSI)')
1307 @click.argument('name')
1308 @click.option('--literal', is_flag=True,
1309 help='print literally, no pretty table')
1310 @click.option('--filter', default=None)
1311 @click.pass_context
1312 def nsi_show2(ctx, name, literal, filter):
1313 """shows the content of a Network Slice Instance (NSI)
1314
1315 NAME: name or ID of the Network Slice Instance
1316 """
1317 logger.debug("")
1318 nsi_show(ctx, name, literal, filter)
1319
1320
1321 def nsi_op_show(ctx, id, filter):
1322 logger.debug("")
1323 # try:
1324 check_client_version(ctx.obj, ctx.command.name)
1325 op_info = ctx.obj.nsi.get_op(id)
1326 # except ClientException as e:
1327 # print(str(e))
1328 # exit(1)
1329
1330 table = PrettyTable(['field', 'value'])
1331 for k, v in list(op_info.items()):
1332 if filter is None or filter in k:
1333 table.add_row([k, json.dumps(v, indent=2)])
1334 table.align = 'l'
1335 print(table)
1336
1337
1338 @cli_osm.command(name='nsi-op-show', short_help='shows the info of an operation over a Network Slice Instance(NSI)')
1339 @click.argument('id')
1340 @click.option('--filter', default=None)
1341 @click.pass_context
1342 def nsi_op_show1(ctx, id, filter):
1343 """shows the info of an operation over a Network Slice Instance(NSI)
1344
1345 ID: operation identifier
1346 """
1347 logger.debug("")
1348 nsi_op_show(ctx, id, filter)
1349
1350
1351 @cli_osm.command(name='netslice-instance-op-show', short_help='shows the info of an operation over a Network Slice Instance(NSI)')
1352 @click.argument('id')
1353 @click.option('--filter', default=None)
1354 @click.pass_context
1355 def nsi_op_show2(ctx, id, filter):
1356 """shows the info of an operation over a Network Slice Instance(NSI)
1357
1358 ID: operation identifier
1359 """
1360 logger.debug("")
1361 nsi_op_show(ctx, id, filter)
1362
1363
1364 @cli_osm.command(name='pdu-show', short_help='shows the content of a Physical Deployment Unit (PDU)')
1365 @click.argument('name')
1366 @click.option('--literal', is_flag=True,
1367 help='print literally, no pretty table')
1368 @click.option('--filter', default=None)
1369 @click.pass_context
1370 def pdu_show(ctx, name, literal, filter):
1371 """shows the content of a Physical Deployment Unit (PDU)
1372
1373 NAME: name or ID of the PDU
1374 """
1375 logger.debug("")
1376 # try:
1377 check_client_version(ctx.obj, ctx.command.name)
1378 pdu = ctx.obj.pdu.get(name)
1379 # except ClientException as e:
1380 # print(str(e))
1381 # exit(1)
1382
1383 if literal:
1384 print(yaml.safe_dump(pdu))
1385 return
1386
1387 table = PrettyTable(['field', 'value'])
1388
1389 for k, v in list(pdu.items()):
1390 if filter is None or filter in k:
1391 table.add_row([k, json.dumps(v, indent=2)])
1392
1393 table.align = 'l'
1394 print(table)
1395
1396
1397 ####################
1398 # CREATE operations
1399 ####################
1400
1401 def nsd_create(ctx, filename, overwrite, skip_charm_build):
1402 logger.debug("")
1403 # try:
1404 check_client_version(ctx.obj, ctx.command.name)
1405 ctx.obj.nsd.create(filename, overwrite=overwrite, skip_charm_build=skip_charm_build)
1406 # except ClientException as e:
1407 # print(str(e))
1408 # exit(1)
1409
1410
1411 @cli_osm.command(name='nsd-create', short_help='creates a new NSD/NSpkg')
1412 @click.argument('filename')
1413 @click.option('--overwrite', 'overwrite', default=None, # hidden=True,
1414 help='Deprecated. Use override')
1415 @click.option('--override', 'overwrite', default=None,
1416 help='overrides fields in descriptor, format: '
1417 '"key1.key2...=value[;key3...=value;...]"')
1418 @click.option('--skip-charm-build', default=False, is_flag=True,
1419 help='The charm will not be compiled, it is assumed to already exist')
1420 @click.pass_context
1421 def nsd_create1(ctx, filename, overwrite, skip_charm_build):
1422 """creates a new NSD/NSpkg
1423
1424 FILENAME: NSD yaml file or NSpkg tar.gz file
1425 """
1426 logger.debug("")
1427 nsd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build)
1428
1429
1430 @cli_osm.command(name='nspkg-create', short_help='creates a new NSD/NSpkg')
1431 @click.argument('filename')
1432 @click.option('--overwrite', 'overwrite', default=None, # hidden=True,
1433 help='Deprecated. Use override')
1434 @click.option('--override', 'overwrite', default=None,
1435 help='overrides fields in descriptor, format: '
1436 '"key1.key2...=value[;key3...=value;...]"')
1437 @click.option('--skip-charm-build', default=False, is_flag=True,
1438 help='The charm will not be compiled, it is assumed to already exist')
1439 @click.pass_context
1440 def nsd_create2(ctx, filename, overwrite, skip_charm_build):
1441 """creates a new NSD/NSpkg
1442
1443 FILENAME: NSD folder, NSD yaml file or NSpkg tar.gz file
1444 """
1445 logger.debug("")
1446 nsd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build)
1447
1448
1449 def vnfd_create(ctx, filename, overwrite, skip_charm_build):
1450 logger.debug("")
1451 # try:
1452 check_client_version(ctx.obj, ctx.command.name)
1453 ctx.obj.vnfd.create(filename, overwrite=overwrite, skip_charm_build=skip_charm_build)
1454 # except ClientException as e:
1455 # print(str(e))
1456 # exit(1)
1457
1458
1459 @cli_osm.command(name='vnfd-create', short_help='creates a new VNFD/VNFpkg')
1460 @click.argument('filename')
1461 @click.option('--overwrite', 'overwrite', default=None,
1462 help='overwrite deprecated, use override')
1463 @click.option('--override', 'overwrite', default=None,
1464 help='overrides fields in descriptor, format: '
1465 '"key1.key2...=value[;key3...=value;...]"')
1466 @click.option('--skip-charm-build', default=False, is_flag=True,
1467 help='The charm will not be compiled, it is assumed to already exist')
1468 @click.pass_context
1469 def vnfd_create1(ctx, filename, overwrite, skip_charm_build):
1470 """creates a new VNFD/VNFpkg
1471
1472 FILENAME: VNFD yaml file or VNFpkg tar.gz file
1473 """
1474 logger.debug("")
1475 vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build)
1476
1477
1478 @cli_osm.command(name='vnfpkg-create', short_help='creates a new VNFD/VNFpkg')
1479 @click.argument('filename')
1480 @click.option('--overwrite', 'overwrite', default=None, # hidden=True,
1481 help='Deprecated. Use override')
1482 @click.option('--override', 'overwrite', default=None,
1483 help='overrides fields in descriptor, format: '
1484 '"key1.key2...=value[;key3...=value;...]"')
1485 @click.option('--skip-charm-build', default=False, is_flag=True,
1486 help='The charm will not be compiled, it is assumed to already exist')
1487 @click.pass_context
1488 def vnfd_create2(ctx, filename, overwrite, skip_charm_build):
1489 """creates a new VNFD/VNFpkg
1490
1491 FILENAME: NF Package Folder, NF Descriptor yaml file or NFpkg tar.gz file
1492 """
1493 logger.debug("")
1494 vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build)
1495
1496
1497 @cli_osm.command(name='nfpkg-create', short_help='creates a new NFpkg')
1498 @click.argument('filename')
1499 @click.option('--overwrite', 'overwrite', default=None, # hidden=True,
1500 help='Deprecated. Use override')
1501 @click.option('--override', 'overwrite', default=None,
1502 help='overrides fields in descriptor, format: '
1503 '"key1.key2...=value[;key3...=value;...]"')
1504 @click.option('--skip-charm-build', default=False, is_flag=True,
1505 help='The charm will not be compiled, it is assumed to already exist')
1506 @click.pass_context
1507 def nfpkg_create(ctx, filename, overwrite, skip_charm_build):
1508 """creates a new NFpkg
1509
1510 FILENAME: NF Package Folder, NF Descriptor yaml file or NFpkg tar.gz filems to build
1511 """
1512 logger.debug("")
1513 vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build)
1514
1515
1516 @cli_osm.command(name='ns-create', short_help='creates a new Network Service instance')
1517 @click.option('--ns_name',
1518 prompt=True, help='name of the NS instance')
1519 @click.option('--nsd_name',
1520 prompt=True, help='name of the NS descriptor')
1521 @click.option('--vim_account',
1522 prompt=True, help='default VIM account id or name for the deployment')
1523 @click.option('--admin_status',
1524 default='ENABLED',
1525 help='administration status')
1526 @click.option('--ssh_keys',
1527 default=None,
1528 help='comma separated list of public key files to inject to vnfs')
1529 @click.option('--config',
1530 default=None,
1531 help='ns specific yaml configuration')
1532 @click.option('--config_file',
1533 default=None,
1534 help='ns specific yaml configuration file')
1535 @click.option('--wait',
1536 required=False,
1537 default=False,
1538 is_flag=True,
1539 help='do not return the control immediately, but keep it '
1540 'until the operation is completed, or timeout')
1541 @click.pass_context
1542 def ns_create(ctx,
1543 nsd_name,
1544 ns_name,
1545 vim_account,
1546 admin_status,
1547 ssh_keys,
1548 config,
1549 config_file,
1550 wait):
1551 """creates a new NS instance"""
1552 logger.debug("")
1553 # try:
1554 if config_file:
1555 check_client_version(ctx.obj, '--config_file')
1556 if config:
1557 raise ClientException('"--config" option is incompatible with "--config_file" option')
1558 with open(config_file, 'r') as cf:
1559 config=cf.read()
1560 ctx.obj.ns.create(
1561 nsd_name,
1562 ns_name,
1563 config=config,
1564 ssh_keys=ssh_keys,
1565 account=vim_account,
1566 wait=wait)
1567 # except ClientException as e:
1568 # print(str(e))
1569 # exit(1)
1570
1571
1572 def nst_create(ctx, filename, overwrite):
1573 logger.debug("")
1574 # try:
1575 check_client_version(ctx.obj, ctx.command.name)
1576 ctx.obj.nst.create(filename, overwrite)
1577 # except ClientException as e:
1578 # print(str(e))
1579 # exit(1)
1580
1581
1582 @cli_osm.command(name='nst-create', short_help='creates a new Network Slice Template (NST)')
1583 @click.argument('filename')
1584 @click.option('--overwrite', 'overwrite', default=None, # hidden=True,
1585 help='Deprecated. Use override')
1586 @click.option('--override', 'overwrite', default=None,
1587 help='overrides fields in descriptor, format: '
1588 '"key1.key2...=value[;key3...=value;...]"')
1589 @click.pass_context
1590 def nst_create1(ctx, charm_folder, overwrite):
1591 """creates a new Network Slice Template (NST)
1592
1593 FILENAME: NST package folder, NST yaml file or NSTpkg tar.gz file
1594 """
1595 logger.debug("")
1596 nst_create(ctx, charm_folder, overwrite)
1597
1598
1599 @cli_osm.command(name='netslice-template-create', short_help='creates a new Network Slice Template (NST)')
1600 @click.argument('filename')
1601 @click.option('--overwrite', 'overwrite', default=None, # hidden=True,
1602 help='Deprecated. Use override')
1603 @click.option('--override', 'overwrite', default=None,
1604 help='overrides fields in descriptor, format: '
1605 '"key1.key2...=value[;key3...=value;...]"')
1606 @click.pass_context
1607 def nst_create2(ctx, filename, overwrite):
1608 """creates a new Network Slice Template (NST)
1609
1610 FILENAME: NST yaml file or NSTpkg tar.gz file
1611 """
1612 logger.debug("")
1613 nst_create(ctx, filename, overwrite)
1614
1615
1616 def nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait):
1617 """creates a new Network Slice Instance (NSI)"""
1618 logger.debug("")
1619 # try:
1620 check_client_version(ctx.obj, ctx.command.name)
1621 if config_file:
1622 if config:
1623 raise ClientException('"--config" option is incompatible with "--config_file" option')
1624 with open(config_file, 'r') as cf:
1625 config=cf.read()
1626 ctx.obj.nsi.create(nst_name, nsi_name, config=config, ssh_keys=ssh_keys,
1627 account=vim_account, wait=wait)
1628 # except ClientException as e:
1629 # print(str(e))
1630 # exit(1)
1631
1632
1633 @cli_osm.command(name='nsi-create', short_help='creates a new Network Slice Instance')
1634 @click.option('--nsi_name', prompt=True, help='name of the Network Slice Instance')
1635 @click.option('--nst_name', prompt=True, help='name of the Network Slice Template')
1636 @click.option('--vim_account', prompt=True, help='default VIM account id or name for the deployment')
1637 @click.option('--ssh_keys', default=None,
1638 help='comma separated list of keys to inject to vnfs')
1639 @click.option('--config', default=None,
1640 help='Netslice specific yaml configuration:\n'
1641 'netslice_subnet: [\n'
1642 'id: TEXT, vim_account: TEXT,\n'
1643 'vnf: [member-vnf-index: TEXT, vim_account: TEXT]\n'
1644 'vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]\n'
1645 'additionalParamsForNsi: {param: value, ...}\n'
1646 'additionalParamsForsubnet: [{id: SUBNET_ID, additionalParamsForNs: {}, additionalParamsForVnf: {}}]\n'
1647 '],\n'
1648 'netslice-vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]'
1649 )
1650 @click.option('--config_file',
1651 default=None,
1652 help='nsi specific yaml configuration file')
1653 @click.option('--wait',
1654 required=False,
1655 default=False,
1656 is_flag=True,
1657 help='do not return the control immediately, but keep it '
1658 'until the operation is completed, or timeout')
1659 @click.pass_context
1660 def nsi_create1(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait):
1661 """creates a new Network Slice Instance (NSI)"""
1662 logger.debug("")
1663 nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait=wait)
1664
1665
1666 @cli_osm.command(name='netslice-instance-create', short_help='creates a new Network Slice Instance')
1667 @click.option('--nsi_name', prompt=True, help='name of the Network Slice Instance')
1668 @click.option('--nst_name', prompt=True, help='name of the Network Slice Template')
1669 @click.option('--vim_account', prompt=True, help='default VIM account id or name for the deployment')
1670 @click.option('--ssh_keys', default=None,
1671 help='comma separated list of keys to inject to vnfs')
1672 @click.option('--config', default=None,
1673 help='Netslice specific yaml configuration:\n'
1674 'netslice_subnet: [\n'
1675 'id: TEXT, vim_account: TEXT,\n'
1676 'vnf: [member-vnf-index: TEXT, vim_account: TEXT]\n'
1677 'vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]'
1678 '],\n'
1679 'netslice-vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]'
1680 )
1681 @click.option('--config_file',
1682 default=None,
1683 help='nsi specific yaml configuration file')
1684 @click.option('--wait',
1685 required=False,
1686 default=False,
1687 is_flag=True,
1688 help='do not return the control immediately, but keep it '
1689 'until the operation is completed, or timeout')
1690 @click.pass_context
1691 def nsi_create2(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait):
1692 """creates a new Network Slice Instance (NSI)"""
1693 logger.debug("")
1694 nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait=wait)
1695
1696
1697 @cli_osm.command(name='pdu-create', short_help='adds a new Physical Deployment Unit to the catalog')
1698 @click.option('--name', help='name of the Physical Deployment Unit')
1699 @click.option('--pdu_type', help='type of PDU (e.g. router, firewall, FW001)')
1700 @click.option('--interface',
1701 help='interface(s) of the PDU: name=<NAME>,mgmt=<true|false>,ip-address=<IP_ADDRESS>'+
1702 '[,type=<overlay|underlay>][,mac-address=<MAC_ADDRESS>][,vim-network-name=<VIM_NET_NAME>]',
1703 multiple=True)
1704 @click.option('--description', help='human readable description')
1705 @click.option('--vim_account', help='list of VIM accounts (in the same VIM) that can reach this PDU', multiple=True)
1706 @click.option('--descriptor_file', default=None,
1707 help='PDU descriptor file (as an alternative to using the other arguments')
1708 @click.pass_context
1709 def pdu_create(ctx, name, pdu_type, interface, description, vim_account, descriptor_file):
1710 """creates a new Physical Deployment Unit (PDU)"""
1711 logger.debug("")
1712 # try:
1713 check_client_version(ctx.obj, ctx.command.name)
1714 pdu = {}
1715 if not descriptor_file:
1716 if not name:
1717 raise ClientException('in absence of descriptor file, option "--name" is mandatory')
1718 if not pdu_type:
1719 raise ClientException('in absence of descriptor file, option "--pdu_type" is mandatory')
1720 if not interface:
1721 raise ClientException('in absence of descriptor file, option "--interface" is mandatory (at least once)')
1722 if not vim_account:
1723 raise ClientException('in absence of descriptor file, option "--vim_account" is mandatory (at least once)')
1724 else:
1725 with open(descriptor_file, 'r') as df:
1726 pdu = yaml.safe_load(df.read())
1727 if name: pdu["name"] = name
1728 if pdu_type: pdu["type"] = pdu_type
1729 if description: pdu["description"] = description
1730 if vim_account: pdu["vim_accounts"] = vim_account
1731 if interface:
1732 ifaces_list = []
1733 for iface in interface:
1734 new_iface={k:v for k,v in [i.split('=') for i in iface.split(',')]}
1735 new_iface["mgmt"] = (new_iface.get("mgmt","false").lower() == "true")
1736 ifaces_list.append(new_iface)
1737 pdu["interfaces"] = ifaces_list
1738 ctx.obj.pdu.create(pdu)
1739 # except ClientException as e:
1740 # print(str(e))
1741 # exit(1)
1742
1743
1744 ####################
1745 # UPDATE operations
1746 ####################
1747
1748 def nsd_update(ctx, name, content):
1749 logger.debug("")
1750 # try:
1751 check_client_version(ctx.obj, ctx.command.name)
1752 ctx.obj.nsd.update(name, content)
1753 # except ClientException as e:
1754 # print(str(e))
1755 # exit(1)
1756
1757
1758 @cli_osm.command(name='nsd-update', short_help='updates a NSD/NSpkg')
1759 @click.argument('name')
1760 @click.option('--content', default=None,
1761 help='filename with the NSD/NSpkg replacing the current one')
1762 @click.pass_context
1763 def nsd_update1(ctx, name, content):
1764 """updates a NSD/NSpkg
1765
1766 NAME: name or ID of the NSD/NSpkg
1767 """
1768 logger.debug("")
1769 nsd_update(ctx, name, content)
1770
1771
1772 @cli_osm.command(name='nspkg-update', short_help='updates a NSD/NSpkg')
1773 @click.argument('name')
1774 @click.option('--content', default=None,
1775 help='filename with the NSD/NSpkg replacing the current one')
1776 @click.pass_context
1777 def nsd_update2(ctx, name, content):
1778 """updates a NSD/NSpkg
1779
1780 NAME: name or ID of the NSD/NSpkg
1781 """
1782 logger.debug("")
1783 nsd_update(ctx, name, content)
1784
1785
1786 def vnfd_update(ctx, name, content):
1787 logger.debug("")
1788 # try:
1789 check_client_version(ctx.obj, ctx.command.name)
1790 ctx.obj.vnfd.update(name, content)
1791 # except ClientException as e:
1792 # print(str(e))
1793 # exit(1)
1794
1795
1796 @cli_osm.command(name='vnfd-update', short_help='updates a new VNFD/VNFpkg')
1797 @click.argument('name')
1798 @click.option('--content', default=None,
1799 help='filename with the VNFD/VNFpkg replacing the current one')
1800 @click.pass_context
1801 def vnfd_update1(ctx, name, content):
1802 """updates a VNFD/VNFpkg
1803
1804 NAME: name or ID of the VNFD/VNFpkg
1805 """
1806 logger.debug("")
1807 vnfd_update(ctx, name, content)
1808
1809
1810 @cli_osm.command(name='vnfpkg-update', short_help='updates a VNFD/VNFpkg')
1811 @click.argument('name')
1812 @click.option('--content', default=None,
1813 help='filename with the VNFD/VNFpkg replacing the current one')
1814 @click.pass_context
1815 def vnfd_update2(ctx, name, content):
1816 """updates a VNFD/VNFpkg
1817
1818 NAME: VNFD yaml file or VNFpkg tar.gz file
1819 """
1820 logger.debug("")
1821 vnfd_update(ctx, name, content)
1822
1823
1824 @cli_osm.command(name='nfpkg-update', short_help='updates a NFpkg')
1825 @click.argument('name')
1826 @click.option('--content', default=None,
1827 help='filename with the NFpkg replacing the current one')
1828 @click.pass_context
1829 def nfpkg_update(ctx, name, content):
1830 """updates a NFpkg
1831
1832 NAME: NF Descriptor yaml file or NFpkg tar.gz file
1833 """
1834 logger.debug("")
1835 vnfd_update(ctx, name, content)
1836
1837
1838 def nst_update(ctx, name, content):
1839 logger.debug("")
1840 # try:
1841 check_client_version(ctx.obj, ctx.command.name)
1842 ctx.obj.nst.update(name, content)
1843 # except ClientException as e:
1844 # print(str(e))
1845 # exit(1)
1846
1847
1848 @cli_osm.command(name='nst-update', short_help='updates a Network Slice Template (NST)')
1849 @click.argument('name')
1850 @click.option('--content', default=None,
1851 help='filename with the NST/NSTpkg replacing the current one')
1852 @click.pass_context
1853 def nst_update1(ctx, name, content):
1854 """updates a Network Slice Template (NST)
1855
1856 NAME: name or ID of the NSD/NSpkg
1857 """
1858 logger.debug("")
1859 nst_update(ctx, name, content)
1860
1861
1862 @cli_osm.command(name='netslice-template-update', short_help='updates a Network Slice Template (NST)')
1863 @click.argument('name')
1864 @click.option('--content', default=None,
1865 help='filename with the NST/NSTpkg replacing the current one')
1866 @click.pass_context
1867 def nst_update2(ctx, name, content):
1868 """updates a Network Slice Template (NST)
1869
1870 NAME: name or ID of the NSD/NSpkg
1871 """
1872 logger.debug("")
1873 nst_update(ctx, name, content)
1874
1875
1876 ####################
1877 # DELETE operations
1878 ####################
1879
1880 def nsd_delete(ctx, name, force):
1881 logger.debug("")
1882 # try:
1883 if not force:
1884 ctx.obj.nsd.delete(name)
1885 else:
1886 check_client_version(ctx.obj, '--force')
1887 ctx.obj.nsd.delete(name, force)
1888 # except ClientException as e:
1889 # print(str(e))
1890 # exit(1)
1891
1892
1893 @cli_osm.command(name='nsd-delete', short_help='deletes a NSD/NSpkg')
1894 @click.argument('name')
1895 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
1896 @click.pass_context
1897 def nsd_delete1(ctx, name, force):
1898 """deletes a NSD/NSpkg
1899
1900 NAME: name or ID of the NSD/NSpkg to be deleted
1901 """
1902 logger.debug("")
1903 nsd_delete(ctx, name, force)
1904
1905
1906 @cli_osm.command(name='nspkg-delete', short_help='deletes a NSD/NSpkg')
1907 @click.argument('name')
1908 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
1909 @click.pass_context
1910 def nsd_delete2(ctx, name, force):
1911 """deletes a NSD/NSpkg
1912
1913 NAME: name or ID of the NSD/NSpkg to be deleted
1914 """
1915 logger.debug("")
1916 nsd_delete(ctx, name, force)
1917
1918
1919 def vnfd_delete(ctx, name, force):
1920 logger.debug("")
1921 # try:
1922 if not force:
1923 ctx.obj.vnfd.delete(name)
1924 else:
1925 check_client_version(ctx.obj, '--force')
1926 ctx.obj.vnfd.delete(name, force)
1927 # except ClientException as e:
1928 # print(str(e))
1929 # exit(1)
1930
1931
1932 @cli_osm.command(name='vnfd-delete', short_help='deletes a VNFD/VNFpkg')
1933 @click.argument('name')
1934 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
1935 @click.pass_context
1936 def vnfd_delete1(ctx, name, force):
1937 """deletes a VNFD/VNFpkg
1938
1939 NAME: name or ID of the VNFD/VNFpkg to be deleted
1940 """
1941 logger.debug("")
1942 vnfd_delete(ctx, name, force)
1943
1944
1945 @cli_osm.command(name='vnfpkg-delete', short_help='deletes a VNFD/VNFpkg')
1946 @click.argument('name')
1947 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
1948 @click.pass_context
1949 def vnfd_delete2(ctx, name, force):
1950 """deletes a VNFD/VNFpkg
1951
1952 NAME: name or ID of the VNFD/VNFpkg to be deleted
1953 """
1954 logger.debug("")
1955 vnfd_delete(ctx, name, force)
1956
1957
1958 @cli_osm.command(name='nfpkg-delete', short_help='deletes a NFpkg')
1959 @click.argument('name')
1960 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
1961 @click.pass_context
1962 def nfpkg_delete(ctx, name, force):
1963 """deletes a NFpkg
1964
1965 NAME: name or ID of the NFpkg to be deleted
1966 """
1967 logger.debug("")
1968 vnfd_delete(ctx, name, force)
1969
1970
1971 @cli_osm.command(name='ns-delete', short_help='deletes a NS instance')
1972 @click.argument('name')
1973 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
1974 @click.option('--wait',
1975 required=False,
1976 default=False,
1977 is_flag=True,
1978 help='do not return the control immediately, but keep it '
1979 'until the operation is completed, or timeout')
1980 @click.pass_context
1981 def ns_delete(ctx, name, force, wait):
1982 """deletes a NS instance
1983
1984 NAME: name or ID of the NS instance to be deleted
1985 """
1986 logger.debug("")
1987 # try:
1988 if not force:
1989 ctx.obj.ns.delete(name, wait=wait)
1990 else:
1991 check_client_version(ctx.obj, '--force')
1992 ctx.obj.ns.delete(name, force, wait=wait)
1993 # except ClientException as e:
1994 # print(str(e))
1995 # exit(1)
1996
1997
1998 def nst_delete(ctx, name, force):
1999 logger.debug("")
2000 # try:
2001 check_client_version(ctx.obj, ctx.command.name)
2002 ctx.obj.nst.delete(name, force)
2003 # except ClientException as e:
2004 # print(str(e))
2005 # exit(1)
2006
2007
2008 @cli_osm.command(name='nst-delete', short_help='deletes a Network Slice Template (NST)')
2009 @click.argument('name')
2010 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
2011 @click.pass_context
2012 def nst_delete1(ctx, name, force):
2013 """deletes a Network Slice Template (NST)
2014
2015 NAME: name or ID of the NST/NSTpkg to be deleted
2016 """
2017 logger.debug("")
2018 nst_delete(ctx, name, force)
2019
2020
2021 @cli_osm.command(name='netslice-template-delete', short_help='deletes a Network Slice Template (NST)')
2022 @click.argument('name')
2023 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
2024 @click.pass_context
2025 def nst_delete2(ctx, name, force):
2026 """deletes a Network Slice Template (NST)
2027
2028 NAME: name or ID of the NST/NSTpkg to be deleted
2029 """
2030 logger.debug("")
2031 nst_delete(ctx, name, force)
2032
2033
2034 def nsi_delete(ctx, name, force, wait):
2035 logger.debug("")
2036 # try:
2037 check_client_version(ctx.obj, ctx.command.name)
2038 ctx.obj.nsi.delete(name, force, wait=wait)
2039 # except ClientException as e:
2040 # print(str(e))
2041 # exit(1)
2042
2043
2044 @cli_osm.command(name='nsi-delete', short_help='deletes a Network Slice Instance (NSI)')
2045 @click.argument('name')
2046 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
2047 @click.option('--wait',
2048 required=False,
2049 default=False,
2050 is_flag=True,
2051 help='do not return the control immediately, but keep it '
2052 'until the operation is completed, or timeout')
2053 @click.pass_context
2054 def nsi_delete1(ctx, name, force, wait):
2055 """deletes a Network Slice Instance (NSI)
2056
2057 NAME: name or ID of the Network Slice instance to be deleted
2058 """
2059 logger.debug("")
2060 nsi_delete(ctx, name, force, wait=wait)
2061
2062
2063 @cli_osm.command(name='netslice-instance-delete', short_help='deletes a Network Slice Instance (NSI)')
2064 @click.argument('name')
2065 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
2066 @click.pass_context
2067 def nsi_delete2(ctx, name, force, wait):
2068 """deletes a Network Slice Instance (NSI)
2069
2070 NAME: name or ID of the Network Slice instance to be deleted
2071 """
2072 logger.debug("")
2073 nsi_delete(ctx, name, force, wait=wait)
2074
2075
2076 @cli_osm.command(name='pdu-delete', short_help='deletes a Physical Deployment Unit (PDU)')
2077 @click.argument('name')
2078 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
2079 @click.pass_context
2080 def pdu_delete(ctx, name, force):
2081 """deletes a Physical Deployment Unit (PDU)
2082
2083 NAME: name or ID of the PDU to be deleted
2084 """
2085 logger.debug("")
2086 # try:
2087 check_client_version(ctx.obj, ctx.command.name)
2088 ctx.obj.pdu.delete(name, force)
2089 # except ClientException as e:
2090 # print(str(e))
2091 # exit(1)
2092
2093
2094 #################
2095 # VIM operations
2096 #################
2097
2098 @cli_osm.command(name='vim-create', short_help='creates a new VIM account')
2099 @click.option('--name',
2100 prompt=True,
2101 help='Name to create datacenter')
2102 @click.option('--user',
2103 prompt=True,
2104 help='VIM username')
2105 @click.option('--password',
2106 prompt=True,
2107 hide_input=True,
2108 confirmation_prompt=True,
2109 help='VIM password')
2110 @click.option('--auth_url',
2111 prompt=True,
2112 help='VIM url')
2113 @click.option('--tenant',
2114 prompt=True,
2115 help='VIM tenant name')
2116 @click.option('--config',
2117 default=None,
2118 help='VIM specific config parameters')
2119 @click.option('--account_type',
2120 default='openstack',
2121 help='VIM type')
2122 @click.option('--description',
2123 default=None,
2124 help='human readable description')
2125 @click.option('--sdn_controller', default=None, help='Name or id of the SDN controller associated to this VIM account')
2126 @click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports")
2127 @click.option('--wait',
2128 required=False,
2129 default=False,
2130 is_flag=True,
2131 help='do not return the control immediately, but keep it '
2132 'until the operation is completed, or timeout')
2133 @click.pass_context
2134 def vim_create(ctx,
2135 name,
2136 user,
2137 password,
2138 auth_url,
2139 tenant,
2140 config,
2141 account_type,
2142 description,
2143 sdn_controller,
2144 sdn_port_mapping,
2145 wait):
2146 """creates a new VIM account"""
2147 logger.debug("")
2148 # try:
2149 if sdn_controller:
2150 check_client_version(ctx.obj, '--sdn_controller')
2151 if sdn_port_mapping:
2152 check_client_version(ctx.obj, '--sdn_port_mapping')
2153 vim = {}
2154 vim['vim-username'] = user
2155 vim['vim-password'] = password
2156 vim['vim-url'] = auth_url
2157 vim['vim-tenant-name'] = tenant
2158 vim['vim-type'] = account_type
2159 vim['description'] = description
2160 vim['config'] = config
2161 if sdn_controller or sdn_port_mapping:
2162 ctx.obj.vim.create(name, vim, sdn_controller, sdn_port_mapping, wait=wait)
2163 else:
2164 ctx.obj.vim.create(name, vim, wait=wait)
2165 # except ClientException as e:
2166 # print(str(e))
2167 # exit(1)
2168
2169
2170 @cli_osm.command(name='vim-update', short_help='updates a VIM account')
2171 @click.argument('name')
2172 @click.option('--newname', help='New name for the VIM account')
2173 @click.option('--user', help='VIM username')
2174 @click.option('--password', help='VIM password')
2175 @click.option('--auth_url', help='VIM url')
2176 @click.option('--tenant', help='VIM tenant name')
2177 @click.option('--config', help='VIM specific config parameters')
2178 @click.option('--account_type', help='VIM type')
2179 @click.option('--description', help='human readable description')
2180 @click.option('--sdn_controller', default=None, help='Name or id of the SDN controller to be associated with this VIM'
2181 'account. Use empty string to disassociate')
2182 @click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports")
2183 @click.option('--wait',
2184 required=False,
2185 default=False,
2186 is_flag=True,
2187 help='do not return the control immediately, but keep it '
2188 'until the operation is completed, or timeout')
2189 @click.pass_context
2190 def vim_update(ctx,
2191 name,
2192 newname,
2193 user,
2194 password,
2195 auth_url,
2196 tenant,
2197 config,
2198 account_type,
2199 description,
2200 sdn_controller,
2201 sdn_port_mapping,
2202 wait):
2203 """updates a VIM account
2204
2205 NAME: name or ID of the VIM account
2206 """
2207 logger.debug("")
2208 # try:
2209 check_client_version(ctx.obj, ctx.command.name)
2210 vim = {}
2211 if newname: vim['name'] = newname
2212 if user: vim['vim_user'] = user
2213 if password: vim['vim_password'] = password
2214 if auth_url: vim['vim_url'] = auth_url
2215 if tenant: vim['vim-tenant-name'] = tenant
2216 if account_type: vim['vim_type'] = account_type
2217 if description: vim['description'] = description
2218 if config: vim['config'] = config
2219 ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping, wait=wait)
2220 # except ClientException as e:
2221 # print(str(e))
2222 # exit(1)
2223
2224
2225 @cli_osm.command(name='vim-delete', short_help='deletes a VIM account')
2226 @click.argument('name')
2227 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
2228 @click.option('--wait',
2229 required=False,
2230 default=False,
2231 is_flag=True,
2232 help='do not return the control immediately, but keep it '
2233 'until the operation is completed, or timeout')
2234 @click.pass_context
2235 def vim_delete(ctx, name, force, wait):
2236 """deletes a VIM account
2237
2238 NAME: name or ID of the VIM account to be deleted
2239 """
2240 logger.debug("")
2241 # try:
2242 if not force:
2243 ctx.obj.vim.delete(name, wait=wait)
2244 else:
2245 check_client_version(ctx.obj, '--force')
2246 ctx.obj.vim.delete(name, force, wait=wait)
2247 # except ClientException as e:
2248 # print(str(e))
2249 # exit(1)
2250
2251
2252 @cli_osm.command(name='vim-list', short_help='list all VIM accounts')
2253 #@click.option('--ro_update/--no_ro_update',
2254 # default=False,
2255 # help='update list from RO')
2256 @click.option('--filter', default=None,
2257 help='restricts the list to the VIM accounts matching the filter')
2258 @click.pass_context
2259 def vim_list(ctx, filter):
2260 """list all VIM accounts"""
2261 logger.debug("")
2262 if filter:
2263 check_client_version(ctx.obj, '--filter')
2264 # if ro_update:
2265 # check_client_version(ctx.obj, '--ro_update', 'v1')
2266 fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
2267 if fullclassname == 'osmclient.sol005.client.Client':
2268 resp = ctx.obj.vim.list(filter)
2269 # else:
2270 # resp = ctx.obj.vim.list(ro_update)
2271 table = PrettyTable(['vim name', 'uuid'])
2272 for vim in resp:
2273 table.add_row([vim['name'], vim['uuid']])
2274 table.align = 'l'
2275 print(table)
2276
2277
2278 @cli_osm.command(name='vim-show', short_help='shows the details of a VIM account')
2279 @click.argument('name')
2280 @click.pass_context
2281 def vim_show(ctx, name):
2282 """shows the details of a VIM account
2283
2284 NAME: name or ID of the VIM account
2285 """
2286 logger.debug("")
2287 # try:
2288 resp = ctx.obj.vim.get(name)
2289 if 'vim_password' in resp:
2290 resp['vim_password']='********'
2291 # except ClientException as e:
2292 # print(str(e))
2293 # exit(1)
2294
2295 table = PrettyTable(['key', 'attribute'])
2296 for k, v in list(resp.items()):
2297 table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)])
2298 table.align = 'l'
2299 print(table)
2300
2301
2302 ####################
2303 # WIM operations
2304 ####################
2305
2306 @cli_osm.command(name='wim-create', short_help='creates a new WIM account')
2307 @click.option('--name',
2308 prompt=True,
2309 help='Name for the WIM account')
2310 @click.option('--user',
2311 help='WIM username')
2312 @click.option('--password',
2313 help='WIM password')
2314 @click.option('--url',
2315 prompt=True,
2316 help='WIM url')
2317 # @click.option('--tenant',
2318 # help='wIM tenant name')
2319 @click.option('--config',
2320 default=None,
2321 help='WIM specific config parameters')
2322 @click.option('--wim_type',
2323 help='WIM type')
2324 @click.option('--description',
2325 default=None,
2326 help='human readable description')
2327 @click.option('--wim_port_mapping', default=None,
2328 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
2329 "(WAN service endpoint id and info)")
2330 @click.option('--wait',
2331 required=False,
2332 default=False,
2333 is_flag=True,
2334 help='do not return the control immediately, but keep it '
2335 'until the operation is completed, or timeout')
2336 @click.pass_context
2337 def wim_create(ctx,
2338 name,
2339 user,
2340 password,
2341 url,
2342 # tenant,
2343 config,
2344 wim_type,
2345 description,
2346 wim_port_mapping,
2347 wait):
2348 """creates a new WIM account"""
2349 logger.debug("")
2350 # try:
2351 check_client_version(ctx.obj, ctx.command.name)
2352 # if sdn_controller:
2353 # check_client_version(ctx.obj, '--sdn_controller')
2354 # if sdn_port_mapping:
2355 # check_client_version(ctx.obj, '--sdn_port_mapping')
2356 wim = {}
2357 if user: wim['user'] = user
2358 if password: wim['password'] = password
2359 if url: wim['wim_url'] = url
2360 # if tenant: wim['tenant'] = tenant
2361 wim['wim_type'] = wim_type
2362 if description: wim['description'] = description
2363 if config: wim['config'] = config
2364 ctx.obj.wim.create(name, wim, wim_port_mapping, wait=wait)
2365 # except ClientException as e:
2366 # print(str(e))
2367 # exit(1)
2368
2369
2370 @cli_osm.command(name='wim-update', short_help='updates a WIM account')
2371 @click.argument('name')
2372 @click.option('--newname', help='New name for the WIM account')
2373 @click.option('--user', help='WIM username')
2374 @click.option('--password', help='WIM password')
2375 @click.option('--url', help='WIM url')
2376 @click.option('--config', help='WIM specific config parameters')
2377 @click.option('--wim_type', help='WIM type')
2378 @click.option('--description', help='human readable description')
2379 @click.option('--wim_port_mapping', default=None,
2380 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
2381 "(WAN service endpoint id and info)")
2382 @click.option('--wait',
2383 required=False,
2384 default=False,
2385 is_flag=True,
2386 help='do not return the control immediately, but keep it until the operation is completed, or timeout')
2387 @click.pass_context
2388 def wim_update(ctx,
2389 name,
2390 newname,
2391 user,
2392 password,
2393 url,
2394 config,
2395 wim_type,
2396 description,
2397 wim_port_mapping,
2398 wait):
2399 """updates a WIM account
2400
2401 NAME: name or ID of the WIM account
2402 """
2403 logger.debug("")
2404 # try:
2405 check_client_version(ctx.obj, ctx.command.name)
2406 wim = {}
2407 if newname: wim['name'] = newname
2408 if user: wim['user'] = user
2409 if password: wim['password'] = password
2410 if url: wim['url'] = url
2411 # if tenant: wim['tenant'] = tenant
2412 if wim_type: wim['wim_type'] = wim_type
2413 if description: wim['description'] = description
2414 if config: wim['config'] = config
2415 ctx.obj.wim.update(name, wim, wim_port_mapping, wait=wait)
2416 # except ClientException as e:
2417 # print(str(e))
2418 # exit(1)
2419
2420
2421 @cli_osm.command(name='wim-delete', short_help='deletes a WIM account')
2422 @click.argument('name')
2423 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
2424 @click.option('--wait',
2425 required=False,
2426 default=False,
2427 is_flag=True,
2428 help='do not return the control immediately, but keep it until the operation is completed, or timeout')
2429 @click.pass_context
2430 def wim_delete(ctx, name, force, wait):
2431 """deletes a WIM account
2432
2433 NAME: name or ID of the WIM account to be deleted
2434 """
2435 logger.debug("")
2436 # try:
2437 check_client_version(ctx.obj, ctx.command.name)
2438 ctx.obj.wim.delete(name, force, wait=wait)
2439 # except ClientException as e:
2440 # print(str(e))
2441 # exit(1)
2442
2443
2444 @cli_osm.command(name='wim-list', short_help='list all WIM accounts')
2445 @click.option('--filter', default=None,
2446 help='restricts the list to the WIM accounts matching the filter')
2447 @click.pass_context
2448 def wim_list(ctx, filter):
2449 """list all WIM accounts"""
2450 logger.debug("")
2451 # try:
2452 check_client_version(ctx.obj, ctx.command.name)
2453 resp = ctx.obj.wim.list(filter)
2454 table = PrettyTable(['wim name', 'uuid'])
2455 for wim in resp:
2456 table.add_row([wim['name'], wim['uuid']])
2457 table.align = 'l'
2458 print(table)
2459 # except ClientException as e:
2460 # print(str(e))
2461 # exit(1)
2462
2463
2464 @cli_osm.command(name='wim-show', short_help='shows the details of a WIM account')
2465 @click.argument('name')
2466 @click.pass_context
2467 def wim_show(ctx, name):
2468 """shows the details of a WIM account
2469
2470 NAME: name or ID of the WIM account
2471 """
2472 logger.debug("")
2473 # try:
2474 check_client_version(ctx.obj, ctx.command.name)
2475 resp = ctx.obj.wim.get(name)
2476 if 'password' in resp:
2477 resp['wim_password']='********'
2478 # except ClientException as e:
2479 # print(str(e))
2480 # exit(1)
2481
2482 table = PrettyTable(['key', 'attribute'])
2483 for k, v in list(resp.items()):
2484 table.add_row([k, json.dumps(v, indent=2)])
2485 table.align = 'l'
2486 print(table)
2487
2488
2489 ####################
2490 # SDN controller operations
2491 ####################
2492
2493 @cli_osm.command(name='sdnc-create', short_help='creates a new SDN controller')
2494 @click.option('--name',
2495 prompt=True,
2496 help='Name to create sdn controller')
2497 @click.option('--type',
2498 prompt=True,
2499 help='SDN controller type')
2500 @click.option('--sdn_controller_version', # hidden=True,
2501 help='Deprecated. Use --config {version: sdn_controller_version}')
2502 @click.option('--url',
2503 help='URL in format http[s]://HOST:IP/')
2504 @click.option('--ip_address', # hidden=True,
2505 help='Deprecated. Use --url')
2506 @click.option('--port', # hidden=True,
2507 help='Deprecated. Use --url')
2508 @click.option('--switch_dpid', # hidden=True,
2509 help='Deprecated. Use --config {switch_id: DPID}')
2510 @click.option('--config',
2511 help='Extra information for SDN in yaml format, as {switch_id: identity used for the plugin (e.g. DPID: '
2512 'Openflow Datapath ID), version: version}')
2513 @click.option('--user',
2514 help='SDN controller username')
2515 @click.option('--password',
2516 hide_input=True,
2517 confirmation_prompt=True,
2518 help='SDN controller password')
2519 @click.option('--description', default=None, help='human readable description')
2520 @click.option('--wait',
2521 required=False,
2522 default=False,
2523 is_flag=True,
2524 help="do not return the control immediately, but keep it until the operation is completed, or timeout")
2525 @click.pass_context
2526 def sdnc_create(ctx, **kwargs):
2527 """creates a new SDN controller"""
2528 logger.debug("")
2529 sdncontroller = {x: kwargs[x] for x in kwargs if kwargs[x] and
2530 x not in ("wait", "ip_address", "port", "switch_dpid")}
2531 if kwargs.get("port"):
2532 print("option '--port' is deprecated, use '--url' instead")
2533 sdncontroller["port"] = int(kwargs["port"])
2534 if kwargs.get("ip_address"):
2535 print("option '--ip_address' is deprecated, use '--url' instead")
2536 sdncontroller["ip"] = kwargs["ip_address"]
2537 if kwargs.get("switch_dpid"):
2538 print("option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead")
2539 sdncontroller["dpid"] = kwargs["switch_dpid"]
2540 if kwargs.get("sdn_controller_version"):
2541 print("option '--sdn_controller_version' is deprecated, use '--config={version: SDN_CONTROLLER_VERSION}'"
2542 " instead")
2543 # try:
2544 check_client_version(ctx.obj, ctx.command.name)
2545 ctx.obj.sdnc.create(kwargs["name"], sdncontroller, wait=kwargs["wait"])
2546 # except ClientException as e:
2547 # print(str(e))
2548 # exit(1)
2549
2550 @cli_osm.command(name='sdnc-update', short_help='updates an SDN controller')
2551 @click.argument('name')
2552 @click.option('--newname', help='New name for the SDN controller')
2553 @click.option('--description', default=None, help='human readable description')
2554 @click.option('--type', help='SDN controller type')
2555 @click.option('--url', help='URL in format http[s]://HOST:IP/')
2556 @click.option('--config', help='Extra information for SDN in yaml format, as '
2557 '{switch_id: identity used for the plugin (e.g. DPID: '
2558 'Openflow Datapath ID), version: version}')
2559 @click.option('--user', help='SDN controller username')
2560 @click.option('--password', help='SDN controller password')
2561 @click.option('--ip_address', help='Deprecated. Use --url') # hidden=True
2562 @click.option('--port', help='Deprecated. Use --url') # hidden=True
2563 @click.option('--switch_dpid', help='Deprecated. Use --config {switch_dpid: DPID}') # hidden=True
2564 @click.option('--sdn_controller_version', help='Deprecated. Use --config {version: VERSION}') # hidden=True
2565 @click.option('--wait', required=False, default=False, is_flag=True,
2566 help='do not return the control immediately, but keep it until the operation is completed, or timeout')
2567 @click.pass_context
2568 def sdnc_update(ctx, **kwargs):
2569 """updates an SDN controller
2570
2571 NAME: name or ID of the SDN controller
2572 """
2573 logger.debug("")
2574 sdncontroller = {x: kwargs[x] for x in kwargs if kwargs[x] and
2575 x not in ("wait", "ip_address", "port", "switch_dpid", "new_name")}
2576 if kwargs.get("newname"):
2577 sdncontroller["name"] = kwargs["newname"]
2578 if kwargs.get("port"):
2579 print("option '--port' is deprecated, use '--url' instead")
2580 sdncontroller["port"] = int(kwargs["port"])
2581 if kwargs.get("ip_address"):
2582 print("option '--ip_address' is deprecated, use '--url' instead")
2583 sdncontroller["ip"] = kwargs["ip_address"]
2584 if kwargs.get("switch_dpid"):
2585 print("option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead")
2586 sdncontroller["dpid"] = kwargs["switch_dpid"]
2587 if kwargs.get("sdn_controller_version"):
2588 print("option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'"
2589 " instead")
2590
2591 # try:
2592 check_client_version(ctx.obj, ctx.command.name)
2593 ctx.obj.sdnc.update(kwargs["name"], sdncontroller, wait=kwargs["wait"])
2594 # except ClientException as e:
2595 # print(str(e))
2596 # exit(1)
2597
2598
2599 @cli_osm.command(name='sdnc-delete', short_help='deletes an SDN controller')
2600 @click.argument('name')
2601 @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
2602 @click.option('--wait', required=False, default=False, is_flag=True,
2603 help='do not return the control immediately, but keep it until the operation is completed, or timeout')
2604 @click.pass_context
2605 def sdnc_delete(ctx, name, force, wait):
2606 """deletes an SDN controller
2607
2608 NAME: name or ID of the SDN controller to be deleted
2609 """
2610 logger.debug("")
2611 # try:
2612 check_client_version(ctx.obj, ctx.command.name)
2613 ctx.obj.sdnc.delete(name, force, wait=wait)
2614 # except ClientException as e:
2615 # print(str(e))
2616 # exit(1)
2617
2618
2619 @cli_osm.command(name='sdnc-list', short_help='list all SDN controllers')
2620 @click.option('--filter', default=None,
2621 help="restricts the list to the SDN controllers matching the filter with format: 'k[.k..]=v[&k[.k]=v2]'")
2622 @click.pass_context
2623 def sdnc_list(ctx, filter):
2624 """list all SDN controllers"""
2625 logger.debug("")
2626 # try:
2627 check_client_version(ctx.obj, ctx.command.name)
2628 resp = ctx.obj.sdnc.list(filter)
2629 # except ClientException as e:
2630 # print(str(e))
2631 # exit(1)
2632 table = PrettyTable(['sdnc name', 'id'])
2633 for sdnc in resp:
2634 table.add_row([sdnc['name'], sdnc['_id']])
2635 table.align = 'l'
2636 print(table)
2637
2638
2639 @cli_osm.command(name='sdnc-show', short_help='shows the details of an SDN controller')
2640 @click.argument('name')
2641 @click.pass_context
2642 def sdnc_show(ctx, name):
2643 """shows the details of an SDN controller
2644
2645 NAME: name or ID of the SDN controller
2646 """
2647 logger.debug("")
2648 # try:
2649 check_client_version(ctx.obj, ctx.command.name)
2650 resp = ctx.obj.sdnc.get(name)
2651 # except ClientException as e:
2652 # print(str(e))
2653 # exit(1)
2654
2655 table = PrettyTable(['key', 'attribute'])
2656 for k, v in list(resp.items()):
2657 table.add_row([k, json.dumps(v, indent=2)])
2658 table.align = 'l'
2659 print(table)
2660
2661
2662 ###########################
2663 # K8s cluster operations
2664 ###########################
2665
2666 @cli_osm.command(name='k8scluster-add', short_help='adds a K8s cluster to OSM')
2667 @click.argument('name')
2668 @click.option('--creds',
2669 prompt=True,
2670 help='credentials file, i.e. a valid `.kube/config` file')
2671 @click.option('--version',
2672 prompt=True,
2673 help='Kubernetes version')
2674 @click.option('--vim',
2675 prompt=True,
2676 help='VIM target, the VIM where the cluster resides')
2677 @click.option('--k8s-nets',
2678 prompt=True,
2679 help='list of VIM networks, in JSON inline format, where the cluster is accessible via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"')
2680 @click.option('--description',
2681 default=None,
2682 help='human readable description')
2683 @click.option('--namespace',
2684 default='kube-system',
2685 help='namespace to be used for its operation, defaults to `kube-system`')
2686 @click.option('--cni',
2687 default=None,
2688 help='list of CNI plugins, in JSON inline format, used in the cluster')
2689 #@click.option('--skip-init',
2690 # is_flag=True,
2691 # help='If set, K8s cluster is assumed to be ready for its use with OSM')
2692 #@click.option('--wait',
2693 # is_flag=True,
2694 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
2695 @click.pass_context
2696 def k8scluster_add(ctx,
2697 name,
2698 creds,
2699 version,
2700 vim,
2701 k8s_nets,
2702 description,
2703 namespace,
2704 cni):
2705 """adds a K8s cluster to OSM
2706
2707 NAME: name of the K8s cluster
2708 """
2709 # try:
2710 check_client_version(ctx.obj, ctx.command.name)
2711 cluster = {}
2712 cluster['name'] = name
2713 with open(creds, 'r') as cf:
2714 cluster['credentials'] = yaml.safe_load(cf.read())
2715 cluster['k8s_version'] = version
2716 cluster['vim_account'] = vim
2717 cluster['nets'] = yaml.safe_load(k8s_nets)
2718 cluster['description'] = description
2719 if namespace: cluster['namespace'] = namespace
2720 if cni: cluster['cni'] = yaml.safe_load(cni)
2721 ctx.obj.k8scluster.create(name, cluster)
2722 # except ClientException as e:
2723 # print(str(e))
2724 # exit(1)
2725
2726
2727 @cli_osm.command(name='k8scluster-update', short_help='updates a K8s cluster')
2728 @click.argument('name')
2729 @click.option('--newname', help='New name for the K8s cluster')
2730 @click.option('--creds', help='credentials file, i.e. a valid `.kube/config` file')
2731 @click.option('--version', help='Kubernetes version')
2732 @click.option('--vim', help='VIM target, the VIM where the cluster resides')
2733 @click.option('--k8s-nets', help='list of VIM networks, in JSON inline format, where the cluster is accessible via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"')
2734 @click.option('--description', help='human readable description')
2735 @click.option('--namespace', help='namespace to be used for its operation, defaults to `kube-system`')
2736 @click.option('--cni', help='list of CNI plugins, in JSON inline format, used in the cluster')
2737 @click.pass_context
2738 def k8scluster_update(ctx,
2739 name,
2740 newname,
2741 creds,
2742 version,
2743 vim,
2744 k8s_nets,
2745 description,
2746 namespace,
2747 cni):
2748 """updates a K8s cluster
2749
2750 NAME: name or ID of the K8s cluster
2751 """
2752 # try:
2753 check_client_version(ctx.obj, ctx.command.name)
2754 cluster = {}
2755 if newname: cluster['name'] = newname
2756 if creds:
2757 with open(creds, 'r') as cf:
2758 cluster['credentials'] = yaml.safe_load(cf.read())
2759 if version: cluster['k8s_version'] = version
2760 if vim: cluster['vim_account'] = vim
2761 if k8s_nets: cluster['nets'] = yaml.safe_load(k8s_nets)
2762 if description: cluster['description'] = description
2763 if namespace: cluster['namespace'] = namespace
2764 if cni: cluster['cni'] = yaml.safe_load(cni)
2765 ctx.obj.k8scluster.update(name, cluster)
2766 # except ClientException as e:
2767 # print(str(e))
2768 # exit(1)
2769
2770
2771 @cli_osm.command(name='k8scluster-delete', short_help='deletes a K8s cluster')
2772 @click.argument('name')
2773 @click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)')
2774 #@click.option('--wait',
2775 # is_flag=True,
2776 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
2777 @click.pass_context
2778 def k8scluster_delete(ctx, name, force):
2779 """deletes a K8s cluster
2780
2781 NAME: name or ID of the K8s cluster to be deleted
2782 """
2783 # try:
2784 check_client_version(ctx.obj, ctx.command.name)
2785 ctx.obj.k8scluster.delete(name, force=force)
2786 # except ClientException as e:
2787 # print(str(e))
2788 # exit(1)
2789
2790
2791 @cli_osm.command(name='k8scluster-list')
2792 @click.option('--filter', default=None,
2793 help='restricts the list to the K8s clusters matching the filter')
2794 @click.option('--literal', is_flag=True,
2795 help='print literally, no pretty table')
2796 @click.pass_context
2797 def k8scluster_list(ctx, filter, literal):
2798 """list all K8s clusters"""
2799 # try:
2800 check_client_version(ctx.obj, ctx.command.name)
2801 resp = ctx.obj.k8scluster.list(filter)
2802 if literal:
2803 print(yaml.safe_dump(resp))
2804 return
2805 table = PrettyTable(['Name', 'Id', 'Version', 'VIM', 'K8s-nets', 'Operational State', 'Description'])
2806 for cluster in resp:
2807 table.add_row([cluster['name'], cluster['_id'], cluster['k8s_version'], cluster['vim_account'],
2808 json.dumps(cluster['nets']), cluster["_admin"]["operationalState"],
2809 trunc_text(cluster.get('description',''),40)])
2810 table.align = 'l'
2811 print(table)
2812 # except ClientException as e:
2813 # print(str(e))
2814 # exit(1)
2815
2816
2817 @cli_osm.command(name='k8scluster-show', short_help='shows the details of a K8s cluster')
2818 @click.argument('name')
2819 @click.option('--literal', is_flag=True,
2820 help='print literally, no pretty table')
2821 @click.pass_context
2822 def k8scluster_show(ctx, name, literal):
2823 """shows the details of a K8s cluster
2824
2825 NAME: name or ID of the K8s cluster
2826 """
2827 # try:
2828 resp = ctx.obj.k8scluster.get(name)
2829 if literal:
2830 print(yaml.safe_dump(resp))
2831 return
2832 table = PrettyTable(['key', 'attribute'])
2833 for k, v in list(resp.items()):
2834 table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)])
2835 table.align = 'l'
2836 print(table)
2837 # except ClientException as e:
2838 # print(str(e))
2839 # exit(1)
2840
2841
2842
2843 ###########################
2844 # Repo operations
2845 ###########################
2846
2847 @cli_osm.command(name='repo-add', short_help='adds a repo to OSM')
2848 @click.argument('name')
2849 @click.argument('uri')
2850 @click.option('--type',
2851 type=click.Choice(['helm-chart', 'juju-bundle']),
2852 prompt=True,
2853 help='type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles)')
2854 @click.option('--description',
2855 default=None,
2856 help='human readable description')
2857 #@click.option('--wait',
2858 # is_flag=True,
2859 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
2860 @click.pass_context
2861 def repo_add(ctx,
2862 name,
2863 uri,
2864 type,
2865 description):
2866 """adds a repo to OSM
2867
2868 NAME: name of the repo
2869 URI: URI of the repo
2870 """
2871 # try:
2872 check_client_version(ctx.obj, ctx.command.name)
2873 repo = {}
2874 repo['name'] = name
2875 repo['url'] = uri
2876 repo['type'] = type
2877 repo['description'] = description
2878 ctx.obj.repo.create(name, repo)
2879 # except ClientException as e:
2880 # print(str(e))
2881 # exit(1)
2882
2883
2884 @cli_osm.command(name='repo-update', short_help='updates a repo in OSM')
2885 @click.argument('name')
2886 @click.option('--newname', help='New name for the repo')
2887 @click.option('--uri', help='URI of the repo')
2888 @click.option('--type', type=click.Choice(['helm-chart', 'juju-bundle']),
2889 help='type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles)')
2890 @click.option('--description', help='human readable description')
2891 #@click.option('--wait',
2892 # is_flag=True,
2893 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
2894 @click.pass_context
2895 def repo_update(ctx,
2896 name,
2897 newname,
2898 uri,
2899 type,
2900 description):
2901 """updates a repo in OSM
2902
2903 NAME: name of the repo
2904 """
2905 # try:
2906 check_client_version(ctx.obj, ctx.command.name)
2907 repo = {}
2908 if newname: repo['name'] = newname
2909 if uri: repo['uri'] = uri
2910 if type: repo['type'] = type
2911 if description: repo['description'] = description
2912 ctx.obj.repo.update(name, repo)
2913 # except ClientException as e:
2914 # print(str(e))
2915 # exit(1)
2916
2917
2918 @cli_osm.command(name='repo-delete', short_help='deletes a repo')
2919 @click.argument('name')
2920 @click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)')
2921 #@click.option('--wait',
2922 # is_flag=True,
2923 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
2924 @click.pass_context
2925 def repo_delete(ctx, name, force):
2926 """deletes a repo
2927
2928 NAME: name or ID of the repo to be deleted
2929 """
2930 # try:
2931 check_client_version(ctx.obj, ctx.command.name)
2932 ctx.obj.repo.delete(name, force=force)
2933 # except ClientException as e:
2934 # print(str(e))
2935 # exit(1)
2936
2937
2938 @cli_osm.command(name='repo-list')
2939 @click.option('--filter', default=None,
2940 help='restricts the list to the repos matching the filter')
2941 @click.option('--literal', is_flag=True,
2942 help='print literally, no pretty table')
2943 @click.pass_context
2944 def repo_list(ctx, filter, literal):
2945 """list all repos"""
2946 # try:
2947 check_client_version(ctx.obj, ctx.command.name)
2948 resp = ctx.obj.repo.list(filter)
2949 if literal:
2950 print(yaml.safe_dump(resp))
2951 return
2952 table = PrettyTable(['Name', 'Id', 'Type', 'URI', 'Description'])
2953 for repo in resp:
2954 #cluster['k8s-nets'] = json.dumps(yaml.safe_load(cluster['k8s-nets']))
2955 table.add_row([repo['name'], repo['_id'], repo['type'], repo['url'], trunc_text(repo.get('description',''),40)])
2956 table.align = 'l'
2957 print(table)
2958 # except ClientException as e:
2959 # print(str(e))
2960 # exit(1)
2961
2962
2963 @cli_osm.command(name='repo-show', short_help='shows the details of a repo')
2964 @click.argument('name')
2965 @click.option('--literal', is_flag=True,
2966 help='print literally, no pretty table')
2967 @click.pass_context
2968 def repo_show(ctx, name, literal):
2969 """shows the details of a repo
2970
2971 NAME: name or ID of the repo
2972 """
2973 # try:
2974 resp = ctx.obj.repo.get(name)
2975 if literal:
2976 print(yaml.safe_dump(resp))
2977 return
2978 table = PrettyTable(['key', 'attribute'])
2979 for k, v in list(resp.items()):
2980 table.add_row([k, json.dumps(v, indent=2)])
2981 table.align = 'l'
2982 print(table)
2983 # except ClientException as e:
2984 # print(str(e))
2985 # exit(1)
2986
2987
2988
2989 ####################
2990 # Project mgmt operations
2991 ####################
2992
2993 @cli_osm.command(name='project-create', short_help='creates a new project')
2994 @click.argument('name')
2995 #@click.option('--description',
2996 # default='no description',
2997 # help='human readable description')
2998 @click.option('--domain-name', 'domain_name',
2999 default=None,
3000 help='assign to a domain')
3001 @click.pass_context
3002 def project_create(ctx, name, domain_name):
3003 """Creates a new project
3004
3005 NAME: name of the project
3006 DOMAIN_NAME: optional domain name for the project when keystone authentication is used
3007 """
3008 logger.debug("")
3009 project = {}
3010 project['name'] = name
3011 if domain_name:
3012 project['domain_name'] = domain_name
3013 # try:
3014 check_client_version(ctx.obj, ctx.command.name)
3015 ctx.obj.project.create(name, project)
3016 # except ClientException as e:
3017 # print(str(e))
3018 # exit(1)
3019
3020
3021 @cli_osm.command(name='project-delete', short_help='deletes a project')
3022 @click.argument('name')
3023 #@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
3024 @click.pass_context
3025 def project_delete(ctx, name):
3026 """deletes a project
3027
3028 NAME: name or ID of the project to be deleted
3029 """
3030 logger.debug("")
3031 # try:
3032 check_client_version(ctx.obj, ctx.command.name)
3033 ctx.obj.project.delete(name)
3034 # except ClientException as e:
3035 # print(str(e))
3036 # exit(1)
3037
3038
3039 @cli_osm.command(name='project-list', short_help='list all projects')
3040 @click.option('--filter', default=None,
3041 help='restricts the list to the projects matching the filter')
3042 @click.pass_context
3043 def project_list(ctx, filter):
3044 """list all projects"""
3045 logger.debug("")
3046 # try:
3047 check_client_version(ctx.obj, ctx.command.name)
3048 resp = ctx.obj.project.list(filter)
3049 # except ClientException as e:
3050 # print(str(e))
3051 # exit(1)
3052 table = PrettyTable(['name', 'id'])
3053 for proj in resp:
3054 table.add_row([proj['name'], proj['_id']])
3055 table.align = 'l'
3056 print(table)
3057
3058
3059 @cli_osm.command(name='project-show', short_help='shows the details of a project')
3060 @click.argument('name')
3061 @click.pass_context
3062 def project_show(ctx, name):
3063 """shows the details of a project
3064
3065 NAME: name or ID of the project
3066 """
3067 logger.debug("")
3068 # try:
3069 check_client_version(ctx.obj, ctx.command.name)
3070 resp = ctx.obj.project.get(name)
3071 # except ClientException as e:
3072 # print(str(e))
3073 # exit(1)
3074
3075 table = PrettyTable(['key', 'attribute'])
3076 for k, v in resp.items():
3077 table.add_row([k, json.dumps(v, indent=2)])
3078 table.align = 'l'
3079 print(table)
3080
3081
3082 @cli_osm.command(name='project-update', short_help='updates a project (only the name can be updated)')
3083 @click.argument('project')
3084 @click.option('--name',
3085 prompt=True,
3086 help='new name for the project')
3087
3088 @click.pass_context
3089 def project_update(ctx, project, name):
3090 """
3091 Update a project name
3092
3093 :param ctx:
3094 :param project: id or name of the project to modify
3095 :param name: new name for the project
3096 :return:
3097 """
3098 logger.debug("")
3099 project_changes = {}
3100 project_changes['name'] = name
3101
3102 # try:
3103 check_client_version(ctx.obj, ctx.command.name)
3104 ctx.obj.project.update(project, project_changes)
3105 # except ClientException as e:
3106 # print(str(e))
3107
3108
3109 ####################
3110 # User mgmt operations
3111 ####################
3112
3113 @cli_osm.command(name='user-create', short_help='creates a new user')
3114 @click.argument('username')
3115 @click.option('--password',
3116 prompt=True,
3117 hide_input=True,
3118 confirmation_prompt=True,
3119 help='user password')
3120 @click.option('--projects',
3121 # prompt="Comma separate list of projects",
3122 multiple=True,
3123 callback=lambda ctx, param, value: ''.join(value).split(',') if all(len(x)==1 for x in value) else value,
3124 help='list of project ids that the user belongs to')
3125 @click.option('--project-role-mappings', 'project_role_mappings',
3126 default=None, multiple=True,
3127 help='creating user project/role(s) mapping')
3128 @click.option('--domain-name', 'domain_name',
3129 default=None,
3130 help='assign to a domain')
3131 @click.pass_context
3132 def user_create(ctx, username, password, projects, project_role_mappings, domain_name):
3133 """Creates a new user
3134
3135 \b
3136 USERNAME: name of the user
3137 PASSWORD: password of the user
3138 PROJECTS: projects assigned to user (internal only)
3139 PROJECT_ROLE_MAPPING: roles in projects assigned to user (keystone)
3140 DOMAIN_NAME: optional domain name for the user when keystone authentication is used
3141 """
3142 logger.debug("")
3143 user = {}
3144 user['username'] = username
3145 user['password'] = password
3146 user['projects'] = projects
3147 user['project_role_mappings'] = project_role_mappings
3148 if domain_name:
3149 user['domain_name'] = domain_name
3150
3151 # try:
3152 check_client_version(ctx.obj, ctx.command.name)
3153 ctx.obj.user.create(username, user)
3154 # except ClientException as e:
3155 # print(str(e))
3156 # exit(1)
3157
3158
3159 @cli_osm.command(name='user-update', short_help='updates user information')
3160 @click.argument('username')
3161 @click.option('--password',
3162 # prompt=True,
3163 # hide_input=True,
3164 # confirmation_prompt=True,
3165 help='user password')
3166 @click.option('--set-username', 'set_username',
3167 default=None,
3168 help='change username')
3169 @click.option('--set-project', 'set_project',
3170 default=None, multiple=True,
3171 help='create/replace the project,role(s) mapping for this project: \'project,role1,role2,...\'')
3172 @click.option('--remove-project', 'remove_project',
3173 default=None, multiple=True,
3174 help='removes project from user: \'project\'')
3175 @click.option('--add-project-role', 'add_project_role',
3176 default=None, multiple=True,
3177 help='adds project,role(s) mapping: \'project,role1,role2,...\'')
3178 @click.option('--remove-project-role', 'remove_project_role',
3179 default=None, multiple=True,
3180 help='removes project,role(s) mapping: \'project,role1,role2,...\'')
3181 @click.pass_context
3182 def user_update(ctx, username, password, set_username, set_project, remove_project,
3183 add_project_role, remove_project_role):
3184 """Update a user information
3185
3186 \b
3187 USERNAME: name of the user
3188 PASSWORD: new password
3189 SET_USERNAME: new username
3190 SET_PROJECT: creating mappings for project/role(s)
3191 REMOVE_PROJECT: deleting mappings for project/role(s)
3192 ADD_PROJECT_ROLE: adding mappings for project/role(s)
3193 REMOVE_PROJECT_ROLE: removing mappings for project/role(s)
3194 """
3195 logger.debug("")
3196 user = {}
3197 user['password'] = password
3198 user['username'] = set_username
3199 user['set-project'] = set_project
3200 user['remove-project'] = remove_project
3201 user['add-project-role'] = add_project_role
3202 user['remove-project-role'] = remove_project_role
3203
3204 # try:
3205 check_client_version(ctx.obj, ctx.command.name)
3206 ctx.obj.user.update(username, user)
3207 # except ClientException as e:
3208 # print(str(e))
3209 # exit(1)
3210
3211
3212 @cli_osm.command(name='user-delete', short_help='deletes a user')
3213 @click.argument('name')
3214 #@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
3215 @click.pass_context
3216 def user_delete(ctx, name):
3217 """deletes a user
3218
3219 \b
3220 NAME: name or ID of the user to be deleted
3221 """
3222 logger.debug("")
3223 # try:
3224 check_client_version(ctx.obj, ctx.command.name)
3225 ctx.obj.user.delete(name)
3226 # except ClientException as e:
3227 # print(str(e))
3228 # exit(1)
3229
3230
3231 @cli_osm.command(name='user-list', short_help='list all users')
3232 @click.option('--filter', default=None,
3233 help='restricts the list to the users matching the filter')
3234 @click.pass_context
3235 def user_list(ctx, filter):
3236 """list all users"""
3237 # try:
3238 check_client_version(ctx.obj, ctx.command.name)
3239 resp = ctx.obj.user.list(filter)
3240 # except ClientException as e:
3241 # print(str(e))
3242 # exit(1)
3243 table = PrettyTable(['name', 'id'])
3244 for user in resp:
3245 table.add_row([user['username'], user['_id']])
3246 table.align = 'l'
3247 print(table)
3248
3249
3250 @cli_osm.command(name='user-show', short_help='shows the details of a user')
3251 @click.argument('name')
3252 @click.pass_context
3253 def user_show(ctx, name):
3254 """shows the details of a user
3255
3256 NAME: name or ID of the user
3257 """
3258 logger.debug("")
3259 # try:
3260 check_client_version(ctx.obj, ctx.command.name)
3261 resp = ctx.obj.user.get(name)
3262 if 'password' in resp:
3263 resp['password']='********'
3264 # except ClientException as e:
3265 # print(str(e))
3266 # exit(1)
3267
3268 table = PrettyTable(['key', 'attribute'])
3269 for k, v in resp.items():
3270 table.add_row([k, json.dumps(v, indent=2)])
3271 table.align = 'l'
3272 print(table)
3273
3274
3275 ####################
3276 # Fault Management operations
3277 ####################
3278
3279 @cli_osm.command(name='ns-alarm-create')
3280 @click.argument('name')
3281 @click.option('--ns', prompt=True, help='NS instance id or name')
3282 @click.option('--vnf', prompt=True,
3283 help='VNF name (VNF member index as declared in the NSD)')
3284 @click.option('--vdu', prompt=True,
3285 help='VDU name (VDU name as declared in the VNFD)')
3286 @click.option('--metric', prompt=True,
3287 help='Name of the metric (e.g. cpu_utilization)')
3288 @click.option('--severity', default='WARNING',
3289 help='severity of the alarm (WARNING, MINOR, MAJOR, CRITICAL, INDETERMINATE)')
3290 @click.option('--threshold_value', prompt=True,
3291 help='threshold value that, when crossed, an alarm is triggered')
3292 @click.option('--threshold_operator', prompt=True,
3293 help='threshold operator describing the comparison (GE, LE, GT, LT, EQ)')
3294 @click.option('--statistic', default='AVERAGE',
3295 help='statistic (AVERAGE, MINIMUM, MAXIMUM, COUNT, SUM)')
3296 @click.pass_context
3297 def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity,
3298 threshold_value, threshold_operator, statistic):
3299 """creates a new alarm for a NS instance"""
3300 # TODO: Check how to validate threshold_value.
3301 # Should it be an integer (1-100), percentage, or decimal (0.01-1.00)?
3302 logger.debug("")
3303 # try:
3304 ns_instance = ctx.obj.ns.get(ns)
3305 alarm = {}
3306 alarm['alarm_name'] = name
3307 alarm['ns_id'] = ns_instance['_id']
3308 alarm['correlation_id'] = ns_instance['_id']
3309 alarm['vnf_member_index'] = vnf
3310 alarm['vdu_name'] = vdu
3311 alarm['metric_name'] = metric
3312 alarm['severity'] = severity
3313 alarm['threshold_value'] = int(threshold_value)
3314 alarm['operation'] = threshold_operator
3315 alarm['statistic'] = statistic
3316 check_client_version(ctx.obj, ctx.command.name)
3317 ctx.obj.ns.create_alarm(alarm)
3318 # except ClientException as e:
3319 # print(str(e))
3320 # exit(1)
3321
3322
3323 #@cli_osm.command(name='ns-alarm-delete')
3324 #@click.argument('name')
3325 #@click.pass_context
3326 #def ns_alarm_delete(ctx, name):
3327 # """deletes an alarm
3328 #
3329 # NAME: name of the alarm to be deleted
3330 # """
3331 # try:
3332 # check_client_version(ctx.obj, ctx.command.name)
3333 # ctx.obj.ns.delete_alarm(name)
3334 # except ClientException as e:
3335 # print(str(e))
3336 # exit(1)
3337
3338
3339 ####################
3340 # Performance Management operations
3341 ####################
3342
3343 @cli_osm.command(name='ns-metric-export', short_help='exports a metric to the internal OSM bus, which can be read by other apps')
3344 @click.option('--ns', prompt=True, help='NS instance id or name')
3345 @click.option('--vnf', prompt=True,
3346 help='VNF name (VNF member index as declared in the NSD)')
3347 @click.option('--vdu', prompt=True,
3348 help='VDU name (VDU name as declared in the VNFD)')
3349 @click.option('--metric', prompt=True,
3350 help='name of the metric (e.g. cpu_utilization)')
3351 #@click.option('--period', default='1w',
3352 # help='metric collection period (e.g. 20s, 30m, 2h, 3d, 1w)')
3353 @click.option('--interval', help='periodic interval (seconds) to export metrics continuously')
3354 @click.pass_context
3355 def ns_metric_export(ctx, ns, vnf, vdu, metric, interval):
3356 """exports a metric to the internal OSM bus, which can be read by other apps"""
3357 # TODO: Check how to validate interval.
3358 # Should it be an integer (seconds), or should a suffix (s,m,h,d,w) also be permitted?
3359 logger.debug("")
3360 # try:
3361 ns_instance = ctx.obj.ns.get(ns)
3362 metric_data = {}
3363 metric_data['ns_id'] = ns_instance['_id']
3364 metric_data['correlation_id'] = ns_instance['_id']
3365 metric_data['vnf_member_index'] = vnf
3366 metric_data['vdu_name'] = vdu
3367 metric_data['metric_name'] = metric
3368 metric_data['collection_unit'] = 'WEEK'
3369 metric_data['collection_period'] = 1
3370 check_client_version(ctx.obj, ctx.command.name)
3371 if not interval:
3372 print('{}'.format(ctx.obj.ns.export_metric(metric_data)))
3373 else:
3374 i = 1
3375 while True:
3376 print('{} {}'.format(ctx.obj.ns.export_metric(metric_data),i))
3377 time.sleep(int(interval))
3378 i+=1
3379 # except ClientException as e:
3380 # print(str(e))
3381 # exit(1)
3382
3383
3384 ####################
3385 # Other operations
3386 ####################
3387
3388 @cli_osm.command(name='version', short_help='shows client and server versions')
3389 @click.pass_context
3390 def get_version(ctx):
3391 """shows client and server versions"""
3392 # try:
3393 check_client_version(ctx.obj, "version")
3394 print ("Server version: {}".format(ctx.obj.get_version()))
3395 print ("Client version: {}".format(pkg_resources.get_distribution("osmclient").version))
3396 # except ClientException as e:
3397 # print(str(e))
3398 # exit(1)
3399
3400 @cli_osm.command(name='upload-package', short_help='uploads a VNF package or NS package')
3401 @click.argument('filename')
3402 @click.option('--skip-charm-build', default=False, is_flag=True,
3403 help='the charm will not be compiled, it is assumed to already exist')
3404 @click.pass_context
3405 def upload_package(ctx, filename, skip_charm_build):
3406 """uploads a vnf package or ns package
3407
3408 filename: vnf or ns package folder, or vnf or ns package file (tar.gz)
3409 """
3410 logger.debug("")
3411 # try:
3412 ctx.obj.package.upload(filename, skip_charm_build=skip_charm_build)
3413 fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
3414 if fullclassname != 'osmclient.sol005.client.Client':
3415 ctx.obj.package.wait_for_upload(filename)
3416 # except ClientException as e:
3417 # print(str(e))
3418 # exit(1)
3419
3420
3421 #@cli_osm.command(name='ns-scaling-show')
3422 #@click.argument('ns_name')
3423 #@click.pass_context
3424 #def show_ns_scaling(ctx, ns_name):
3425 # """shows the status of a NS scaling operation
3426 #
3427 # NS_NAME: name of the NS instance being scaled
3428 # """
3429 # try:
3430 # check_client_version(ctx.obj, ctx.command.name, 'v1')
3431 # resp = ctx.obj.ns.list()
3432 # except ClientException as e:
3433 # print(str(e))
3434 # exit(1)
3435 #
3436 # table = PrettyTable(
3437 # ['group-name',
3438 # 'instance-id',
3439 # 'operational status',
3440 # 'create-time',
3441 # 'vnfr ids'])
3442 #
3443 # for ns in resp:
3444 # if ns_name == ns['name']:
3445 # nsopdata = ctx.obj.ns.get_opdata(ns['id'])
3446 # scaling_records = nsopdata['nsr:nsr']['scaling-group-record']
3447 # for record in scaling_records:
3448 # if 'instance' in record:
3449 # instances = record['instance']
3450 # for inst in instances:
3451 # table.add_row(
3452 # [record['scaling-group-name-ref'],
3453 # inst['instance-id'],
3454 # inst['op-status'],
3455 # time.strftime('%Y-%m-%d %H:%M:%S',
3456 # time.localtime(
3457 # inst['create-time'])),
3458 # inst['vnfrs']])
3459 # table.align = 'l'
3460 # print(table)
3461
3462
3463 #@cli_osm.command(name='ns-scale')
3464 #@click.argument('ns_name')
3465 #@click.option('--ns_scale_group', prompt=True)
3466 #@click.option('--index', prompt=True)
3467 #@click.option('--wait',
3468 # required=False,
3469 # default=False,
3470 # is_flag=True,
3471 # help='do not return the control immediately, but keep it \
3472 # until the operation is completed, or timeout')
3473 #@click.pass_context
3474 #def ns_scale(ctx, ns_name, ns_scale_group, index, wait):
3475 # """scales NS
3476 #
3477 # NS_NAME: name of the NS instance to be scaled
3478 # """
3479 # try:
3480 # check_client_version(ctx.obj, ctx.command.name, 'v1')
3481 # ctx.obj.ns.scale(ns_name, ns_scale_group, index, wait=wait)
3482 # except ClientException as e:
3483 # print(str(e))
3484 # exit(1)
3485
3486
3487 #@cli_osm.command(name='config-agent-list')
3488 #@click.pass_context
3489 #def config_agent_list(ctx):
3490 # """list config agents"""
3491 # try:
3492 # check_client_version(ctx.obj, ctx.command.name, 'v1')
3493 # except ClientException as e:
3494 # print(str(e))
3495 # exit(1)
3496 # table = PrettyTable(['name', 'account-type', 'details'])
3497 # for account in ctx.obj.vca.list():
3498 # table.add_row(
3499 # [account['name'],
3500 # account['account-type'],
3501 # account['juju']])
3502 # table.align = 'l'
3503 # print(table)
3504
3505
3506 #@cli_osm.command(name='config-agent-delete')
3507 #@click.argument('name')
3508 #@click.pass_context
3509 #def config_agent_delete(ctx, name):
3510 # """deletes a config agent
3511 #
3512 # NAME: name of the config agent to be deleted
3513 # """
3514 # try:
3515 # check_client_version(ctx.obj, ctx.command.name, 'v1')
3516 # ctx.obj.vca.delete(name)
3517 # except ClientException as e:
3518 # print(str(e))
3519 # exit(1)
3520
3521
3522 #@cli_osm.command(name='config-agent-add')
3523 #@click.option('--name',
3524 # prompt=True)
3525 #@click.option('--account_type',
3526 # prompt=True)
3527 #@click.option('--server',
3528 # prompt=True)
3529 #@click.option('--user',
3530 # prompt=True)
3531 #@click.option('--secret',
3532 # prompt=True,
3533 # hide_input=True,
3534 # confirmation_prompt=True)
3535 #@click.pass_context
3536 #def config_agent_add(ctx, name, account_type, server, user, secret):
3537 # """adds a config agent"""
3538 # try:
3539 # check_client_version(ctx.obj, ctx.command.name, 'v1')
3540 # ctx.obj.vca.create(name, account_type, server, user, secret)
3541 # except ClientException as e:
3542 # print(str(e))
3543 # exit(1)
3544
3545
3546 #@cli_osm.command(name='ro-dump')
3547 #@click.pass_context
3548 #def ro_dump(ctx):
3549 # """shows RO agent information"""
3550 # check_client_version(ctx.obj, ctx.command.name, 'v1')
3551 # resp = ctx.obj.vim.get_resource_orchestrator()
3552 # table = PrettyTable(['key', 'attribute'])
3553 # for k, v in list(resp.items()):
3554 # table.add_row([k, json.dumps(v, indent=2)])
3555 # table.align = 'l'
3556 # print(table)
3557
3558
3559 #@cli_osm.command(name='vcs-list')
3560 #@click.pass_context
3561 #def vcs_list(ctx):
3562 # check_client_version(ctx.obj, ctx.command.name, 'v1')
3563 # resp = ctx.obj.utils.get_vcs_info()
3564 # table = PrettyTable(['component name', 'state'])
3565 # for component in resp:
3566 # table.add_row([component['component_name'], component['state']])
3567 # table.align = 'l'
3568 # print(table)
3569
3570
3571 @cli_osm.command(name='ns-action', short_help='executes an action/primitive over a NS instance')
3572 @click.argument('ns_name')
3573 @click.option('--vnf_name', default=None, help='member-vnf-index if the target is a vnf instead of a ns)')
3574 @click.option('--kdu_name', default=None, help='kdu-name if the target is a kdu)')
3575 @click.option('--vdu_id', default=None, help='vdu-id if the target is a vdu')
3576 @click.option('--vdu_count', default=None, help='number of vdu instance of this vdu_id')
3577 @click.option('--action_name', prompt=True, help='action name')
3578 @click.option('--params', default=None, help='action params in YAML/JSON inline string')
3579 @click.option('--params_file', default=None, help='YAML/JSON file with action params')
3580 @click.option('--wait',
3581 required=False,
3582 default=False,
3583 is_flag=True,
3584 help='do not return the control immediately, but keep it until the operation is completed, or timeout')
3585 @click.pass_context
3586 def ns_action(ctx,
3587 ns_name,
3588 vnf_name,
3589 kdu_name,
3590 vdu_id,
3591 vdu_count,
3592 action_name,
3593 params,
3594 params_file,
3595 wait):
3596 """executes an action/primitive over a NS instance
3597
3598 NS_NAME: name or ID of the NS instance
3599 """
3600 logger.debug("")
3601 # try:
3602 check_client_version(ctx.obj, ctx.command.name)
3603 op_data = {}
3604 if vnf_name:
3605 op_data['member_vnf_index'] = vnf_name
3606 if kdu_name:
3607 op_data['kdu_name'] = kdu_name
3608 if vdu_id:
3609 op_data['vdu_id'] = vdu_id
3610 if vdu_count:
3611 op_data['vdu_count_index'] = vdu_count
3612 op_data['primitive'] = action_name
3613 if params_file:
3614 with open(params_file, 'r') as pf:
3615 params = pf.read()
3616 if params:
3617 op_data['primitive_params'] = yaml.safe_load(params)
3618 else:
3619 op_data['primitive_params'] = {}
3620 print(ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data, wait=wait))
3621
3622 # except ClientException as e:
3623 # print(str(e))
3624 # exit(1)
3625
3626
3627 @cli_osm.command(name='vnf-scale', short_help='executes a VNF scale (adding/removing VDUs)')
3628 @click.argument('ns_name')
3629 @click.argument('vnf_name')
3630 @click.option('--scaling-group', prompt=True, help="scaling-group-descriptor name to use")
3631 @click.option('--scale-in', default=False, is_flag=True, help="performs a scale in operation")
3632 @click.option('--scale-out', default=False, is_flag=True, help="performs a scale out operation (by default)")
3633 @click.pass_context
3634 def vnf_scale(ctx,
3635 ns_name,
3636 vnf_name,
3637 scaling_group,
3638 scale_in,
3639 scale_out):
3640 """
3641 Executes a VNF scale (adding/removing VDUs)
3642
3643 \b
3644 NS_NAME: name or ID of the NS instance.
3645 VNF_NAME: member-vnf-index in the NS to be scaled.
3646 """
3647 logger.debug("")
3648 # try:
3649 check_client_version(ctx.obj, ctx.command.name)
3650 if not scale_in and not scale_out:
3651 scale_out = True
3652 ctx.obj.ns.scale_vnf(ns_name, vnf_name, scaling_group, scale_in, scale_out)
3653 # except ClientException as e:
3654 # print(str(e))
3655 # exit(1)
3656
3657
3658 ##############################
3659 # Role Management Operations #
3660 ##############################
3661
3662 @cli_osm.command(name='role-create', short_help='creates a new role')
3663 @click.argument('name')
3664 @click.option('--permissions',
3665 default=None,
3666 help='role permissions using a dictionary')
3667 @click.pass_context
3668 def role_create(ctx, name, permissions):
3669 """
3670 Creates a new role.
3671
3672 \b
3673 NAME: Name or ID of the role.
3674 DEFINITION: Definition of grant/denial of access to resources.
3675 """
3676 logger.debug("")
3677 # try:
3678 check_client_version(ctx.obj, ctx.command.name)
3679 ctx.obj.role.create(name, permissions)
3680 # except ClientException as e:
3681 # print(str(e))
3682 # exit(1)
3683
3684
3685 @cli_osm.command(name='role-update', short_help='updates a role')
3686 @click.argument('name')
3687 @click.option('--set-name',
3688 default=None,
3689 help='change name of rle')
3690 # @click.option('--permissions',
3691 # default=None,
3692 # help='provide a yaml format dictionary with incremental changes. Values can be bool or None to delete')
3693 @click.option('--add',
3694 default=None,
3695 help='yaml format dictionary with permission: True/False to access grant/denial')
3696 @click.option('--remove',
3697 default=None,
3698 help='yaml format list to remove a permission')
3699 @click.pass_context
3700 def role_update(ctx, name, set_name, add, remove):
3701 """
3702 Updates a role.
3703
3704 \b
3705 NAME: Name or ID of the role.
3706 DEFINITION: Definition overwrites the old definition.
3707 ADD: Grant/denial of access to resource to add.
3708 REMOVE: Grant/denial of access to resource to remove.
3709 """
3710 logger.debug("")
3711 # try:
3712 check_client_version(ctx.obj, ctx.command.name)
3713 ctx.obj.role.update(name, set_name, None, add, remove)
3714 # except ClientException as e:
3715 # print(str(e))
3716 # exit(1)
3717
3718
3719 @cli_osm.command(name='role-delete', short_help='deletes a role')
3720 @click.argument('name')
3721 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
3722 @click.pass_context
3723 def role_delete(ctx, name):
3724 """
3725 Deletes a role.
3726
3727 \b
3728 NAME: Name or ID of the role.
3729 """
3730 logger.debug("")
3731 # try:
3732 check_client_version(ctx.obj, ctx.command.name)
3733 ctx.obj.role.delete(name)
3734 # except ClientException as e:
3735 # print(str(e))
3736 # exit(1)
3737
3738
3739 @cli_osm.command(name='role-list', short_help='list all roles')
3740 @click.option('--filter', default=None,
3741 help='restricts the list to the projects matching the filter')
3742 @click.pass_context
3743 def role_list(ctx, filter):
3744 """
3745 List all roles.
3746 """
3747 logger.debug("")
3748 # try:
3749 check_client_version(ctx.obj, ctx.command.name)
3750 resp = ctx.obj.role.list(filter)
3751 # except ClientException as e:
3752 # print(str(e))
3753 # exit(1)
3754 table = PrettyTable(['name', 'id'])
3755 for role in resp:
3756 table.add_row([role['name'], role['_id']])
3757 table.align = 'l'
3758 print(table)
3759
3760
3761 @cli_osm.command(name='role-show', short_help='show specific role')
3762 @click.argument('name')
3763 @click.pass_context
3764 def role_show(ctx, name):
3765 """
3766 Shows the details of a role.
3767
3768 \b
3769 NAME: Name or ID of the role.
3770 """
3771 logger.debug("")
3772 # try:
3773 check_client_version(ctx.obj, ctx.command.name)
3774 resp = ctx.obj.role.get(name)
3775 # except ClientException as e:
3776 # print(str(e))
3777 # exit(1)
3778
3779 table = PrettyTable(['key', 'attribute'])
3780 for k, v in resp.items():
3781 table.add_row([k, json.dumps(v, indent=2)])
3782 table.align = 'l'
3783 print(table)
3784
3785
3786 @cli_osm.command(name='package-create',
3787 short_help='Create a package descriptor')
3788 @click.argument('package-type')
3789 @click.argument('package-name')
3790 @click.option('--base-directory',
3791 default='.',
3792 help=('(NS/VNF/NST) Set the location for package creation. Default: "."'))
3793 @click.option('--image',
3794 default="image-name",
3795 help='(VNF) Set the name of the vdu image. Default "image-name"')
3796 @click.option('--vdus',
3797 default=1,
3798 help='(VNF) Set the number of vdus in a VNF. Default 1')
3799 @click.option('--vcpu',
3800 default=1,
3801 help='(VNF) Set the number of virtual CPUs in a vdu. Default 1')
3802 @click.option('--memory',
3803 default=1024,
3804 help='(VNF) Set the memory size (MB) of the vdu. Default 1024')
3805 @click.option('--storage',
3806 default=10,
3807 help='(VNF) Set the disk size (GB) of the vdu. Default 10')
3808 @click.option('--interfaces',
3809 default=0,
3810 help='(VNF) Set the number of additional interfaces apart from the management interface. Default 0')
3811 @click.option('--vendor',
3812 default="OSM",
3813 help='(NS/VNF) Set the descriptor vendor. Default "OSM"')
3814 @click.option('--override',
3815 default=False,
3816 is_flag=True,
3817 help='(NS/VNF/NST) Flag for overriding the package if exists.')
3818 @click.option('--detailed',
3819 is_flag=True,
3820 default=False,
3821 help='(NS/VNF/NST) Flag for generating descriptor .yaml with all possible commented options')
3822 @click.option('--netslice-subnets',
3823 default=1,
3824 help='(NST) Number of netslice subnets. Default 1')
3825 @click.option('--netslice-vlds',
3826 default=1,
3827 help='(NST) Number of netslice vlds. Default 1')
3828 @click.pass_context
3829 def package_create(ctx,
3830 package_type,
3831 base_directory,
3832 package_name,
3833 override,
3834 image,
3835 vdus,
3836 vcpu,
3837 memory,
3838 storage,
3839 interfaces,
3840 vendor,
3841 detailed,
3842 netslice_subnets,
3843 netslice_vlds):
3844 """
3845 Creates an OSM NS, VNF, NST package
3846
3847 \b
3848 PACKAGE_TYPE: Package to be created: NS, VNF or NST.
3849 PACKAGE_NAME: Name of the package to create the folder with the content.
3850 """
3851
3852 # try:
3853 check_client_version(ctx.obj, ctx.command.name)
3854 print("Creating the {} structure: {}/{}".format(package_type.upper(), base_directory, package_name))
3855 resp = ctx.obj.package_tool.create(package_type,
3856 base_directory,
3857 package_name,
3858 override=override,
3859 image=image,
3860 vdus=vdus,
3861 vcpu=vcpu,
3862 memory=memory,
3863 storage=storage,
3864 interfaces=interfaces,
3865 vendor=vendor,
3866 detailed=detailed,
3867 netslice_subnets=netslice_subnets,
3868 netslice_vlds=netslice_vlds)
3869 print(resp)
3870 # except ClientException as inst:
3871 # print("ERROR: {}".format(inst))
3872 # exit(1)
3873
3874 @cli_osm.command(name='package-validate',
3875 short_help='Validate a package descriptor')
3876 @click.argument('base-directory',
3877 default=".",
3878 required=False)
3879 @click.option('--recursive/--no-recursive',
3880 default=True,
3881 help='The activated recursive option will validate the yaml files'
3882 ' within the indicated directory and in its subdirectories')
3883 @click.pass_context
3884 def package_validate(ctx,
3885 base_directory,
3886 recursive):
3887 """
3888 Validate descriptors given a base directory.
3889
3890 \b
3891 BASE_DIRECTORY: Stub folder for NS, VNF or NST package.
3892 """
3893 # try:
3894 check_client_version(ctx.obj, ctx.command.name)
3895 results = ctx.obj.package_tool.validate(base_directory, recursive)
3896 table = PrettyTable()
3897 table.field_names = ["TYPE", "PATH", "VALID", "ERROR"]
3898 # Print the dictionary generated by the validation function
3899 for result in results:
3900 table.add_row([result["type"], result["path"], result["valid"], result["error"]])
3901 table.sortby = "VALID"
3902 table.align["PATH"] = "l"
3903 table.align["TYPE"] = "l"
3904 table.align["ERROR"] = "l"
3905 print(table)
3906 # except ClientException as inst:
3907 # print("ERROR: {}".format(inst))
3908 # exit(1)
3909
3910 @cli_osm.command(name='package-build',
3911 short_help='Build the tar.gz of the package')
3912 @click.argument('package-folder')
3913 @click.option('--skip-validation',
3914 default=False,
3915 is_flag=True,
3916 help='skip package validation')
3917 @click.option('--skip-charm-build', default=False, is_flag=True,
3918 help='the charm will not be compiled, it is assumed to already exist')
3919 @click.pass_context
3920 def package_build(ctx,
3921 package_folder,
3922 skip_validation,
3923 skip_charm_build):
3924 """
3925 Build the package NS, VNF given the package_folder.
3926
3927 \b
3928 PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged
3929 """
3930 # try:
3931 check_client_version(ctx.obj, ctx.command.name)
3932 results = ctx.obj.package_tool.build(package_folder,
3933 skip_validation=skip_validation,
3934 skip_charm_build=skip_charm_build)
3935 print(results)
3936 # except ClientException as inst:
3937 # print("ERROR: {}".format(inst))
3938 # exit(1)
3939
3940
3941 def cli():
3942 try:
3943 cli_osm()
3944 exit(0)
3945 except pycurl.error as exc:
3946 print(exc)
3947 print('Maybe "--hostname" option or OSM_HOSTNAME environment variable needs to be specified')
3948 except ClientException as exc:
3949 print("ERROR: {}".format(exc))
3950 except (FileNotFoundError, PermissionError) as exc:
3951 print("Cannot open file: {}".format(exc))
3952 except yaml.YAMLError as exc:
3953 print("Invalid YAML format: {}".format(exc))
3954 exit(1)
3955 # TODO capture other controlled exceptions here
3956 # TODO remove the ClientException captures from all places, unless they do something different
3957
3958
3959 if __name__ == '__main__':
3960 cli()
3961