X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=6e8bd8808a322b2f070b6434b120e29d348b2d27;hb=93012adc64eb063b27bc030c9d6734d1db782cbd;hp=c500286821ff1531c33328759046f499cbb0be1d;hpb=a63fb3c6887ecf8221e868e0c8d39d51319ea085;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index c500286..6e8bd88 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -26,6 +26,7 @@ import yaml import json import time import pycurl +import os def check_client_version(obj, what, version='sol005'): @@ -46,68 +47,71 @@ 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', help='hostname of server. ' + 'Also can set OSM_HOSTNAME in environment') -@click.option('--sol005/--no-sol005', - default=True, - envvar='OSM_SOL005', - help='Use ETSI NFV SOL005 API (default) or the previous SO API. ' + - 'Also can set OSM_SOL005 in environment') +#@click.option('--sol005/--no-sol005', +# default=True, +# envvar='OSM_SOL005', +# help='Use ETSI NFV SOL005 API (default) or the previous SO API. ' + +# 'Also can set OSM_SOL005 in environment') @click.option('--user', default=None, envvar='OSM_USER', - help='user (only from Release FOUR, defaults to admin). ' + + help='user (defaults to admin). ' + 'Also can set OSM_USER in environment') @click.option('--password', default=None, envvar='OSM_PASSWORD', - help='password (only from Release FOUR, defaults to admin). ' + + help='password (defaults to admin). ' + 'Also can set OSM_PASSWORD in environment') @click.option('--project', default=None, envvar='OSM_PROJECT', - help='project (only from Release FOUR, defaults to admin). ' + + help='project (defaults to admin). ' + 'Also can set OSM_PROJECT in environment') -@click.option('--so-port', - default=None, - envvar='OSM_SO_PORT', - help='hostname of server. ' + - 'Also can set OSM_SO_PORT in environment') -@click.option('--so-project', - default=None, - envvar='OSM_SO_PROJECT', - help='Project Name in SO. ' + - 'Also can set OSM_SO_PROJECT in environment') -@click.option('--ro-hostname', - default=None, - envvar='OSM_RO_HOSTNAME', - help='hostname of RO server. ' + - 'Also can set OSM_RO_HOSTNAME in environment') -@click.option('--ro-port', - default=None, - envvar='OSM_RO_PORT', - help='hostname of RO server. ' + - 'Also can set OSM_RO_PORT in environment') -@click.pass_context -def cli(ctx, hostname, sol005, user, password, project, so_port, so_project, ro_hostname, ro_port): +#@click.option('--so-port', +# default=None, +# envvar='OSM_SO_PORT', +# help='hostname of server. ' + +# 'Also can set OSM_SO_PORT in environment') +#@click.option('--so-project', +# default=None, +# envvar='OSM_SO_PROJECT', +# help='Project Name in SO. ' + +# 'Also can set OSM_SO_PROJECT in environment') +#@click.option('--ro-hostname', +# default=None, +# envvar='OSM_RO_HOSTNAME', +# help='hostname of RO server. ' + +# 'Also can set OSM_RO_HOSTNAME in environment') +#@click.option('--ro-port', +# default=None, +# envvar='OSM_RO_PORT', +# help='hostname of RO server. ' + +# 'Also can set OSM_RO_PORT in environment') +@click.pass_context +def cli(ctx, hostname, user, password, project): if hostname is None: print(( "either hostname option or OSM_HOSTNAME " + "environment variable needs to be specified")) exit(1) kwargs={} - if so_port is not None: - kwargs['so_port']=so_port - if so_project is not None: - kwargs['so_project']=so_project - if ro_hostname is not None: - kwargs['ro_host']=ro_hostname - if ro_port is not None: - kwargs['ro_port']=ro_port +# if so_port is not None: +# kwargs['so_port']=so_port +# if so_project is not None: +# kwargs['so_project']=so_project +# if ro_hostname is not None: +# kwargs['ro_host']=ro_hostname +# if ro_port is not None: +# kwargs['ro_port']=ro_port + sol005 = os.getenv('OSM_SOL005', True) if user is not None: kwargs['user']=user if password is not None: @@ -122,7 +126,7 @@ def cli(ctx, hostname, sol005, user, password, project, so_port, so_project, ro_ # 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 @@ -217,7 +221,7 @@ def nsd_list(ctx, filter): resp = ctx.obj.nsd.list(filter) else: resp = ctx.obj.nsd.list() - # print yaml.safe_dump(resp) + # print(yaml.safe_dump(resp)) table = PrettyTable(['nsd name', 'id']) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': @@ -231,7 +235,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 @@ -240,12 +244,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) @@ -271,7 +275,7 @@ def vnfd_list(ctx, nf_type, filter): resp = ctx.obj.vnfd.list(filter) else: resp = ctx.obj.vnfd.list() - # print yaml.safe_dump(resp) + # print(yaml.safe_dump(resp)) table = PrettyTable(['nfpkg name', 'id']) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': @@ -285,33 +289,33 @@ 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) @@ -372,7 +376,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.') @@ -382,7 +386,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.') @@ -438,7 +442,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): @@ -493,7 +497,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 @@ -502,7 +506,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 @@ -518,7 +522,7 @@ def nst_list(ctx, filter): except ClientException as inst: print((inst.message)) exit(1) - # print yaml.safe_dump(resp) + # print(yaml.safe_dump(resp)) table = PrettyTable(['nst name', 'id']) for nst in resp: name = nst['name'] if 'name' in nst else '-' @@ -527,7 +531,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 @@ -536,7 +540,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 @@ -560,7 +564,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): @@ -571,7 +575,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): @@ -582,7 +586,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 @@ -792,58 +796,58 @@ def vnf_show(ctx, name, literal, filter): print(table) -@cli.command(name='vnf-monitoring-show') -@click.argument('vnf_name') -@click.pass_context -def vnf_monitoring_show(ctx, vnf_name): - 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)) - exit(1) - - table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units']) - if resp is not None: - for monitor in resp: - table.add_row( - [vnf_name, - monitor['name'], - monitor['value-integer'], - monitor['units']]) - table.align = 'l' - print(table) - - -@cli.command(name='ns-monitoring-show') -@click.argument('ns_name') -@click.pass_context -def ns_monitoring_show(ctx, ns_name): - 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)) - exit(1) - - table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units']) - for key, val in list(resp.items()): - for monitor in val: - table.add_row( - [key, - monitor['name'], - monitor['value-integer'], - monitor['units']]) - table.align = 'l' - print(table) - - -@cli.command(name='ns-op-show', short_help='shows the info of an operation') +#@cli.command(name='vnf-monitoring-show') +#@click.argument('vnf_name') +#@click.pass_context +#def vnf_monitoring_show(ctx, vnf_name): +# 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)) +# exit(1) +# +# table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units']) +# if resp is not None: +# for monitor in resp: +# table.add_row( +# [vnf_name, +# monitor['name'], +# monitor['value-integer'], +# monitor['units']]) +# table.align = 'l' +# print(table) + + +#@cli.command(name='ns-monitoring-show') +#@click.argument('ns_name') +#@click.pass_context +#def ns_monitoring_show(ctx, ns_name): +# 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)) +# exit(1) +# +# table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units']) +# for key, val in list(resp.items()): +# for monitor in val: +# table.add_row( +# [key, +# monitor['name'], +# monitor['value-integer'], +# monitor['units']]) +# table.align = 'l' +# print(table) + + +@cli.command(name='ns-op-show', short_help='shows the info of a NS operation') @click.argument('id') @click.option('--filter', default=None) @click.pass_context def ns_op_show(ctx, id, filter): - """shows the detailed info of an operation + """shows the detailed info of a NS operation ID: operation identifier """ @@ -1045,8 +1049,11 @@ def nsd_create(ctx, filename, overwrite): @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 @@ -1058,8 +1065,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 @@ -1080,8 +1090,11 @@ def vnfd_create(ctx, filename, overwrite): @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 @@ -1093,8 +1106,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 @@ -1106,8 +1122,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 @@ -1136,6 +1155,12 @@ def nfpkg_create(ctx, filename, overwrite): @click.option('--config_file', default=None, help='ns specific yaml configuration file') +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context def ns_create(ctx, nsd_name, @@ -1144,7 +1169,8 @@ def ns_create(ctx, admin_status, ssh_keys, config, - config_file): + config_file, + wait): """creates a new NS instance""" try: if config_file: @@ -1158,7 +1184,8 @@ def ns_create(ctx, ns_name, config=config, ssh_keys=ssh_keys, - account=vim_account) + account=vim_account, + wait=wait) except ClientException as inst: print(inst.message) exit(1) @@ -1175,8 +1202,11 @@ def nst_create(ctx, filename, overwrite): @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) @@ -1188,8 +1218,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) @@ -1199,7 +1232,7 @@ def nst_create2(ctx, filename, overwrite): nst_create(ctx, filename, overwrite) -def nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file): +def nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait): """creates a new Network Slice Instance (NSI)""" try: check_client_version(ctx.obj, ctx.command.name) @@ -1209,7 +1242,7 @@ def nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_fi with open(config_file, 'r') as cf: config=cf.read() ctx.obj.nsi.create(nst_name, nsi_name, config=config, ssh_keys=ssh_keys, - account=vim_account) + account=vim_account, wait=wait) except ClientException as inst: print(inst.message) exit(1) @@ -1235,10 +1268,16 @@ def nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_fi @click.option('--config_file', default=None, help='nsi specific yaml configuration file') +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context -def nsi_create1(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file): +def nsi_create1(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait): """creates a new Network Slice Instance (NSI)""" - nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file) + nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait=wait) @cli.command(name='netslice-instance-create', short_help='creates a new Network Slice Instance') @@ -1259,10 +1298,16 @@ def nsi_create1(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_f @click.option('--config_file', default=None, help='nsi specific yaml configuration file') +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context -def nsi_create2(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file): +def nsi_create2(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait): """creates a new Network Slice Instance (NSI)""" - nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file) + nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait=wait) @cli.command(name='pdu-create', short_help='adds a new Physical Deployment Unit to the catalog') @@ -1292,7 +1337,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 @@ -1309,7 +1354,6 @@ def pdu_create(ctx, name, pdu_type, interface, description, vim_account, descrip print((inst.message)) exit(1) - #################### # UPDATE operations #################### @@ -1523,18 +1567,24 @@ def nfpkg_delete(ctx, name, force): @cli.command(name='ns-delete', short_help='deletes a NS instance') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context -def ns_delete(ctx, name, force): +def ns_delete(ctx, name, force, wait): """deletes a NS instance NAME: name or ID of the NS instance to be deleted """ try: if not force: - ctx.obj.ns.delete(name) + ctx.obj.ns.delete(name, wait=wait) else: check_client_version(ctx.obj, '--force') - ctx.obj.ns.delete(name, force) + ctx.obj.ns.delete(name, force, wait=wait) except ClientException as inst: print((inst.message)) exit(1) @@ -1573,10 +1623,10 @@ def nst_delete2(ctx, name, force): nst_delete(ctx, name, force) -def nsi_delete(ctx, name, force): +def nsi_delete(ctx, name, force, wait): try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.nsi.delete(name, force) + ctx.obj.nsi.delete(name, force, wait=wait) except ClientException as inst: print((inst.message)) exit(1) @@ -1585,25 +1635,31 @@ def nsi_delete(ctx, name, force): @cli.command(name='nsi-delete', short_help='deletes a Network Slice Instance (NSI)') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context -def nsi_delete1(ctx, name, force): +def nsi_delete1(ctx, name, force, wait): """deletes a Network Slice Instance (NSI) NAME: name or ID of the Network Slice instance to be deleted """ - nsi_delete(ctx, name, force) + nsi_delete(ctx, name, force, wait=wait) @cli.command(name='netslice-instance-delete', short_help='deletes a Network Slice Instance (NSI)') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') @click.pass_context -def nsi_delete2(ctx, name, force): +def nsi_delete2(ctx, name, force, wait): """deletes a Network Slice Instance (NSI) NAME: name or ID of the Network Slice instance to be deleted """ - nsi_delete(ctx, name, force) + nsi_delete(ctx, name, force, wait=wait) @cli.command(name='pdu-delete', short_help='deletes a Physical Deployment Unit (PDU)') @@ -1623,11 +1679,11 @@ def pdu_delete(ctx, name, force): exit(1) -#################### +################# # 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') @@ -1656,6 +1712,12 @@ def pdu_delete(ctx, name, force): help='human readable description') @click.option('--sdn_controller', default=None, help='Name or id of the SDN controller associated to this VIM account') @click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports") +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context def vim_create(ctx, name, @@ -1667,7 +1729,8 @@ def vim_create(ctx, account_type, description, sdn_controller, - sdn_port_mapping): + sdn_port_mapping, + wait): """creates a new VIM account""" try: if sdn_controller: @@ -1683,9 +1746,9 @@ def vim_create(ctx, vim['description'] = description vim['config'] = config if sdn_controller or sdn_port_mapping: - ctx.obj.vim.create(name, vim, sdn_controller, sdn_port_mapping) + ctx.obj.vim.create(name, vim, sdn_controller, sdn_port_mapping, wait=wait) else: - ctx.obj.vim.create(name, vim) + ctx.obj.vim.create(name, vim, wait=wait) except ClientException as inst: print((inst.message)) exit(1) @@ -1703,6 +1766,12 @@ def vim_create(ctx, @click.option('--description', help='human readable description') @click.option('--sdn_controller', default=None, help='Name or id of the SDN controller associated to this VIM account') @click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports") +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context def vim_update(ctx, name, @@ -1715,7 +1784,8 @@ def vim_update(ctx, account_type, description, sdn_controller, - sdn_port_mapping): + sdn_port_mapping, + wait): """updates a VIM account NAME: name or ID of the VIM account @@ -1731,50 +1801,56 @@ def vim_update(ctx, if account_type: vim['vim_type'] = account_type if description: vim['description'] = description if config: vim['config'] = config - ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping) + ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping, wait=wait) except ClientException as inst: print((inst.message)) 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', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context -def vim_delete(ctx, name, force): +def vim_delete(ctx, name, force, wait): """deletes a VIM account NAME: name or ID of the VIM account to be deleted """ try: if not force: - ctx.obj.vim.delete(name) + ctx.obj.vim.delete(name, wait=wait) else: check_client_version(ctx.obj, '--force') - ctx.obj.vim.delete(name, force) + ctx.obj.vim.delete(name, force, wait=wait) except ClientException as inst: print((inst.message)) exit(1) -@cli.command(name='vim-list') -@click.option('--ro_update/--no_ro_update', - default=False, - help='update list from RO') +@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') @click.option('--filter', default=None, help='restricts the list to the VIM accounts matching the filter') @click.pass_context -def vim_list(ctx, ro_update, filter): +def vim_list(ctx, filter): """list all VIM accounts""" if filter: check_client_version(ctx.obj, '--filter') - if ro_update: - check_client_version(ctx.obj, '--ro_update', 'v1') +# if ro_update: +# check_client_version(ctx.obj, '--ro_update', 'v1') fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': resp = ctx.obj.vim.list(filter) - else: - resp = ctx.obj.vim.list(ro_update) +# else: +# resp = ctx.obj.vim.list(ro_update) table = PrettyTable(['vim name', 'uuid']) for vim in resp: table.add_row([vim['name'], vim['uuid']]) @@ -1782,7 +1858,7 @@ def vim_list(ctx, ro_update, 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): @@ -1809,7 +1885,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') @@ -1831,6 +1907,12 @@ def vim_show(ctx, name): default='no description', help='human readable description') @click.option('--wim_port_mapping', default=None, help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge (WAN service endpoint id and info)") +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context def wim_create(ctx, name, @@ -1841,7 +1923,8 @@ def wim_create(ctx, config, wim_type, description, - wim_port_mapping): + wim_port_mapping, + wait): """creates a new WIM account""" try: check_client_version(ctx.obj, ctx.command.name) @@ -1857,7 +1940,7 @@ def wim_create(ctx, wim['wim_type'] = wim_type if description: wim['description'] = description if config: wim['config'] = config - ctx.obj.wim.create(name, wim, wim_port_mapping) + ctx.obj.wim.create(name, wim, wim_port_mapping, wait=wait) except ClientException as inst: print((inst.message)) exit(1) @@ -1873,6 +1956,12 @@ def wim_create(ctx, @click.option('--wim_type', help='WIM type') @click.option('--description', help='human readable description') @click.option('--wim_port_mapping', default=None, help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge (WAN service endpoint id and info)") +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context def wim_update(ctx, name, @@ -1883,7 +1972,8 @@ def wim_update(ctx, config, wim_type, description, - wim_port_mapping): + wim_port_mapping, + wait): """updates a WIM account NAME: name or ID of the WIM account @@ -1899,30 +1989,36 @@ def wim_update(ctx, if wim_type: wim['wim_type'] = wim_type if description: wim['description'] = description if config: wim['config'] = config - ctx.obj.wim.update(name, wim, wim_port_mapping) + ctx.obj.wim.update(name, wim, wim_port_mapping, wait=wait) except ClientException as inst: print((inst.message)) 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', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context -def wim_delete(ctx, name, force): +def wim_delete(ctx, name, force, wait): """deletes a WIM account NAME: name or ID of the WIM account to be deleted """ try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.wim.delete(name, force) + ctx.obj.wim.delete(name, force, wait=wait) except ClientException as inst: print((inst.message)) 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 @@ -1941,7 +2037,7 @@ def wim_list(ctx, filter): 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): @@ -1969,7 +2065,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') @@ -1977,7 +2073,7 @@ def wim_show(ctx, name): prompt=True, help='SDN controller type') @click.option('--sdn_controller_version', - help='SDN controller username') + help='SDN controller version') @click.option('--ip_address', prompt=True, help='SDN controller IP address') @@ -1996,16 +2092,23 @@ def wim_show(ctx, name): #@click.option('--description', # default='no description', # help='human readable description') +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context def sdnc_create(ctx, - name, - type, - sdn_controller_version, - ip_address, - port, - switch_dpid, - user, - password): + name, + type, + sdn_controller_version, + ip_address, + port, + switch_dpid, + user, + password, + wait): """creates a new SDN controller""" sdncontroller = {} sdncontroller['name'] = name @@ -2022,10 +2125,10 @@ def sdnc_create(ctx, # sdncontroller['description'] = description try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.sdnc.create(name, sdncontroller) + ctx.obj.sdnc.create(name, sdncontroller, wait=wait) except ClientException as inst: print((inst.message)) - + exit(1) @cli.command(name='sdnc-update', short_help='updates an SDN controller') @click.argument('name') @@ -2038,17 +2141,24 @@ def sdnc_create(ctx, @click.option('--user', help='SDN controller username') @click.option('--password', help='SDN controller password') #@click.option('--description', default=None, help='human readable description') +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context def sdnc_update(ctx, - name, - newname, - type, - sdn_controller_version, - ip_address, - port, - switch_dpid, - user, - password): + name, + newname, + type, + sdn_controller_version, + ip_address, + port, + switch_dpid, + user, + password, + wait): """updates an SDN controller NAME: name or ID of the SDN controller @@ -2077,30 +2187,36 @@ def sdnc_update(ctx, sdncontroller['password'] = user try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.sdnc.update(name, sdncontroller) + ctx.obj.sdnc.update(name, sdncontroller, wait=wait) except ClientException as inst: print((inst.message)) 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', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context -def sdnc_delete(ctx, name, force): +def sdnc_delete(ctx, name, force, wait): """deletes an SDN controller NAME: name or ID of the SDN controller to be deleted """ try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.sdnc.delete(name, force) + ctx.obj.sdnc.delete(name, force, wait=wait) except ClientException as inst: print((inst.message)) 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 @@ -2112,14 +2228,14 @@ def sdnc_list(ctx, filter): except ClientException as inst: print((inst.message)) exit(1) - table = PrettyTable(['name', 'id']) + table = PrettyTable(['sdnc name', 'id']) for sdnc in resp: table.add_row([sdnc['name'], sdnc['_id']]) table.align = 'l' 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): @@ -2145,7 +2261,7 @@ def sdnc_show(ctx, name): # 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', @@ -2163,9 +2279,10 @@ def project_create(ctx, name): ctx.obj.project.create(name, project) except ClientException as inst: print(inst.message) + 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 @@ -2182,7 +2299,7 @@ def project_delete(ctx, name): 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 @@ -2201,7 +2318,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): @@ -2223,11 +2340,38 @@ def project_show(ctx, name): print(table) +@cli.command(name='project-update', short_help='updates a project (only the name can be updated)') +@click.argument('project') +@click.option('--name', + prompt=True, + help='new name for the project') + +@click.pass_context +def project_update(ctx, project, name): + """ + Update a project name + + :param ctx: + :param project: id or name of the project to modify + :param name: new name for the project + :return: + """ + + project_changes = {} + project_changes['name'] = name + + try: + check_client_version(ctx.obj, ctx.command.name) + ctx.obj.project.update(project, project_changes) + except ClientException as inst: + print(inst.message) + + #################### # 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, @@ -2235,11 +2379,11 @@ def project_show(ctx, name): confirmation_prompt=True, help='user password') @click.option('--projects', - prompt="Comma separate list of projects", + # prompt="Comma separate list of projects", multiple=True, callback=lambda ctx, param, value: ''.join(value).split(',') if all(len(x)==1 for x in value) else value, help='list of project ids that the user belongs to') -@click.option('--project-role-mapping', 'project_role_mappings', +@click.option('--project-role-mappings', 'project_role_mappings', default=None, multiple=True, help='creating user project/role(s) mapping') @click.pass_context @@ -2256,22 +2400,26 @@ def user_create(ctx, username, password, projects, project_role_mappings): user['username'] = username user['password'] = password user['projects'] = projects - user['project-role-mappings'] = project_role_mappings + user['project_role_mappings'] = 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) + 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, - hide_input=True, - confirmation_prompt=True, + # prompt=True, + # hide_input=True, + # confirmation_prompt=True, help='user password') +@click.option('--set-username', 'set_username', + default=None, + help='change username') @click.option('--set-project', 'set_project', default=None, multiple=True, help='create/replace the project,role(s) mapping for this project: \'project,role1,role2,...\'') @@ -2285,21 +2433,22 @@ def user_create(ctx, username, password, projects, project_role_mappings): default=None, multiple=True, help='removes project,role(s) mapping: \'project,role1,role2,...\'') @click.pass_context -def user_update(ctx, username, password, set_project, remove_project, +def user_update(ctx, username, password, set_username, set_project, remove_project, add_project_role, remove_project_role): """Update a user information \b USERNAME: name of the user PASSWORD: new password + SET_USERNAME: new username SET_PROJECT: creating mappings for project/role(s) REMOVE_PROJECT: deleting mappings for project/role(s) ADD_PROJECT_ROLE: adding mappings for project/role(s) REMOVE_PROJECT_ROLE: removing mappings for project/role(s) """ user = {} - user['username'] = username user['password'] = password + user['username'] = set_username user['set-project'] = set_project user['remove-project'] = remove_project user['add-project-role'] = add_project_role @@ -2310,9 +2459,10 @@ def user_update(ctx, username, password, set_project, remove_project, ctx.obj.user.update(username, user) except ClientException as inst: print(inst.message) + 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 @@ -2330,7 +2480,7 @@ def user_delete(ctx, name): 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 @@ -2349,7 +2499,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): @@ -2398,19 +2548,21 @@ def user_show(ctx, name): def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity, threshold_value, threshold_operator, statistic): """creates a new alarm for a NS instance""" - ns_instance = ctx.obj.ns.get(ns) - alarm = {} - alarm['alarm_name'] = name - alarm['ns_id'] = ns_instance['_id'] - alarm['correlation_id'] = ns_instance['_id'] - alarm['vnf_member_index'] = vnf - alarm['vdu_name'] = vdu - alarm['metric_name'] = metric - alarm['severity'] = severity - alarm['threshold_value'] = int(threshold_value) - alarm['operation'] = threshold_operator - alarm['statistic'] = statistic - try: + # TODO: Check how to validate threshold_value. + # Should it be an integer (1-100), percentage, or decimal (0.01-1.00)? + try: + ns_instance = ctx.obj.ns.get(ns) + alarm = {} + alarm['alarm_name'] = name + alarm['ns_id'] = ns_instance['_id'] + alarm['correlation_id'] = ns_instance['_id'] + alarm['vnf_member_index'] = vnf + alarm['vdu_name'] = vdu + alarm['metric_name'] = metric + alarm['severity'] = severity + alarm['threshold_value'] = int(threshold_value) + alarm['operation'] = threshold_operator + alarm['statistic'] = statistic check_client_version(ctx.obj, ctx.command.name) ctx.obj.ns.create_alarm(alarm) except ClientException as inst: @@ -2422,10 +2574,10 @@ def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity, #@click.argument('name') #@click.pass_context #def ns_alarm_delete(ctx, name): -# '''deletes an alarm +# """deletes an alarm # # NAME: name of the alarm to be deleted -# ''' +# """ # try: # check_client_version(ctx.obj, ctx.command.name) # ctx.obj.ns.delete_alarm(name) @@ -2438,7 +2590,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)') @@ -2452,16 +2604,18 @@ def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity, @click.pass_context def ns_metric_export(ctx, ns, vnf, vdu, metric, interval): """exports a metric to the internal OSM bus, which can be read by other apps""" - ns_instance = ctx.obj.ns.get(ns) - metric_data = {} - metric_data['ns_id'] = ns_instance['_id'] - metric_data['correlation_id'] = ns_instance['_id'] - metric_data['vnf_member_index'] = vnf - metric_data['vdu_name'] = vdu - metric_data['metric_name'] = metric - metric_data['collection_unit'] = 'WEEK' - metric_data['collection_period'] = 1 - try: + # TODO: Check how to validate interval. + # Should it be an integer (seconds), or should a suffix (s,m,h,d,w) also be permitted? + try: + ns_instance = ctx.obj.ns.get(ns) + metric_data = {} + metric_data['ns_id'] = ns_instance['_id'] + metric_data['correlation_id'] = ns_instance['_id'] + metric_data['vnf_member_index'] = vnf + metric_data['vdu_name'] = vdu + metric_data['metric_name'] = metric + metric_data['collection_unit'] = 'WEEK' + metric_data['collection_period'] = 1 check_client_version(ctx.obj, ctx.command.name) if not interval: print('{}'.format(ctx.obj.ns.export_metric(metric_data))) @@ -2480,7 +2634,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): @@ -2498,180 +2652,204 @@ def upload_package(ctx, filename): exit(1) -@cli.command(name='ns-scaling-show') -@click.argument('ns_name') -@click.pass_context -def show_ns_scaling(ctx, ns_name): - """shows the status of a NS scaling operation - - NS_NAME: name of the NS instance being scaled - """ - try: - check_client_version(ctx.obj, ctx.command.name, 'v1') - resp = ctx.obj.ns.list() - except ClientException as inst: - print((inst.message)) - exit(1) - - table = PrettyTable( - ['group-name', - 'instance-id', - 'operational status', - 'create-time', - 'vnfr ids']) - - for ns in resp: - if ns_name == ns['name']: - nsopdata = ctx.obj.ns.get_opdata(ns['id']) - scaling_records = nsopdata['nsr:nsr']['scaling-group-record'] - for record in scaling_records: - if 'instance' in record: - instances = record['instance'] - for inst in instances: - table.add_row( - [record['scaling-group-name-ref'], - inst['instance-id'], - inst['op-status'], - time.strftime('%Y-%m-%d %H:%M:%S', - time.localtime( - inst['create-time'])), - inst['vnfrs']]) - table.align = 'l' - print(table) - - -@cli.command(name='ns-scale') -@click.argument('ns_name') -@click.option('--ns_scale_group', prompt=True) -@click.option('--index', prompt=True) -@click.pass_context -def ns_scale(ctx, ns_name, ns_scale_group, index): - """scales NS - - NS_NAME: name of the NS instance to be scaled - """ - try: - check_client_version(ctx.obj, ctx.command.name, 'v1') - ctx.obj.ns.scale(ns_name, ns_scale_group, index) - except ClientException as inst: - print((inst.message)) - exit(1) - - -@cli.command(name='config-agent-list') -@click.pass_context -def config_agent_list(ctx): - """list config agents""" - try: - check_client_version(ctx.obj, ctx.command.name, 'v1') - except ClientException as inst: - print((inst.message)) - exit(1) - table = PrettyTable(['name', 'account-type', 'details']) - for account in ctx.obj.vca.list(): - table.add_row( - [account['name'], - account['account-type'], - account['juju']]) - table.align = 'l' - print(table) - +#@cli.command(name='ns-scaling-show') +#@click.argument('ns_name') +#@click.pass_context +#def show_ns_scaling(ctx, ns_name): +# """shows the status of a NS scaling operation +# +# NS_NAME: name of the NS instance being scaled +# """ +# try: +# check_client_version(ctx.obj, ctx.command.name, 'v1') +# resp = ctx.obj.ns.list() +# except ClientException as inst: +# print((inst.message)) +# exit(1) +# +# table = PrettyTable( +# ['group-name', +# 'instance-id', +# 'operational status', +# 'create-time', +# 'vnfr ids']) +# +# for ns in resp: +# if ns_name == ns['name']: +# nsopdata = ctx.obj.ns.get_opdata(ns['id']) +# scaling_records = nsopdata['nsr:nsr']['scaling-group-record'] +# for record in scaling_records: +# if 'instance' in record: +# instances = record['instance'] +# for inst in instances: +# table.add_row( +# [record['scaling-group-name-ref'], +# inst['instance-id'], +# inst['op-status'], +# time.strftime('%Y-%m-%d %H:%M:%S', +# time.localtime( +# inst['create-time'])), +# inst['vnfrs']]) +# table.align = 'l' +# print(table) + + +#@cli.command(name='ns-scale') +#@click.argument('ns_name') +#@click.option('--ns_scale_group', prompt=True) +#@click.option('--index', prompt=True) +#@click.option('--wait', +# required=False, +# default=False, +# is_flag=True, +# help='do not return the control immediately, but keep it \ +# until the operation is completed, or timeout') +#@click.pass_context +#def ns_scale(ctx, ns_name, ns_scale_group, index, wait): +# """scales NS +# +# NS_NAME: name of the NS instance to be scaled +# """ +# 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)) +# exit(1) -@cli.command(name='config-agent-delete') -@click.argument('name') -@click.pass_context -def config_agent_delete(ctx, name): - """deletes a config agent - NAME: name of the config agent to be deleted - """ - try: - check_client_version(ctx.obj, ctx.command.name, 'v1') - ctx.obj.vca.delete(name) - except ClientException as inst: - print((inst.message)) - exit(1) +#@cli.command(name='config-agent-list') +#@click.pass_context +#def config_agent_list(ctx): +# """list config agents""" +# try: +# check_client_version(ctx.obj, ctx.command.name, 'v1') +# except ClientException as inst: +# print((inst.message)) +# exit(1) +# table = PrettyTable(['name', 'account-type', 'details']) +# for account in ctx.obj.vca.list(): +# table.add_row( +# [account['name'], +# account['account-type'], +# account['juju']]) +# table.align = 'l' +# print(table) -@cli.command(name='config-agent-add') -@click.option('--name', - prompt=True) -@click.option('--account_type', - prompt=True) -@click.option('--server', - prompt=True) -@click.option('--user', - prompt=True) -@click.option('--secret', - prompt=True, - hide_input=True, - confirmation_prompt=True) -@click.pass_context -def config_agent_add(ctx, name, account_type, server, user, secret): - """adds a config agent""" - 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)) - exit(1) +#@cli.command(name='config-agent-delete') +#@click.argument('name') +#@click.pass_context +#def config_agent_delete(ctx, name): +# """deletes a config agent +# +# NAME: name of the config agent to be deleted +# """ +# try: +# check_client_version(ctx.obj, ctx.command.name, 'v1') +# ctx.obj.vca.delete(name) +# except ClientException as inst: +# print((inst.message)) +# exit(1) -@cli.command(name='ro-dump') -@click.pass_context -def ro_dump(ctx): - """shows RO agent information""" - check_client_version(ctx.obj, ctx.command.name, 'v1') - resp = ctx.obj.vim.get_resource_orchestrator() - 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) +#@cli.command(name='config-agent-add') +#@click.option('--name', +# prompt=True) +#@click.option('--account_type', +# prompt=True) +#@click.option('--server', +# prompt=True) +#@click.option('--user', +# prompt=True) +#@click.option('--secret', +# prompt=True, +# hide_input=True, +# confirmation_prompt=True) +#@click.pass_context +#def config_agent_add(ctx, name, account_type, server, user, secret): +# """adds a config agent""" +# 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)) +# exit(1) -@cli.command(name='vcs-list') -@click.pass_context -def vcs_list(ctx): - check_client_version(ctx.obj, ctx.command.name, 'v1') - resp = ctx.obj.utils.get_vcs_info() - table = PrettyTable(['component name', 'state']) - for component in resp: - table.add_row([component['component_name'], component['state']]) - table.align = 'l' - print(table) +#@cli.command(name='ro-dump') +#@click.pass_context +#def ro_dump(ctx): +# """shows RO agent information""" +# check_client_version(ctx.obj, ctx.command.name, 'v1') +# resp = ctx.obj.vim.get_resource_orchestrator() +# 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) + + +#@cli.command(name='vcs-list') +#@click.pass_context +#def vcs_list(ctx): +# check_client_version(ctx.obj, ctx.command.name, 'v1') +# resp = ctx.obj.utils.get_vcs_info() +# table = PrettyTable(['component name', 'state']) +# for component in resp: +# table.add_row([component['component_name'], component['state']]) +# table.align = 'l' +# 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) +@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('--vdu_count', default=None, help='number of vdu instance of this vdu_id') @click.option('--action_name', prompt=True) -@click.option('--params', prompt=True) +@click.option('--params', default=None) +@click.option('--wait', + required=False, + default=False, + is_flag=True, + help='do not return the control immediately, but keep it \ + until the operation is completed, or timeout') @click.pass_context def ns_action(ctx, ns_name, vnf_name, + vdu_id, + vdu_count, action_name, - params): + params, + wait): """executes an action/primitive over a NS instance NS_NAME: name or ID of the NS instance """ try: check_client_version(ctx.obj, ctx.command.name) - op_data={} + op_data = {} if vnf_name: - op_data['vnf_member_index'] = vnf_name + op_data['member_vnf_index'] = vnf_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 - op_data['primitive_params'] = yaml.load(params) - ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data) + if 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) except ClientException as inst: - print((inst.message)) + print(inst.message) 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") @@ -2705,13 +2883,13 @@ 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('--definition', +@click.option('--permissions', default=None, - help='role definition using a dictionary') + help='role permissions using a dictionary') @click.pass_context -def role_create(ctx, name, definition): +def role_create(ctx, name, permissions): """ Creates a new role. @@ -2721,24 +2899,28 @@ def role_create(ctx, name, definition): """ try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.role.create(name, definition) + ctx.obj.role.create(name, permissions) except ClientException as inst: print(inst.message) + exit(1) @cli.command(name='role-update', short_help='updates a role') @click.argument('name') -@click.option('--definition', +@click.option('--set-name', default=None, - help='add a new definition to the role') + help='change name of rle') +# @click.option('--permissions', +# default=None, +# help='provide a yaml format dictionary with incremental changes. Values can be bool or None to delete') @click.option('--add', default=None, - help='add a resource access grant/denial') + help='yaml format dictionary with permission: True/False to access grant/denial') @click.option('--remove', default=None, - help='remove a resource access grant/denial') + help='yaml format list to remove a permission') @click.pass_context -def role_update(ctx, name, definition, add, remove): +def role_update(ctx, name, set_name, add, remove): """ Updates a role. @@ -2750,7 +2932,7 @@ def role_update(ctx, name, definition, add, remove): """ try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.role.update(name, definition, add, remove) + ctx.obj.role.update(name, set_name, None, add, remove) except ClientException as inst: print(inst.message) exit(1) @@ -2819,7 +3001,6 @@ def role_show(ctx, name): table.align = 'l' print(table) - if __name__ == '__main__': try: cli()