X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=d1cd3499e9d3f0e41ef744ac4621ca38d236dfea;hb=78e9a1baa7cf3c6da5a1d8c84bb51efad5a09a62;hp=66d1f32e858a583a70ccbf90d4eb966a2ff75733;hpb=cf95eefc01755e1f18459ffd921ebcfe4fba5cc1;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index 66d1f32..d1cd349 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -25,6 +25,7 @@ from prettytable import PrettyTable import yaml import json import time +import pycurl def check_client_version(obj, what, version='sol005'): ''' @@ -45,7 +46,7 @@ def check_client_version(obj, what, version='sol005'): @click.group() @click.option('--hostname', - default=None, + default="127.0.0.1", envvar='OSM_HOSTNAME', help='hostname of server. ' + 'Also can set OSM_HOSTNAME in environment') @@ -69,16 +70,16 @@ def check_client_version(obj, what, version='sol005'): envvar='OSM_RO_PORT', help='hostname of RO server. ' + 'Also can set OSM_RO_PORT in environment') -@click.option('--sol005', - is_flag=True, +@click.option('--sol005/--no-sol005', + default=True, envvar='OSM_SOL005', - help='Use ETSI NFV SOL005 API') + help='Use ETSI NFV SOL005 API (default) or the previous SO API') @click.pass_context def cli(ctx, hostname, so_port, so_project, ro_hostname, ro_port, sol005): if hostname is None: - print( + print(( "either hostname option or OSM_HOSTNAME " + - "environment variable needs to be specified") + "environment variable needs to be specified")) exit(1) kwargs={} if so_port is not None: @@ -89,7 +90,7 @@ def cli(ctx, hostname, so_port, so_project, ro_hostname, ro_port, sol005): kwargs['ro_host']=ro_hostname if ro_port is not None: kwargs['ro_port']=ro_port - + ctx.obj = client.Client(host=hostname, sol005=sol005, **kwargs) @@ -99,10 +100,56 @@ def cli(ctx, hostname, so_port, so_project, ro_hostname, ro_port, sol005): @cli.command(name='ns-list') @click.option('--filter', default=None, - help='restricts the list to the NS instances matching the filter') + help='restricts the list to the NS instances matching the filter.') @click.pass_context def ns_list(ctx, filter): - '''list all NS instances''' + '''list all NS instances + + \b + Options: + --filter filterExpr Restricts the list to the NS instances matching the filter + + \b + filterExpr consists of one or more strings formatted according to "simpleFilterExpr", + concatenated using the "&" character: + + \b + filterExpr := ["&"]* + simpleFilterExpr := ["."]*["."]"="[","]* + op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont" + attrName := string + value := scalar value + + \b + where: + * zero or more occurrences + ? zero or one occurrence + [] grouping of expressions to be used with ? and * + "" quotation marks for marking string constants + <> name separator + + \b + "AttrName" is the name of one attribute in the data type that defines the representation + of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of + entries to filter by attributes deeper in the hierarchy of a structured document. + "Op" stands for the comparison operator. If the expression has concatenated + entries, it means that the operator "op" is applied to the attribute addressed by the last + entry included in the concatenation. All simple filter expressions are combined + by the "AND" logical operator. In a concatenation of entries in a , + the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The + concatenation of all "attrName" entries except the leaf attribute is called the "attribute + prefix". If an attribute referenced in an expression is an array, an object that contains a + corresponding array shall be considered to match the expression if any of the elements in the + array matches all expressions that have the same attribute prefix. + + \b + Filter examples: + --filter admin-status=ENABLED + --filter nsd-ref= + --filter nsd.vendor= + --filter nsd.vendor=&nsd-ref= + --filter nsd.constituent-vnfd.vnfd-id-ref= + ''' if filter: check_client_version(ctx.obj, '--filter') resp = ctx.obj.ns.list(filter) @@ -218,17 +265,68 @@ def vnfd_list2(ctx, filter): @cli.command(name='vnf-list') @click.option('--ns', default=None, help='NS instance id or name to restrict the VNF list') +@click.option('--filter', default=None, + help='restricts the list to the VNF instances matching the filter.') @click.pass_context -def vnf_list(ctx, ns): - ''' list all VNF instances''' +def vnf_list(ctx, ns, filter): + '''list all VNF instances + + \b + Options: + --ns TEXT NS instance id or name to restrict the VNF list + --filter filterExpr Restricts the list to the VNF instances matching the filter + + \b + filterExpr consists of one or more strings formatted according to "simpleFilterExpr", + concatenated using the "&" character: + + \b + filterExpr := ["&"]* + simpleFilterExpr := ["."]*["."]"="[","]* + op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont" + attrName := string + value := scalar value + + \b + where: + * zero or more occurrences + ? zero or one occurrence + [] grouping of expressions to be used with ? and * + "" quotation marks for marking string constants + <> name separator + + \b + "AttrName" is the name of one attribute in the data type that defines the representation + of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of + entries to filter by attributes deeper in the hierarchy of a structured document. + "Op" stands for the comparison operator. If the expression has concatenated + entries, it means that the operator "op" is applied to the attribute addressed by the last + entry included in the concatenation. All simple filter expressions are combined + by the "AND" logical operator. In a concatenation of entries in a , + the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The + concatenation of all "attrName" entries except the leaf attribute is called the "attribute + prefix". If an attribute referenced in an expression is an array, an object that contains a + corresponding array shall be considered to match the expression if any of the elements in the + array matches all expressions that have the same attribute prefix. + + \b + Filter examples: + --filter vim-account-id= + --filter vnfd-ref= + --filter vdur.ip-address= + --filter vnfd-ref=,vdur.ip-address= + ''' try: - if ns: - check_client_version(ctx.obj, '--ns') - resp = ctx.obj.vnf.list(ns) + if ns or filter: + if ns: + check_client_version(ctx.obj, '--ns') + if filter: + check_client_version(ctx.obj, '--filter') + resp = ctx.obj.vnf.list(ns, filter) else: resp = ctx.obj.vnf.list() except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': @@ -238,6 +336,7 @@ def vnf_list(ctx, ns): 'ns id', 'vnf member index', 'vnfd name', + 'vim account id', 'ip address']) for vnfr in resp: name = vnfr['name'] if 'name' in vnfr else '-' @@ -247,6 +346,7 @@ def vnf_list(ctx, ns): vnfr['nsr-id-ref'], vnfr['member-vnf-index-ref'], vnfr['vnfd-ref'], + vnfr['vim-account-id'], vnfr['ip-address']]) else: table = PrettyTable( @@ -278,7 +378,7 @@ def ns_op_list(ctx, name): check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.ns.list_op(name) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) table = PrettyTable(['id', 'operation', 'status']) @@ -297,15 +397,15 @@ def nsd_show(ctx, name, literal): resp = ctx.obj.nsd.get(name) #resp = ctx.obj.nsd.get_individual(name) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) if literal: - print yaml.safe_dump(resp) + print(yaml.safe_dump(resp)) return table = PrettyTable(['field', 'value']) - for k, v in resp.items(): + for k, v in list(resp.items()): table.add_row([k, json.dumps(v, indent=2)]) table.align = 'l' print(table) @@ -342,15 +442,15 @@ def vnfd_show(ctx, name, literal): resp = ctx.obj.vnfd.get(name) #resp = ctx.obj.vnfd.get_individual(name) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) if literal: - print yaml.safe_dump(resp) + print(yaml.safe_dump(resp)) return table = PrettyTable(['field', 'value']) - for k, v in resp.items(): + for k, v in list(resp.items()): table.add_row([k, json.dumps(v, indent=2)]) table.align = 'l' print(table) @@ -396,16 +496,16 @@ def ns_show(ctx, name, literal, filter): try: ns = ctx.obj.ns.get(name) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) if literal: - print yaml.safe_dump(resp) + print(yaml.safe_dump(ns)) return table = PrettyTable(['field', 'value']) - for k, v in ns.items(): + for k, v in list(ns.items()): if filter is None or filter in k: table.add_row([k, json.dumps(v, indent=2)]) @@ -413,7 +513,7 @@ def ns_show(ctx, name, literal, filter): if fullclassname != 'osmclient.sol005.client.Client': nsopdata = ctx.obj.ns.get_opdata(ns['id']) nsr_optdata = nsopdata['nsr:nsr'] - for k, v in nsr_optdata.items(): + 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.align = 'l' @@ -435,15 +535,15 @@ def vnf_show(ctx, name, literal, filter): check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.vnf.get(name) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) if literal: - print yaml.safe_dump(resp) + print(yaml.safe_dump(resp)) return table = PrettyTable(['field', 'value']) - for k, v in resp.items(): + 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' @@ -458,7 +558,7 @@ def vnf_monitoring_show(ctx, vnf_name): check_client_version(ctx.obj, ctx.command.name, 'v1') resp = ctx.obj.vnf.get_monitoring(vnf_name) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units']) @@ -481,11 +581,11 @@ def ns_monitoring_show(ctx, ns_name): check_client_version(ctx.obj, ctx.command.name, 'v1') resp = ctx.obj.ns.get_monitoring(ns_name) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units']) - for key, val in resp.items(): + for key, val in list(resp.items()): for monitor in val: table.add_row( [key, @@ -508,11 +608,11 @@ def ns_op_show(ctx, id, filter): check_client_version(ctx.obj, ctx.command.name) op_info = ctx.obj.ns.get_op(id) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) table = PrettyTable(['field', 'value']) - for k, v in op_info.items(): + 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.align = 'l' @@ -528,7 +628,7 @@ def nsd_create(ctx, filename, overwrite): check_client_version(ctx.obj, ctx.command.name) ctx.obj.nsd.create(filename, overwrite) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -563,7 +663,7 @@ def vnfd_create(ctx, filename, overwrite): check_client_version(ctx.obj, ctx.command.name) ctx.obj.vnfd.create(filename, overwrite) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -605,11 +705,13 @@ def vnfd_create2(ctx, filename, overwrite): help='administration status') @click.option('--ssh_keys', default=None, - help='comma separated list of keys to inject to vnfs') + help='comma separated list of public key files to inject to vnfs') @click.option('--config', default=None, - help='ns specific yaml configuration:\nvnf: [member-vnf-index: TEXT, vim_account: TEXT]\n' - 'vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]') + help='ns specific yaml configuration') +@click.option('--config_file', + default=None, + help='ns specific yaml configuration file') @click.pass_context def ns_create(ctx, nsd_name, @@ -617,11 +719,16 @@ def ns_create(ctx, vim_account, admin_status, ssh_keys, - config): + config, + config_file): '''creates a new NS instance''' try: - # if config: - # check_client_version(ctx.obj, '--config', 'v1') + if config_file: + check_client_version(ctx.obj, '--config_file') + if config: + raise ClientException('"--config" option is incompatible with "--config_file" option') + with open(config_file, 'r') as cf: + config=cf.read() ctx.obj.ns.create( nsd_name, ns_name, @@ -629,7 +736,7 @@ def ns_create(ctx, ssh_keys=ssh_keys, account=vim_account) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -642,7 +749,7 @@ def nsd_update(ctx, name, content): check_client_version(ctx.obj, ctx.command.name) ctx.obj.nsd.update(name, content) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @cli.command(name='nsd-update', short_help='updates a NSD/NSpkg') @@ -676,7 +783,7 @@ def vnfd_update(ctx, name, content): check_client_version(ctx.obj, ctx.command.name) ctx.obj.vnfd.update(name, content) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -718,7 +825,7 @@ def nsd_delete(ctx, name, force): check_client_version(ctx.obj, '--force') ctx.obj.nsd.delete(name, force) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -754,7 +861,7 @@ def vnfd_delete(ctx, name, force): check_client_version(ctx.obj, '--force') ctx.obj.vnfd.delete(name, force) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -798,14 +905,14 @@ def ns_delete(ctx, name, force): check_client_version(ctx.obj, '--force') ctx.obj.ns.delete(name, force) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) #################### # VIM operations #################### - + @cli.command(name='vim-create') @click.option('--name', prompt=True, @@ -861,13 +968,13 @@ def vim_create(ctx, vim['vim-tenant-name'] = tenant vim['vim-type'] = account_type vim['description'] = description - vim ['config'] = config + vim['config'] = config if sdn_controller or sdn_port_mapping: ctx.obj.vim.create(name, vim, sdn_controller, sdn_port_mapping) else: ctx.obj.vim.create(name, vim) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -913,7 +1020,7 @@ def vim_update(ctx, if config: vim['config'] = config ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -933,7 +1040,7 @@ def vim_delete(ctx, name, force): check_client_version(ctx.obj, '--force') ctx.obj.vim.delete(name, force) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -975,11 +1082,11 @@ def vim_show(ctx, name): if 'vim_password' in resp: resp['vim_password']='********' except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) table = PrettyTable(['key', 'attribute']) - for k, v in resp.items(): + for k, v in list(resp.items()): table.add_row([k, json.dumps(v, indent=2)]) table.align = 'l' print(table) @@ -1045,7 +1152,7 @@ def sdnc_create(ctx, check_client_version(ctx.obj, ctx.command.name) ctx.obj.sdnc.create(name, sdncontroller) except ClientException as inst: - print(inst.message) + print((inst.message)) @cli.command(name='sdnc-update', short_help='updates an SDN controller') @@ -1100,7 +1207,7 @@ def sdnc_update(ctx, check_client_version(ctx.obj, ctx.command.name) ctx.obj.sdnc.update(name, sdncontroller) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -1117,7 +1224,7 @@ def sdnc_delete(ctx, name, force): check_client_version(ctx.obj, ctx.command.name) ctx.obj.sdnc.delete(name, force) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -1131,7 +1238,7 @@ def sdnc_list(ctx, filter): check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.sdnc.list(filter) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) table = PrettyTable(['name', 'id']) for sdnc in resp: @@ -1152,11 +1259,11 @@ def sdnc_show(ctx, name): check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.sdnc.get(name) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) table = PrettyTable(['key', 'attribute']) - for k, v in resp.items(): + for k, v in list(resp.items()): table.add_row([k, json.dumps(v, indent=2)]) table.align = 'l' print(table) @@ -1203,7 +1310,7 @@ def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity, check_client_version(ctx.obj, ctx.command.name) ctx.obj.ns.create_alarm(alarm) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -1254,15 +1361,15 @@ def ns_metric_export(ctx, ns, vnf, vdu, metric, interval): try: check_client_version(ctx.obj, ctx.command.name) if not interval: - print '{}'.format(ctx.obj.ns.export_metric(metric_data)) + print('{}'.format(ctx.obj.ns.export_metric(metric_data))) else: i = 1 while True: - print '{} {}'.format(ctx.obj.ns.export_metric(metric_data),i) + print('{} {}'.format(ctx.obj.ns.export_metric(metric_data),i)) time.sleep(int(interval)) i+=1 except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -1284,7 +1391,7 @@ def upload_package(ctx, filename): if fullclassname != 'osmclient.sol005.client.Client': ctx.obj.package.wait_for_upload(filename) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -1300,7 +1407,7 @@ def show_ns_scaling(ctx, ns_name): check_client_version(ctx.obj, ctx.command.name, 'v1') resp = ctx.obj.ns.list() except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) table = PrettyTable( @@ -1344,7 +1451,7 @@ def ns_scale(ctx, ns_name, ns_scale_group, index): 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) + print((inst.message)) exit(1) @@ -1355,7 +1462,7 @@ def config_agent_list(ctx): try: check_client_version(ctx.obj, ctx.command.name, 'v1') except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) table = PrettyTable(['name', 'account-type', 'details']) for account in ctx.obj.vca.list(): @@ -1379,7 +1486,7 @@ def config_agent_delete(ctx, name): check_client_version(ctx.obj, ctx.command.name, 'v1') ctx.obj.vca.delete(name) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -1403,7 +1510,7 @@ def config_agent_add(ctx, name, account_type, server, user, secret): 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) + print((inst.message)) exit(1) @cli.command(name='ro-dump') @@ -1413,7 +1520,7 @@ def ro_dump(ctx): check_client_version(ctx.obj, ctx.command.name, 'v1') resp = ctx.obj.vim.get_resource_orchestrator() table = PrettyTable(['key', 'attribute']) - for k, v in resp.items(): + for k, v in list(resp.items()): table.add_row([k, json.dumps(v, indent=2)]) table.align = 'l' print(table) @@ -1456,9 +1563,16 @@ def ns_action(ctx, ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) if __name__ == '__main__': - cli() + try: + cli() + except pycurl.error as e: + print(e) + print('Maybe "--hostname" option or OSM_HOSTNAME' + + 'environment variable needs to be specified') + exit(1) +