X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=52761030731ce064c499166341801268eca68b59;hb=c4cd58f1fa79599a489730b41cda4cf43f552ecd;hp=fd92477d3750faa587eec24a1f884d0aeaf3ebda;hpb=9c79a482e22b9004d7a86fca1781ad4bf7bd32fc;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index fd92477..5276103 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -69,16 +69,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: @@ -99,10 +99,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,32 +264,104 @@ 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) - table = PrettyTable( - ['vnf name', - 'id', - 'operational status', - 'config status']) - for vnfr in resp: - if 'mgmt-interface' not in vnfr: - vnfr['mgmt-interface'] = {} - vnfr['mgmt-interface']['ip-address'] = None - table.add_row( - [vnfr['name'], - vnfr['id'], - vnfr['operational-status'], - vnfr['config-status']]) + fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ + if fullclassname == 'osmclient.sol005.client.Client': + table = PrettyTable( + ['vnf id', + 'name', + 'ns id', + 'vnf member index', + 'vnfd name', + 'vim account id', + 'ip address']) + for vnfr in resp: + name = vnfr['name'] if 'name' in vnfr else '-' + table.add_row( + [vnfr['_id'], + name, + vnfr['nsr-id-ref'], + vnfr['member-vnf-index-ref'], + vnfr['vnfd-ref'], + vnfr['vim-account-id'], + vnfr['ip-address']]) + else: + table = PrettyTable( + ['vnf name', + 'id', + 'operational status', + 'config status']) + for vnfr in resp: + if 'mgmt-interface' not in vnfr: + vnfr['mgmt-interface'] = {} + vnfr['mgmt-interface']['ip-address'] = None + table.add_row( + [vnfr['name'], + vnfr['id'], + vnfr['operational-status'], + vnfr['config-status']]) table.align = 'l' print(table) @@ -259,7 +377,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']) @@ -278,15 +396,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) @@ -323,15 +441,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) @@ -377,16 +495,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)]) @@ -394,7 +512,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' @@ -416,15 +534,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' @@ -439,7 +557,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']) @@ -462,11 +580,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, @@ -489,11 +607,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' @@ -509,7 +627,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) @@ -544,7 +662,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) @@ -610,7 +728,7 @@ def ns_create(ctx, ssh_keys=ssh_keys, account=vim_account) except ClientException as inst: - print(inst.message) + print((inst.message)) exit(1) @@ -623,7 +741,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') @@ -657,7 +775,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) @@ -699,7 +817,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) @@ -735,7 +853,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) @@ -779,7 +897,7 @@ 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) @@ -842,13 +960,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) @@ -894,7 +1012,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) @@ -914,7 +1032,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) @@ -956,11 +1074,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) @@ -1026,7 +1144,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') @@ -1081,7 +1199,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) @@ -1098,7 +1216,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) @@ -1112,7 +1230,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: @@ -1133,11 +1251,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) @@ -1184,7 +1302,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) @@ -1235,15 +1353,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) @@ -1265,7 +1383,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) @@ -1281,7 +1399,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( @@ -1325,7 +1443,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) @@ -1336,7 +1454,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(): @@ -1360,7 +1478,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) @@ -1384,7 +1502,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') @@ -1394,7 +1512,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) @@ -1437,7 +1555,7 @@ 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)