X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=d66bcfe21e87b2b3d2f58f13b2b4894cb6b0cc81;hb=e79f0cafb1e4f8b065708187c6dd0f58b56a2aeb;hp=fe140dd48382f4347d1b49036bed08de43e985cc;hpb=09fa3d4dffb1fd9ea427f32a32264dd3bda56543;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index fe140dd..d66bcfe 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -27,6 +27,20 @@ import json import time import pycurl import os +import textwrap + + +def wrap_text(text, width): + wrapper = textwrap.TextWrapper(width=width) + lines = text.splitlines() + return "\n".join(map(wrapper.fill, lines)) + + +def trunc_text(text, length): + if len(text) > length: + return text[:(length - 3)] + '...' + else: + return text def check_client_version(obj, what, version='sol005'): @@ -47,7 +61,9 @@ def check_client_version(obj, what, version='sol005'): return -@click.group() +CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'], max_content_width=160) + +@click.group(context_settings=CONTEXT_SETTINGS) @click.option('--hostname', default="127.0.0.1", envvar='OSM_HOSTNAME', @@ -124,7 +140,7 @@ def cli(ctx, hostname, user, password, project): # LIST operations #################### -@cli.command(name='ns-list') +@cli.command(name='ns-list', short_help='list all NS instances') @click.option('--filter', default=None, help='restricts the list to the NS instances matching the filter.') @click.pass_context @@ -201,8 +217,10 @@ def ns_list(ctx, filter): opstatus = nsr['operational-status'] if 'operational-status' in nsr else 'Not found' configstatus = nsr['config-status'] if 'config-status' in nsr else 'Not found' detailed_status = nsr['detailed-status'] if 'detailed-status' in nsr else 'Not found' + detailed_status = wrap_text(text=detailed_status,width=50) if configstatus == "config_not_needed": configstatus = "configured (no charms)" + table.add_row( [nsr_name, nsr_id, @@ -233,7 +251,7 @@ def nsd_list(ctx, filter): print(table) -@cli.command(name='nsd-list') +@cli.command(name='nsd-list', short_help='list all NS packages') @click.option('--filter', default=None, help='restricts the list to the NSD/NSpkg matching the filter') @click.pass_context @@ -242,12 +260,12 @@ def nsd_list1(ctx, filter): nsd_list(ctx, filter) -@cli.command(name='nspkg-list') +@cli.command(name='nspkg-list', short_help='list all NS packages') @click.option('--filter', default=None, help='restricts the list to the NSD/NSpkg matching the filter') @click.pass_context def nsd_list2(ctx, filter): - """list all NSD/NS pkg in the system""" + """list all NS packages""" nsd_list(ctx, filter) @@ -287,38 +305,38 @@ def vnfd_list(ctx, nf_type, filter): print(table) -@cli.command(name='vnfd-list') +@cli.command(name='vnfd-list', short_help='list all xNF packages (VNF, HNF, PNF)') @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') @click.option('--filter', default=None, help='restricts the list to the NF pkg matching the filter') @click.pass_context def vnfd_list1(ctx, nf_type, filter): - """list all VNFD/VNF pkg in the system""" + """list all xNF packages (VNF, HNF, PNF)""" vnfd_list(ctx, nf_type, filter) -@cli.command(name='vnfpkg-list') +@cli.command(name='vnfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)') @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') @click.option('--filter', default=None, help='restricts the list to the NFpkg matching the filter') @click.pass_context def vnfd_list2(ctx, nf_type, filter): - """list all VNFD/VNF pkg in the system""" + """list all xNF packages (VNF, HNF, PNF)""" vnfd_list(ctx, nf_type, filter) -@cli.command(name='nfpkg-list') +@cli.command(name='nfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)') @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') @click.option('--filter', default=None, help='restricts the list to the NFpkg matching the filter') @click.pass_context def nfpkg_list(ctx, nf_type, filter): - """list all NF pkg (VNF pkg, PNF pkg, HNF pkg) in the system""" + """list all xNF packages (VNF, HNF, PNF)""" try: check_client_version(ctx.obj, ctx.command.name) vnfd_list(ctx, nf_type, filter) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -332,8 +350,8 @@ def vnf_list(ctx, ns, filter): resp = ctx.obj.vnf.list(ns, filter) else: resp = ctx.obj.vnf.list() - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': @@ -374,7 +392,7 @@ def vnf_list(ctx, ns, filter): print(table) -@cli.command(name='vnf-list') +@cli.command(name='vnf-list', short_help='list all NF instances') @click.option('--ns', default=None, help='NS instance id or name to restrict the NF list') @click.option('--filter', default=None, help='restricts the list to the NF instances matching the filter.') @@ -384,7 +402,7 @@ def vnf_list1(ctx, ns, filter): vnf_list(ctx, ns, filter) -@cli.command(name='nf-list') +@cli.command(name='nf-list', short_help='list all NF instances') @click.option('--ns', default=None, help='NS instance id or name to restrict the NF list') @click.option('--filter', default=None, help='restricts the list to the NF instances matching the filter.') @@ -440,7 +458,7 @@ def nf_list(ctx, ns, filter): vnf_list(ctx, ns, filter) -@cli.command(name='ns-op-list') +@cli.command(name='ns-op-list', short_help='shows the history of operations over a NS instance') @click.argument('name') @click.pass_context def ns_op_list(ctx, name): @@ -451,13 +469,17 @@ def ns_op_list(ctx, name): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.ns.list_op(name) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) - table = PrettyTable(['id', 'operation', 'status']) + table = PrettyTable(['id', 'operation', 'action_name', 'status']) + #print(yaml.safe_dump(resp)) for op in resp: - table.add_row([op['id'], op['lcmOperationType'], + action_name = "N/A" + if op['lcmOperationType']=='action': + action_name = op['operationParams']['primitive'] + table.add_row([op['id'], op['lcmOperationType'], action_name, op['operationState']]) table.align = 'l' print(table) @@ -468,8 +490,8 @@ def nsi_list(ctx, filter): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.nsi.list(filter) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable( ['netslice instance name', @@ -495,7 +517,7 @@ def nsi_list(ctx, filter): print(table) -@cli.command(name='nsi-list') +@cli.command(name='nsi-list', short_help='list all Network Slice Instances (NSI)') @click.option('--filter', default=None, help='restricts the list to the Network Slice Instances matching the filter') @click.pass_context @@ -504,7 +526,7 @@ def nsi_list1(ctx, filter): nsi_list(ctx, filter) -@cli.command(name='netslice-instance-list') +@cli.command(name='netslice-instance-list', short_help='list all Network Slice Instances (NSI)') @click.option('--filter', default=None, help='restricts the list to the Network Slice Instances matching the filter') @click.pass_context @@ -517,8 +539,8 @@ def nst_list(ctx, filter): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.nst.list(filter) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) # print(yaml.safe_dump(resp)) table = PrettyTable(['nst name', 'id']) @@ -529,7 +551,7 @@ def nst_list(ctx, filter): print(table) -@cli.command(name='nst-list') +@cli.command(name='nst-list', short_help='list all Network Slice Templates (NST)') @click.option('--filter', default=None, help='restricts the list to the NST matching the filter') @click.pass_context @@ -538,7 +560,7 @@ def nst_list1(ctx, filter): nst_list(ctx, filter) -@cli.command(name='netslice-template-list') +@cli.command(name='netslice-template-list', short_help='list all Network Slice Templates (NST)') @click.option('--filter', default=None, help='restricts the list to the NST matching the filter') @click.pass_context @@ -551,8 +573,8 @@ def nsi_op_list(ctx, name): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.nsi.list_op(name) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['id', 'operation', 'status']) for op in resp: @@ -562,7 +584,7 @@ def nsi_op_list(ctx, name): print(table) -@cli.command(name='nsi-op-list') +@cli.command(name='nsi-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)') @click.argument('name') @click.pass_context def nsi_op_list1(ctx, name): @@ -573,7 +595,7 @@ def nsi_op_list1(ctx, name): nsi_op_list(ctx, name) -@cli.command(name='netslice-instance-op-list') +@cli.command(name='netslice-instance-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)') @click.argument('name') @click.pass_context def nsi_op_list2(ctx, name): @@ -584,7 +606,7 @@ def nsi_op_list2(ctx, name): nsi_op_list(ctx, name) -@cli.command(name='pdu-list') +@cli.command(name='pdu-list', short_help='list all Physical Deployment Units (PDU)') @click.option('--filter', default=None, help='restricts the list to the Physical Deployment Units matching the filter') @click.pass_context @@ -593,8 +615,8 @@ def pdu_list(ctx, filter): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.pdu.list(filter) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable( ['pdu name', @@ -627,8 +649,8 @@ def nsd_show(ctx, name, literal): try: resp = ctx.obj.nsd.get(name) # resp = ctx.obj.nsd.get_individual(name) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) if literal: @@ -672,8 +694,8 @@ def vnfd_show(ctx, name, literal): try: resp = ctx.obj.vnfd.get(name) # resp = ctx.obj.vnfd.get_individual(name) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) if literal: @@ -739,8 +761,8 @@ def ns_show(ctx, name, literal, filter): """ try: ns = ctx.obj.ns.get(name) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) if literal: @@ -751,7 +773,7 @@ def ns_show(ctx, name, literal, filter): for k, v in list(ns.items()): if filter is None or filter in k: - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname != 'osmclient.sol005.client.Client': @@ -759,7 +781,7 @@ def ns_show(ctx, name, literal, filter): nsr_optdata = nsopdata['nsr:nsr'] for k, v in list(nsr_optdata.items()): if filter is None or filter in k: - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(json.dumps(v, indent=2),width=100)]) table.align = 'l' print(table) @@ -768,30 +790,56 @@ def ns_show(ctx, name, literal, filter): @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') -@click.option('--filter', default=None) +@click.option('--filter', default=None, help='restricts the information to the fields in the filter') +@click.option('--kdu', default=None, help='KDU name (whose status will be shown)') @click.pass_context -def vnf_show(ctx, name, literal, filter): +def vnf_show(ctx, name, literal, filter, kdu): """shows the info of a VNF instance NAME: name or ID of the VNF instance """ + if kdu: + if literal: + raise ClientException('"--literal" option is incompatible with "--kdu" option') + if filter: + raise ClientException('"--filter" option is incompatible with "--kdu" option') + try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.vnf.get(name) - except ClientException as inst: - print((inst.message)) - exit(1) - if literal: - print(yaml.safe_dump(resp)) - return - - table = PrettyTable(['field', 'value']) - for k, v in list(resp.items()): - if filter is None or filter in k: - table.add_row([k, json.dumps(v, indent=2)]) - table.align = 'l' - print(table) + if kdu: + ns_id = resp['nsr-id-ref'] + op_data={} + op_data['member_vnf_index'] = resp['member-vnf-index-ref'] + op_data['kdu_name'] = kdu + op_data['primitive'] = 'status' + op_data['primitive_params'] = {} + op_id = ctx.obj.ns.exec_op(ns_id, op_name='action', op_data=op_data, wait=False) + t = 0 + while t<30: + op_info = ctx.obj.ns.get_op(op_id) + if op_info['operationState'] == 'COMPLETED': + print(op_info['detailed-status']) + return + time.sleep(5) + t += 5 + print ("Could not determine KDU status") + + if literal: + print(yaml.safe_dump(resp)) + return + + table = PrettyTable(['field', 'value']) + + for k, v in list(resp.items()): + if filter is None or filter in k: + table.add_row([k, wrap_text(text=json.dumps(v,indent=2),width=100)]) + table.align = 'l' + print(table) + except ClientException as e: + print(str(e)) + exit(1) #@cli.command(name='vnf-monitoring-show') @@ -801,8 +849,8 @@ def vnf_show(ctx, name, literal, filter): # try: # check_client_version(ctx.obj, ctx.command.name, 'v1') # resp = ctx.obj.vnf.get_monitoring(vnf_name) -# except ClientException as inst: -# print((inst.message)) +# except ClientException as e: +# print(str(e)) # exit(1) # # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units']) @@ -824,8 +872,8 @@ def vnf_show(ctx, name, literal, filter): # try: # check_client_version(ctx.obj, ctx.command.name, 'v1') # resp = ctx.obj.ns.get_monitoring(ns_name) -# except ClientException as inst: -# print((inst.message)) +# except ClientException as e: +# print(str(e)) # exit(1) # # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units']) @@ -840,26 +888,32 @@ def vnf_show(ctx, name, literal, filter): # print(table) -@cli.command(name='ns-op-show', short_help='shows the info of an operation') +@cli.command(name='ns-op-show', short_help='shows the info of a NS operation') @click.argument('id') @click.option('--filter', default=None) +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') @click.pass_context -def ns_op_show(ctx, id, filter): - """shows the detailed info of an operation +def ns_op_show(ctx, id, filter, literal): + """shows the detailed info of a NS operation ID: operation identifier """ try: check_client_version(ctx.obj, ctx.command.name) op_info = ctx.obj.ns.get_op(id) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) + if literal: + print(yaml.safe_dump(op_info)) + return + table = PrettyTable(['field', 'value']) for k, v in list(op_info.items()): if filter is None or filter in k: - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(json.dumps(v, indent=2), 100)]) table.align = 'l' print(table) @@ -869,8 +923,8 @@ def nst_show(ctx, name, literal): check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.nst.get(name) #resp = ctx.obj.nst.get_individual(name) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) if literal: @@ -879,7 +933,7 @@ def nst_show(ctx, name, literal): table = PrettyTable(['field', 'value']) for k, v in list(resp.items()): - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(json.dumps(v, indent=2), 100)]) table.align = 'l' print(table) @@ -914,8 +968,8 @@ def nsi_show(ctx, name, literal, filter): try: check_client_version(ctx.obj, ctx.command.name) nsi = ctx.obj.nsi.get(name) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) if literal: @@ -964,8 +1018,8 @@ def nsi_op_show(ctx, id, filter): try: check_client_version(ctx.obj, ctx.command.name) op_info = ctx.obj.nsi.get_op(id) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['field', 'value']) @@ -1014,8 +1068,8 @@ def pdu_show(ctx, name, literal, filter): try: check_client_version(ctx.obj, ctx.command.name) pdu = ctx.obj.pdu.get(name) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) if literal: @@ -1040,15 +1094,18 @@ def nsd_create(ctx, filename, overwrite): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.nsd.create(filename, overwrite) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @cli.command(name='nsd-create', short_help='creates a new NSD/NSpkg') @click.argument('filename') -@click.option('--overwrite', default=None, - help='overwrites some fields in NSD') +@click.option('--overwrite', 'overwrite', default=None, + help='overwrite deprecated, use override') +@click.option('--override', 'overwrite', default=None, + help='overrides fields in descriptor, format: ' + '"key1.key2...=value[;key3...=value;...]"') @click.pass_context def nsd_create1(ctx, filename, overwrite): """creates a new NSD/NSpkg @@ -1060,8 +1117,11 @@ def nsd_create1(ctx, filename, overwrite): @cli.command(name='nspkg-create', short_help='creates a new NSD/NSpkg') @click.argument('filename') -@click.option('--overwrite', default=None, - help='overwrites some fields in NSD') +@click.option('--overwrite', 'overwrite', default=None, + help='overwrite deprecated, use override') +@click.option('--override', 'overwrite', default=None, + help='overrides fields in descriptor, format: ' + '"key1.key2...=value[;key3...=value;...]"') @click.pass_context def nsd_create2(ctx, filename, overwrite): """creates a new NSD/NSpkg @@ -1075,15 +1135,18 @@ def vnfd_create(ctx, filename, overwrite): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.vnfd.create(filename, overwrite) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @cli.command(name='vnfd-create', short_help='creates a new VNFD/VNFpkg') @click.argument('filename') -@click.option('--overwrite', default=None, - help='overwrites some fields in VNFD') +@click.option('--overwrite', 'overwrite', default=None, + help='overwrite deprecated, use override') +@click.option('--override', 'overwrite', default=None, + help='overrides fields in descriptor, format: ' + '"key1.key2...=value[;key3...=value;...]"') @click.pass_context def vnfd_create1(ctx, filename, overwrite): """creates a new VNFD/VNFpkg @@ -1095,8 +1158,11 @@ def vnfd_create1(ctx, filename, overwrite): @cli.command(name='vnfpkg-create', short_help='creates a new VNFD/VNFpkg') @click.argument('filename') -@click.option('--overwrite', default=None, - help='overwrites some fields in VNFD') +@click.option('--overwrite', 'overwrite', default=None, + help='overwrite deprecated, use override') +@click.option('--override', 'overwrite', default=None, + help='overrides fields in descriptor, format: ' + '"key1.key2...=value[;key3...=value;...]"') @click.pass_context def vnfd_create2(ctx, filename, overwrite): """creates a new VNFD/VNFpkg @@ -1108,8 +1174,11 @@ def vnfd_create2(ctx, filename, overwrite): @cli.command(name='nfpkg-create', short_help='creates a new NFpkg') @click.argument('filename') -@click.option('--overwrite', default=None, - help='overwrites some fields in NFD') +@click.option('--overwrite', 'overwrite', default=None, + help='overwrite deprecated, use override') +@click.option('--override', 'overwrite', default=None, + help='overrides fields in descriptor, format: ' + '"key1.key2...=value[;key3...=value;...]"') @click.pass_context def nfpkg_create(ctx, filename, overwrite): """creates a new NFpkg @@ -1169,8 +1238,8 @@ def ns_create(ctx, ssh_keys=ssh_keys, account=vim_account, wait=wait) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) @@ -1178,15 +1247,18 @@ def nst_create(ctx, filename, overwrite): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.nst.create(filename, overwrite) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @cli.command(name='nst-create', short_help='creates a new Network Slice Template (NST)') @click.argument('filename') -@click.option('--overwrite', default=None, - help='overwrites some fields in NST') +@click.option('--overwrite', 'overwrite', default=None, + help='overwrites deprecated use override') +@click.option('--override', 'overwrite' ,default=None, + help='overrides fields in descriptor, format: ' + '"key1.key2...=value[;key3...=value;...]"') @click.pass_context def nst_create1(ctx, filename, overwrite): """creates a new Network Slice Template (NST) @@ -1198,8 +1270,11 @@ def nst_create1(ctx, filename, overwrite): @cli.command(name='netslice-template-create', short_help='creates a new Network Slice Template (NST)') @click.argument('filename') -@click.option('--overwrite', default=None, - help='overwrites some fields in NST') +@click.option('--overwrite', 'overwrite', default=None, + help='overwrites deprecated use override') +@click.option('--override', 'overwrite', default=None, + help='overrides fields in descriptor, format: ' + '"key1.key2...=value[;key3...=value;...]"') @click.pass_context def nst_create2(ctx, filename, overwrite): """creates a new Network Slice Template (NST) @@ -1220,8 +1295,8 @@ def nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_fi config=cf.read() ctx.obj.nsi.create(nst_name, nsi_name, config=config, ssh_keys=ssh_keys, account=vim_account, wait=wait) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) @@ -1314,7 +1389,7 @@ def pdu_create(ctx, name, pdu_type, interface, description, vim_account, descrip raise ClientException('in absence of descriptor file, option "--vim_account" is mandatory (at least once)') else: with open(descriptor_file, 'r') as df: - pdu = yaml.load(df.read()) + pdu = yaml.safe_load(df.read()) if name: pdu["name"] = name if pdu_type: pdu["type"] = pdu_type if description: pdu["description"] = description @@ -1327,8 +1402,8 @@ def pdu_create(ctx, name, pdu_type, interface, description, vim_account, descrip ifaces_list.append(new_iface) pdu["interfaces"] = ifaces_list ctx.obj.pdu.create(pdu) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) #################### @@ -1339,8 +1414,8 @@ def nsd_update(ctx, name, content): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.nsd.update(name, content) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1374,8 +1449,8 @@ def vnfd_update(ctx, name, content): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.vnfd.update(name, content) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1422,8 +1497,8 @@ def nst_update(ctx, name, content): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.nst.update(name, content) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1464,8 +1539,8 @@ def nsd_delete(ctx, name, force): else: check_client_version(ctx.obj, '--force') ctx.obj.nsd.delete(name, force) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1500,8 +1575,8 @@ def vnfd_delete(ctx, name, force): else: check_client_version(ctx.obj, '--force') ctx.obj.vnfd.delete(name, force) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1562,8 +1637,8 @@ def ns_delete(ctx, name, force, wait): else: check_client_version(ctx.obj, '--force') ctx.obj.ns.delete(name, force, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1571,8 +1646,8 @@ def nst_delete(ctx, name, force): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.nst.delete(name, force) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1604,8 +1679,8 @@ def nsi_delete(ctx, name, force, wait): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.nsi.delete(name, force, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1651,8 +1726,8 @@ def pdu_delete(ctx, name, force): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.pdu.delete(name, force) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1660,7 +1735,7 @@ def pdu_delete(ctx, name, force): # VIM operations ################# -@cli.command(name='vim-create') +@cli.command(name='vim-create', short_help='creates a new VIM account') @click.option('--name', prompt=True, help='Name to create datacenter') @@ -1726,8 +1801,8 @@ def vim_create(ctx, ctx.obj.vim.create(name, vim, sdn_controller, sdn_port_mapping, wait=wait) else: ctx.obj.vim.create(name, vim, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1779,12 +1854,12 @@ def vim_update(ctx, if description: vim['description'] = description if config: vim['config'] = config ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='vim-delete') +@cli.command(name='vim-delete', short_help='deletes a VIM account') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') @click.option('--wait', @@ -1805,12 +1880,12 @@ def vim_delete(ctx, name, force, wait): else: check_client_version(ctx.obj, '--force') ctx.obj.vim.delete(name, force, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='vim-list') +@cli.command(name='vim-list', short_help='list all VIM accounts') #@click.option('--ro_update/--no_ro_update', # default=False, # help='update list from RO') @@ -1835,7 +1910,7 @@ def vim_list(ctx, filter): print(table) -@cli.command(name='vim-show') +@cli.command(name='vim-show', short_help='shows the details of a VIM account') @click.argument('name') @click.pass_context def vim_show(ctx, name): @@ -1847,13 +1922,13 @@ def vim_show(ctx, name): resp = ctx.obj.vim.get(name) if 'vim_password' in resp: resp['vim_password']='********' - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['key', 'attribute']) for k, v in list(resp.items()): - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) table.align = 'l' print(table) @@ -1862,7 +1937,7 @@ def vim_show(ctx, name): # WIM operations #################### -@cli.command(name='wim-create') +@cli.command(name='wim-create', short_help='creates a new WIM account') @click.option('--name', prompt=True, help='Name for the WIM account') @@ -1918,8 +1993,8 @@ def wim_create(ctx, if description: wim['description'] = description if config: wim['config'] = config ctx.obj.wim.create(name, wim, wim_port_mapping, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -1967,12 +2042,12 @@ def wim_update(ctx, if description: wim['description'] = description if config: wim['config'] = config ctx.obj.wim.update(name, wim, wim_port_mapping, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='wim-delete') +@cli.command(name='wim-delete', short_help='deletes a WIM account') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') @click.option('--wait', @@ -1990,12 +2065,12 @@ def wim_delete(ctx, name, force, wait): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.wim.delete(name, force, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='wim-list') +@cli.command(name='wim-list', short_help='list all WIM accounts') @click.option('--filter', default=None, help='restricts the list to the WIM accounts matching the filter') @click.pass_context @@ -2009,12 +2084,12 @@ def wim_list(ctx, filter): table.add_row([wim['name'], wim['uuid']]) table.align = 'l' print(table) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='wim-show') +@cli.command(name='wim-show', short_help='shows the details of a WIM account') @click.argument('name') @click.pass_context def wim_show(ctx, name): @@ -2027,8 +2102,8 @@ def wim_show(ctx, name): resp = ctx.obj.wim.get(name) if 'password' in resp: resp['wim_password']='********' - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['key', 'attribute']) @@ -2042,7 +2117,7 @@ def wim_show(ctx, name): # SDN controller operations #################### -@cli.command(name='sdnc-create') +@cli.command(name='sdnc-create', short_help='creates a new SDN controller') @click.option('--name', prompt=True, help='Name to create sdn controller') @@ -2103,8 +2178,8 @@ def sdnc_create(ctx, try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.sdnc.create(name, sdncontroller, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @cli.command(name='sdnc-update', short_help='updates an SDN controller') @@ -2165,12 +2240,12 @@ def sdnc_update(ctx, try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.sdnc.update(name, sdncontroller, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='sdnc-delete') +@cli.command(name='sdnc-delete', short_help='deletes an SDN controller') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') @click.option('--wait', @@ -2188,12 +2263,12 @@ def sdnc_delete(ctx, name, force, wait): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.sdnc.delete(name, force, wait=wait) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='sdnc-list') +@cli.command(name='sdnc-list', short_help='list all SDN controllers') @click.option('--filter', default=None, help='restricts the list to the SDN controllers matching the filter') @click.pass_context @@ -2202,8 +2277,8 @@ def sdnc_list(ctx, filter): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.sdnc.list(filter) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['sdnc name', 'id']) for sdnc in resp: @@ -2212,7 +2287,7 @@ def sdnc_list(ctx, filter): print(table) -@cli.command(name='sdnc-show') +@cli.command(name='sdnc-show', short_help='shows the details of an SDN controller') @click.argument('name') @click.pass_context def sdnc_show(ctx, name): @@ -2223,8 +2298,8 @@ def sdnc_show(ctx, name): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.sdnc.get(name) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['key', 'attribute']) @@ -2234,11 +2309,343 @@ def sdnc_show(ctx, name): print(table) +########################### +# K8s cluster operations +########################### + +@cli.command(name='k8scluster-add') +@click.argument('name') +@click.option('--creds', + prompt=True, + help='credentials file, i.e. a valid `.kube/config` file') +@click.option('--version', + prompt=True, + help='Kubernetes version') +@click.option('--vim', + prompt=True, + help='VIM target, the VIM where the cluster resides') +@click.option('--k8s-nets', + prompt=True, + 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) ...]}"') +@click.option('--description', + default='', + help='human readable description') +@click.option('--namespace', + default='kube-system', + help='namespace to be used for its operation, defaults to `kube-system`') +@click.option('--cni', + default=None, + help='list of CNI plugins, in JSON inline format, used in the cluster') +#@click.option('--skip-init', +# is_flag=True, +# help='If set, K8s cluster is assumed to be ready for its use with OSM') +#@click.option('--wait', +# is_flag=True, +# help='do not return the control immediately, but keep it \ +# until the operation is completed, or timeout') +@click.pass_context +def k8scluster_add(ctx, + name, + creds, + version, + vim, + k8s_nets, + description, + namespace, + cni): + """adds a K8s cluster to OSM + + NAME: name of the K8s cluster + """ + try: + check_client_version(ctx.obj, ctx.command.name) + cluster = {} + cluster['name'] = name + with open(creds, 'r') as cf: + cluster['credentials'] = yaml.safe_load(cf.read()) + cluster['k8s_version'] = version + cluster['vim_account'] = vim + cluster['nets'] = yaml.safe_load(k8s_nets) + cluster['description'] = description + if namespace: cluster['namespace'] = namespace + if cni: cluster['cni'] = yaml.safe_load(cni) + ctx.obj.k8scluster.create(name, cluster) + except ClientException as e: + print(str(e)) + exit(1) + + +@cli.command(name='k8scluster-update', short_help='updates a K8s cluster') +@click.argument('name') +@click.option('--newname', help='New name for the K8s cluster') +@click.option('--creds', help='credentials file, i.e. a valid `.kube/config` file') +@click.option('--version', help='Kubernetes version') +@click.option('--vim', help='VIM target, the VIM where the cluster resides') +@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) ...]}"') +@click.option('--description', help='human readable description') +@click.option('--namespace', help='namespace to be used for its operation, defaults to `kube-system`') +@click.option('--cni', help='list of CNI plugins, in JSON inline format, used in the cluster') +@click.pass_context +def k8scluster_update(ctx, + name, + newname, + creds, + version, + vim, + k8s_nets, + description, + namespace, + cni): + """updates a K8s cluster + + NAME: name or ID of the K8s cluster + """ + try: + check_client_version(ctx.obj, ctx.command.name) + cluster = {} + if newname: cluster['name'] = newname + if creds: + with open(creds, 'r') as cf: + cluster['credentials'] = yaml.safe_load(cf.read()) + if version: cluster['k8s_version'] = version + if vim: cluster['vim_account'] = vim + if k8s_nets: cluster['nets'] = yaml.safe_load(k8s_nets) + if description: cluster['description'] = description + if namespace: cluster['namespace'] = namespace + if cni: cluster['cni'] = yaml.safe_load(cni) + ctx.obj.k8scluster.update(name, cluster) + except ClientException as e: + print(str(e)) + exit(1) + + +@cli.command(name='k8scluster-delete') +@click.argument('name') +@click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)') +#@click.option('--wait', +# is_flag=True, +# help='do not return the control immediately, but keep it \ +# until the operation is completed, or timeout') +@click.pass_context +def k8scluster_delete(ctx, name, force): + """deletes a K8s cluster + + NAME: name or ID of the K8s cluster to be deleted + """ + try: + check_client_version(ctx.obj, ctx.command.name) + ctx.obj.k8scluster.delete(name, force=force) + except ClientException as e: + print(str(e)) + exit(1) + + +@cli.command(name='k8scluster-list') +@click.option('--filter', default=None, + help='restricts the list to the K8s clusters matching the filter') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.pass_context +def k8scluster_list(ctx, filter, literal): + """list all K8s clusters""" + try: + check_client_version(ctx.obj, ctx.command.name) + resp = ctx.obj.k8scluster.list(filter) + if literal: + print(yaml.safe_dump(resp)) + return + table = PrettyTable(['Name', 'Id', 'Version', 'VIM', 'K8s-nets', 'Description']) + for cluster in resp: + table.add_row([cluster['name'], cluster['_id'], cluster['k8s_version'], cluster['vim_account'], + json.dumps(cluster['nets']), trunc_text(cluster.get('description',''),40) + ]) + table.align = 'l' + print(table) + except ClientException as e: + print(str(e)) + exit(1) + + +@cli.command(name='k8scluster-show') +@click.argument('name') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.pass_context +def k8scluster_show(ctx, name, literal): + """shows the details of a K8s cluster + + NAME: name or ID of the K8s cluster + """ + try: + resp = ctx.obj.k8scluster.get(name) + if literal: + print(yaml.safe_dump(resp)) + return + table = PrettyTable(['key', 'attribute']) + for k, v in list(resp.items()): + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) + table.align = 'l' + print(table) + except ClientException as e: + print(str(e)) + exit(1) + + + +########################### +# Repo operations +########################### + +@cli.command(name='repo-add') +@click.argument('name') +@click.argument('uri') +@click.option('--type', + type=click.Choice(['chart', 'bundle']), + prompt=True, + help='type of repo (chart for helm-charts, bundle for juju-bundles)') +@click.option('--description', + default='', + help='human readable description') +#@click.option('--wait', +# is_flag=True, +# help='do not return the control immediately, but keep it \ +# until the operation is completed, or timeout') +@click.pass_context +def repo_add(ctx, + name, + uri, + type, + description): + """adds a repo to OSM + + NAME: name of the repo + URI: URI of the repo + """ + try: + check_client_version(ctx.obj, ctx.command.name) + repo = {} + repo['name'] = name + repo['url'] = uri + repo['type'] = type + repo['description'] = description + ctx.obj.repo.create(name, repo) + except ClientException as e: + print(str(e)) + exit(1) + + +@cli.command(name='repo-update') +@click.argument('name') +@click.option('--newname', help='New name for the repo') +@click.option('--uri', help='URI of the repo') +@click.option('--type', type=click.Choice(['chart', 'bundle']), + help='type of repo (chart for helm-charts, bundle for juju-bundles)') +@click.option('--description', help='human readable description') +#@click.option('--wait', +# is_flag=True, +# help='do not return the control immediately, but keep it \ +# until the operation is completed, or timeout') +@click.pass_context +def repo_update(ctx, + name, + newname, + uri, + type, + description): + """updates a repo in OSM + + NAME: name of the repo + """ + try: + check_client_version(ctx.obj, ctx.command.name) + repo = {} + if newname: repo['name'] = newname + if uri: repo['uri'] = uri + if type: repo['type'] = type + if description: repo['description'] = description + ctx.obj.repo.update(name, repo) + except ClientException as e: + print(str(e)) + exit(1) + + +@cli.command(name='repo-delete') +@click.argument('name') +@click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)') +#@click.option('--wait', +# is_flag=True, +# help='do not return the control immediately, but keep it \ +# until the operation is completed, or timeout') +@click.pass_context +def repo_delete(ctx, name, force): + """deletes a repo + + NAME: name or ID of the repo to be deleted + """ + try: + check_client_version(ctx.obj, ctx.command.name) + ctx.obj.repo.delete(name, force=force) + except ClientException as e: + print(str(e)) + exit(1) + + +@cli.command(name='repo-list') +@click.option('--filter', default=None, + help='restricts the list to the repos matching the filter') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.pass_context +def repo_list(ctx, filter, literal): + """list all repos""" + try: + check_client_version(ctx.obj, ctx.command.name) + resp = ctx.obj.repo.list(filter) + if literal: + print(yaml.safe_dump(resp)) + return + table = PrettyTable(['Name', 'Id', 'Type', 'URI', 'Description']) + for repo in resp: + #cluster['k8s-nets'] = json.dumps(yaml.safe_load(cluster['k8s-nets'])) + table.add_row([repo['name'], repo['_id'], repo['type'], repo['url'], trunc_text(repo.get('description',''),40)]) + table.align = 'l' + print(table) + except ClientException as e: + print(str(e)) + exit(1) + + +@cli.command(name='repo-show') +@click.argument('name') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.pass_context +def repo_show(ctx, name, literal): + """shows the details of a repo + + NAME: name or ID of the repo + """ + try: + resp = ctx.obj.repo.get(name) + if literal: + print(yaml.safe_dump(resp)) + return + table = PrettyTable(['key', 'attribute']) + for k, v in list(resp.items()): + table.add_row([k, json.dumps(v, indent=2)]) + table.align = 'l' + print(table) + except ClientException as e: + print(str(e)) + exit(1) + + + #################### # Project mgmt operations #################### -@cli.command(name='project-create') +@cli.command(name='project-create', short_help='creates a new project') @click.argument('name') #@click.option('--description', # default='no description', @@ -2254,12 +2661,12 @@ def project_create(ctx, name): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.project.create(name, project) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='project-delete') +@cli.command(name='project-delete', short_help='deletes a project') @click.argument('name') #@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') @click.pass_context @@ -2271,12 +2678,12 @@ def project_delete(ctx, name): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.project.delete(name) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='project-list') +@cli.command(name='project-list', short_help='list all projects') @click.option('--filter', default=None, help='restricts the list to the projects matching the filter') @click.pass_context @@ -2285,8 +2692,8 @@ def project_list(ctx, filter): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.project.list(filter) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['name', 'id']) for proj in resp: @@ -2295,7 +2702,7 @@ def project_list(ctx, filter): print(table) -@cli.command(name='project-show') +@cli.command(name='project-show', short_help='shows the details of a project') @click.argument('name') @click.pass_context def project_show(ctx, name): @@ -2306,8 +2713,8 @@ def project_show(ctx, name): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.project.get(name) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['key', 'attribute']) @@ -2317,7 +2724,7 @@ def project_show(ctx, name): print(table) -@cli.command(name='project-update') +@cli.command(name='project-update', short_help='updates a project (only the name can be updated)') @click.argument('project') @click.option('--name', prompt=True, @@ -2340,15 +2747,15 @@ def project_update(ctx, project, name): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.project.update(project, project_changes) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) #################### # User mgmt operations #################### -@cli.command(name='user-create') +@cli.command(name='user-create', short_help='creates a new user') @click.argument('username') @click.option('--password', prompt=True, @@ -2382,12 +2789,12 @@ def user_create(ctx, username, password, projects, project_role_mappings): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.user.create(username, user) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='user-update') +@cli.command(name='user-update', short_help='updates user information') @click.argument('username') @click.option('--password', # prompt=True, @@ -2434,12 +2841,12 @@ def user_update(ctx, username, password, set_username, set_project, remove_proje try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.user.update(username, user) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='user-delete') +@cli.command(name='user-delete', short_help='deletes a user') @click.argument('name') #@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') @click.pass_context @@ -2452,12 +2859,12 @@ def user_delete(ctx, name): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.user.delete(name) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='user-list') +@cli.command(name='user-list', short_help='list all users') @click.option('--filter', default=None, help='restricts the list to the users matching the filter') @click.pass_context @@ -2466,8 +2873,8 @@ def user_list(ctx, filter): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.user.list(filter) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['name', 'id']) for user in resp: @@ -2476,7 +2883,7 @@ def user_list(ctx, filter): print(table) -@cli.command(name='user-show') +@cli.command(name='user-show', short_help='shows the details of a user') @click.argument('name') @click.pass_context def user_show(ctx, name): @@ -2489,8 +2896,8 @@ def user_show(ctx, name): resp = ctx.obj.user.get(name) if 'password' in resp: resp['password']='********' - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['key', 'attribute']) @@ -2542,8 +2949,8 @@ def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity, alarm['statistic'] = statistic check_client_version(ctx.obj, ctx.command.name) ctx.obj.ns.create_alarm(alarm) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -2558,8 +2965,8 @@ def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity, # try: # check_client_version(ctx.obj, ctx.command.name) # ctx.obj.ns.delete_alarm(name) -# except ClientException as inst: -# print(inst.message) +# except ClientException as e: +# print(str(e)) # exit(1) @@ -2567,7 +2974,7 @@ def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity, # Performance Management operations #################### -@cli.command(name='ns-metric-export') +@cli.command(name='ns-metric-export', short_help='exports a metric to the internal OSM bus, which can be read by other apps') @click.option('--ns', prompt=True, help='NS instance id or name') @click.option('--vnf', prompt=True, help='VNF name (VNF member index as declared in the NSD)') @@ -2602,8 +3009,8 @@ def ns_metric_export(ctx, ns, vnf, vdu, metric, interval): print('{} {}'.format(ctx.obj.ns.export_metric(metric_data),i)) time.sleep(int(interval)) i+=1 - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -2611,7 +3018,7 @@ def ns_metric_export(ctx, ns, vnf, vdu, metric, interval): # Other operations #################### -@cli.command(name='upload-package') +@cli.command(name='upload-package', short_help='uploads a VNF package or NS package') @click.argument('filename') @click.pass_context def upload_package(ctx, filename): @@ -2624,8 +3031,8 @@ def upload_package(ctx, filename): fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname != 'osmclient.sol005.client.Client': ctx.obj.package.wait_for_upload(filename) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -2640,8 +3047,8 @@ def upload_package(ctx, filename): # try: # check_client_version(ctx.obj, ctx.command.name, 'v1') # resp = ctx.obj.ns.list() -# except ClientException as inst: -# print((inst.message)) +# except ClientException as e: +# print(str(e)) # exit(1) # # table = PrettyTable( @@ -2690,8 +3097,8 @@ def upload_package(ctx, filename): # try: # check_client_version(ctx.obj, ctx.command.name, 'v1') # ctx.obj.ns.scale(ns_name, ns_scale_group, index, wait=wait) -# except ClientException as inst: -# print((inst.message)) +# except ClientException as e: +# print(str(e)) # exit(1) @@ -2701,8 +3108,8 @@ def upload_package(ctx, filename): # """list config agents""" # try: # check_client_version(ctx.obj, ctx.command.name, 'v1') -# except ClientException as inst: -# print((inst.message)) +# except ClientException as e: +# print(str(e)) # exit(1) # table = PrettyTable(['name', 'account-type', 'details']) # for account in ctx.obj.vca.list(): @@ -2725,8 +3132,8 @@ def upload_package(ctx, filename): # try: # check_client_version(ctx.obj, ctx.command.name, 'v1') # ctx.obj.vca.delete(name) -# except ClientException as inst: -# print((inst.message)) +# except ClientException as e: +# print(str(e)) # exit(1) @@ -2749,8 +3156,8 @@ def upload_package(ctx, filename): # try: # check_client_version(ctx.obj, ctx.command.name, 'v1') # ctx.obj.vca.create(name, account_type, server, user, secret) -# except ClientException as inst: -# print((inst.message)) +# except ClientException as e: +# print(str(e)) # exit(1) @@ -2779,13 +3186,15 @@ def upload_package(ctx, filename): # print(table) -@cli.command(name='ns-action') +@cli.command(name='ns-action', short_help='executes an action/primitive over a NS instance') @click.argument('ns_name') @click.option('--vnf_name', default=None, help='member-vnf-index if the target is a vnf instead of a ns)') -@click.option('--vdu_id', default=None, help='vdu-id if the target is a vdu o a vnf') +@click.option('--kdu_name', default=None, help='kdu-name if the target is a kdu)') +@click.option('--vdu_id', default=None, help='vdu-id if the target is a vdu') @click.option('--vdu_count', default=None, help='number of vdu instance of this vdu_id') -@click.option('--action_name', prompt=True) -@click.option('--params', default=None) +@click.option('--action_name', prompt=True, help='action name') +@click.option('--params', default=None, help='action params in YAML/JSON inline string') +@click.option('--params_file', default=None, help='YAML/JSON file with action params') @click.option('--wait', required=False, default=False, @@ -2796,10 +3205,12 @@ def upload_package(ctx, filename): def ns_action(ctx, ns_name, vnf_name, + kdu_name, vdu_id, vdu_count, action_name, params, + params_file, wait): """executes an action/primitive over a NS instance @@ -2810,23 +3221,28 @@ def ns_action(ctx, op_data = {} if vnf_name: op_data['member_vnf_index'] = vnf_name + if kdu_name: + op_data['kdu_name'] = kdu_name if vdu_id: op_data['vdu_id'] = vdu_id if vdu_count: op_data['vdu_count_index'] = vdu_count op_data['primitive'] = action_name + if params_file: + with open(params_file, 'r') as pf: + params = pf.read() if params: - op_data['primitive_params'] = yaml.load(params) + op_data['primitive_params'] = yaml.safe_load(params) else: op_data['primitive_params'] = {} - ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data, wait=wait) + print(ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data, wait=wait)) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) -@cli.command(name='vnf-scale') +@cli.command(name='vnf-scale', short_help='executes a VNF scale (adding/removing VDUs)') @click.argument('ns_name') @click.argument('vnf_name') @click.option('--scaling-group', prompt=True, help="scaling-group-descriptor name to use") @@ -2851,8 +3267,8 @@ def vnf_scale(ctx, if not scale_in and not scale_out: scale_out = True ctx.obj.ns.scale_vnf(ns_name, vnf_name, scaling_group, scale_in, scale_out) - except ClientException as inst: - print((inst.message)) + except ClientException as e: + print(str(e)) exit(1) @@ -2860,7 +3276,7 @@ def vnf_scale(ctx, # Role Management Operations # ############################## -@cli.command(name='role-create', short_help='creates a role') +@cli.command(name='role-create', short_help='creates a new role') @click.argument('name') @click.option('--permissions', default=None, @@ -2877,8 +3293,8 @@ def role_create(ctx, name, permissions): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.role.create(name, permissions) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) @@ -2910,8 +3326,8 @@ def role_update(ctx, name, set_name, add, remove): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.role.update(name, set_name, None, add, remove) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) @@ -2929,8 +3345,8 @@ def role_delete(ctx, name): try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.role.delete(name) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) @@ -2945,8 +3361,8 @@ def role_list(ctx, filter): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.role.list(filter) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['name', 'id']) for role in resp: @@ -2968,8 +3384,8 @@ def role_show(ctx, name): try: check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.role.get(name) - except ClientException as inst: - print(inst.message) + except ClientException as e: + print(str(e)) exit(1) table = PrettyTable(['key', 'attribute']) @@ -2979,6 +3395,151 @@ def role_show(ctx, name): print(table) +@cli.command(name='package-create', + short_help='Create a package descriptor') +@click.argument('package-type') +@click.argument('package-name') +@click.option('--base-directory', + default='.', + help=('(NS/VNF/NST) Set the location for package creation. Default: "."')) +@click.option('--image', + default="image-name", + help='(VNF) Set the name of the vdu image. Default "image-name"') +@click.option('--vdus', + default=1, + help='(VNF) Set the number of vdus in a VNF. Default 1') +@click.option('--vcpu', + default=1, + help='(VNF) Set the number of virtual CPUs in a vdu. Default 1') +@click.option('--memory', + default=1024, + help='(VNF) Set the memory size (MB) of the vdu. Default 1024') +@click.option('--storage', + default=10, + help='(VNF) Set the disk size (GB) of the vdu. Default 10') +@click.option('--interfaces', + default=0, + help='(VNF) Set the number of additional interfaces apart from the management interface. Default 0') +@click.option('--vendor', + default="OSM", + help='(NS/VNF) Set the descriptor vendor. Default "OSM"') +@click.option('--override', + default=False, + is_flag=True, + help='(NS/VNF/NST) Flag for overriding the package if exists.') +@click.option('--detailed', + is_flag=True, + default=False, + help='(NS/VNF/NST) Flag for generating descriptor .yaml with all possible commented options') +@click.option('--netslice-subnets', + default=1, + help='(NST) Number of netslice subnets. Default 1') +@click.option('--netslice-vlds', + default=1, + help='(NST) Number of netslice vlds. Default 1') +@click.pass_context +def package_create(ctx, + package_type, + base_directory, + package_name, + override, + image, + vdus, + vcpu, + memory, + storage, + interfaces, + vendor, + detailed, + netslice_subnets, + netslice_vlds): + """ + Creates an OSM NS, VNF, NST package + + \b + PACKAGE_TYPE: Package to be created: NS, VNF or NST. + PACKAGE_NAME: Name of the package to create the folder with the content. + """ + + try: + check_client_version(ctx.obj, ctx.command.name) + print("Creating the {} structure: {}/{}".format(package_type.upper(), base_directory, package_name)) + resp = ctx.obj.package_tool.create(package_type, + base_directory, + package_name, + override=override, + image=image, + vdus=vdus, + vcpu=vcpu, + memory=memory, + storage=storage, + interfaces=interfaces, + vendor=vendor, + detailed=detailed, + netslice_subnets=netslice_subnets, + netslice_vlds=netslice_vlds) + print(resp) + except ClientException as inst: + print("ERROR: {}".format(inst)) + exit(1) + +@cli.command(name='package-validate', + short_help='Validate a package descriptor') +@click.argument('base-directory', + default=".", + required=False) +@click.pass_context +def package_validate(ctx, + base_directory): + """ + Validate descriptors given a base directory. + + \b + BASE_DIRECTORY: Stub folder for NS, VNF or NST package. + """ + try: + check_client_version(ctx.obj, ctx.command.name) + results = ctx.obj.package_tool.validate(base_directory) + table = PrettyTable() + table.field_names = ["TYPE", "PATH", "VALID", "ERROR"] + # Print the dictionary generated by the validation function + for result in results: + table.add_row([result["type"], result["path"], result["valid"], result["error"]]) + table.sortby = "VALID" + table.align["PATH"] = "l" + table.align["TYPE"] = "l" + table.align["ERROR"] = "l" + print(table) + except ClientException as inst: + print("ERROR: {}".format(inst)) + exit(1) + +@cli.command(name='package-build', + short_help='Build the tar.gz of the package') +@click.argument('package-folder') +@click.option('--skip-validation', + default=False, + is_flag=True, + help='skip package validation') +@click.pass_context +def package_build(ctx, + package_folder, + skip_validation): + """ + Build the package NS, VNF given the package_folder. + + \b + PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged + """ + try: + check_client_version(ctx.obj, ctx.command.name) + results = ctx.obj.package_tool.build(package_folder, skip_validation) + print(results) + except ClientException as inst: + print("ERROR: {}".format(inst)) + exit(1) + + if __name__ == '__main__': try: cli()