X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=1fc824e7677a44592450dec88fec40b249aecbdc;hb=6a9fdb5215ac407f2b39cb82194c54926cb2fb8a;hp=c1a7f1889b1a3a31256a03d8069745832b0e9f92;hpb=017c4fb032ab1f63e1ce474e12787204f33fce96;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index c1a7f18..1fc824e 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -35,10 +35,10 @@ def check_client_version(obj, what, version='sol005'): :return: - :raises ClientError: if the specified version does not match the client version ''' - fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ - message = 'the following commands or options are only supported with the option "--sol005": {}'.format(what) + fullclassname = obj.__module__ + "." + obj.__class__.__name__ + message = 'The following commands or options are only supported with the option "--sol005": {}'.format(what) if version == 'v1': - message = 'the following commands or options are not supported when using option "--sol005": {}'.format(what) + message = 'The following commands or options are not supported when using option "--sol005": {}'.format(what) if fullclassname != 'osmclient.{}.client.Client'.format(version): raise ClientException(message) return @@ -104,7 +104,7 @@ def cli(ctx, hostname, so_port, so_project, ro_hostname, ro_port, sol005): def ns_list(ctx, filter): '''list all NS instances''' if filter: - check_client_version(ctx.obj, '--filter option') + check_client_version(ctx.obj, '--filter') resp = ctx.obj.ns.list(filter) else: resp = ctx.obj.ns.list() @@ -112,23 +112,30 @@ def ns_list(ctx, filter): ['ns instance name', 'id', 'operational status', - 'config status']) + 'config status', + 'detailed status']) for ns in resp: fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': nsr = ns + nsr_name = nsr['name'] + nsr_id = nsr['_id'] else: nsopdata = ctx.obj.ns.get_opdata(ns['id']) nsr = nsopdata['nsr:nsr'] + nsr_name = nsr['name-ref'] + nsr_id = nsr['ns-instance-config-ref'] opstatus = nsr['operational-status'] if 'operational-status' in nsr else 'Not found' configstatus = nsr['config-status'] if 'config-status' in nsr else 'Not found' + detailed_status = nsr['detailed-status'] if 'detailed-status' in nsr else 'Not found' if configstatus == "config_not_needed": configstatus = "configured (no charms)" table.add_row( - [nsr['name'], - nsr['_id'], + [nsr_name, + nsr_id, opstatus, - configstatus]) + configstatus, + detailed_status]) table.align = 'l' print(table) @@ -213,7 +220,12 @@ def vnfd_list2(ctx, filter): @click.pass_context def vnf_list(ctx): ''' list all VNF instances''' - resp = ctx.obj.vnf.list() + try: + check_client_version(ctx.obj, ctx.command.name, 'v1') + resp = ctx.obj.vnf.list() + except ClientException as inst: + print(inst.message) + exit(1) table = PrettyTable( ['vnf name', 'id', @@ -231,6 +243,27 @@ def vnf_list(ctx): table.align = 'l' print(table) +@cli.command(name='ns-op-list') +@click.argument('name') +@click.pass_context +def ns_op_list(ctx, name): + '''shows the history of operations over a NS instance + + NAME: name or ID of the NS instance + ''' + try: + check_client_version(ctx.obj, ctx.command.name) + resp = ctx.obj.ns.list_op(name) + except ClientException as inst: + print(inst.message) + exit(1) + + table = PrettyTable(['id', 'operation', 'status']) + for op in resp: + table.add_row([op['id'], op['lcmOperationType'], + op['operationState']]) + table.align = 'l' + print(table) #################### # SHOW operations @@ -439,6 +472,29 @@ def ns_monitoring_show(ctx, ns_name): table.align = 'l' print(table) +@cli.command(name='ns-op-show', short_help='shows the info of an 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 + + ID: operation identifier + ''' + try: + check_client_version(ctx.obj, ctx.command.name) + op_info = ctx.obj.ns.get_op(id) + except ClientException as inst: + print(inst.message) + exit(1) + + table = PrettyTable(['field', 'value']) + for k, v in op_info.items(): + if filter is None or filter in k: + table.add_row([k, json.dumps(v, indent=2)]) + table.align = 'l' + print(table) + #################### # CREATE operations @@ -529,7 +585,8 @@ def vnfd_create2(ctx, filename, overwrite): help='comma separated list of keys to inject to vnfs') @click.option('--config', default=None, - help='ns specific yaml configuration') + 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]') @click.pass_context def ns_create(ctx, nsd_name, @@ -540,8 +597,8 @@ def ns_create(ctx, config): '''creates a new NS instance''' try: - if config: - check_client_version(ctx.obj, '--config', 'v1') + # if config: + # check_client_version(ctx.obj, '--config', 'v1') ctx.obj.ns.create( nsd_name, ns_name, @@ -856,6 +913,184 @@ def vim_show(ctx, name): ''' try: resp = ctx.obj.vim.get(name) + if 'vim_password' in resp: + resp['vim_password']='********' + except ClientException as inst: + print(inst.message) + exit(1) + + table = PrettyTable(['key', 'attribute']) + for k, v in resp.items(): + table.add_row([k, json.dumps(v, indent=2)]) + table.align = 'l' + print(table) + + +#################### +# SDN controller operations +#################### + +@cli.command(name='sdnc-create') +@click.option('--name', + prompt=True, + help='Name to create sdn controller') +@click.option('--type', + prompt=True, + help='SDN controller type') +@click.option('--sdn_controller_version', + help='SDN controller username') +@click.option('--ip_address', + prompt=True, + help='SDN controller IP address') +@click.option('--port', + prompt=True, + help='SDN controller port') +@click.option('--switch_dpid', + prompt=True, + help='Switch DPID (Openflow Datapath ID)') +@click.option('--user', + help='SDN controller username') +@click.option('--password', + hide_input=True, + confirmation_prompt=True, + help='SDN controller password') +#@click.option('--description', +# default='no description', +# help='human readable description') +@click.pass_context +def sdnc_create(ctx, + name, + type, + sdn_controller_version, + ip_address, + port, + switch_dpid, + user, + password): + '''creates a new SDN controller + ''' + sdncontroller = {} + sdncontroller['name'] = name + sdncontroller['type'] = type + sdncontroller['ip'] = ip_address + sdncontroller['port'] = int(port) + sdncontroller['dpid'] = switch_dpid + if sdn_controller_version: + sdncontroller['version'] = sdn_controller_version + if user: + sdncontroller['user'] = user + if password: + sdncontroller['password'] = password +# sdncontroller['description'] = description + try: + check_client_version(ctx.obj, ctx.command.name) + ctx.obj.sdnc.create(name, sdncontroller) + except ClientException as inst: + print(inst.message) + + +@cli.command(name='sdnc-update', short_help='updates an SDN controller') +@click.argument('name') +@click.option('--newname', help='New name for the SDN controller') +@click.option('--type', help='SDN controller type') +@click.option('--sdn_controller_version', help='SDN controller username') +@click.option('--ip_address', help='SDN controller IP address') +@click.option('--port', help='SDN controller port') +@click.option('--switch_dpid', help='Switch DPID (Openflow Datapath ID)') +@click.option('--user', help='SDN controller username') +@click.option('--password', help='SDN controller password') +#@click.option('--description', default=None, help='human readable description') +@click.pass_context +def sdnc_update(ctx, + name, + newname, + type, + sdn_controller_version, + ip_address, + port, + switch_dpid, + user, + password): + '''updates an SDN controller + + NAME: name or ID of the SDN controller + ''' + sdncontroller = {} + if newname: sdncontroller['name'] = newname + if type: sdncontroller['type'] = type + if ip_address: sdncontroller['ip'] = ip_address + if port: sdncontroller['port'] = int(port) + if switch_dpid: sdncontroller['dpid'] = switch_dpid +# sdncontroller['description'] = description + if sdn_controller_version is not None: + if sdn_controller_version=="": + sdncontroller['version'] = None + else: + sdncontroller['version'] = sdn_controller_version + if user is not None: + if user=="": + sdncontroller['user'] = None + else: + sdncontroller['user'] = user + if password is not None: + if password=="": + sdncontroller['password'] = None + else: + sdncontroller['password'] = user + try: + check_client_version(ctx.obj, ctx.command.name) + ctx.obj.sdnc.update(name, sdncontroller) + except ClientException as inst: + print(inst.message) + exit(1) + + +@cli.command(name='sdnc-delete') +@click.argument('name') +@click.pass_context +def sdnc_delete(ctx, name): + '''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) + except ClientException as inst: + print(inst.message) + exit(1) + + +@cli.command(name='sdnc-list') +@click.option('--filter', default=None, + help='restricts the list to the SDN controllers matching the filter') +@click.pass_context +def sdnc_list(ctx, filter): + '''list all SDN controllers''' + try: + check_client_version(ctx.obj, ctx.command.name) + resp = ctx.obj.sdnc.list(filter) + except ClientException as inst: + print(inst.message) + exit(1) + table = PrettyTable(['name', 'id']) + for sdnc in resp: + table.add_row([sdnc['name'], sdnc['_id']]) + table.align = 'l' + print(table) + + +@cli.command(name='sdnc-show') +@click.argument('name') +@click.pass_context +def sdnc_show(ctx, name): + '''shows the details of an SDN controller + + NAME: name or ID of the SDN controller + ''' + try: + check_client_version(ctx.obj, ctx.command.name) + resp = ctx.obj.sdnc.get(name) except ClientException as inst: print(inst.message) exit(1) @@ -867,6 +1102,110 @@ def vim_show(ctx, name): print(table) +#################### +# Fault Management operations +#################### + +@cli.command(name='ns-alarm-create') +@click.argument('name') +@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)') +@click.option('--vdu', prompt=True, + help='VDU name (VDU name as declared in the VNFD)') +@click.option('--metric', prompt=True, + help='Name of the metric (e.g. cpu_utilization)') +@click.option('--severity', default='WARNING', + help='severity of the alarm (WARNING, MINOR, MAJOR, CRITICAL, INDETERMINATE)') +@click.option('--threshold_value', prompt=True, + help='threshold value that, when crossed, an alarm is triggered') +@click.option('--threshold_operator', prompt=True, + help='threshold operator describing the comparison (GE, LE, GT, LT, EQ)') +@click.option('--statistic', default='AVERAGE', + help='statistic (AVERAGE, MINIMUM, MAXIMUM, COUNT, SUM)') +@click.pass_context +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: + check_client_version(ctx.obj, ctx.command.name) + ctx.obj.ns.create_alarm(alarm) + except ClientException as inst: + print(inst.message) + exit(1) + + +#@cli.command(name='ns-alarm-delete') +#@click.argument('name') +#@click.pass_context +#def ns_alarm_delete(ctx, name): +# '''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) +# except ClientException as inst: +# print(inst.message) +# exit(1) + + +#################### +# Performance Management operations +#################### + +@cli.command(name='ns-metric-export') +@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)') +@click.option('--vdu', prompt=True, + help='VDU name (VDU name as declared in the VNFD)') +@click.option('--metric', prompt=True, + help='name of the metric (e.g. cpu_utilization)') +#@click.option('--period', default='1w', +# help='metric collection period (e.g. 20s, 30m, 2h, 3d, 1w)') +@click.option('--interval', help='periodic interval (seconds) to export metrics continuously') +@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: + check_client_version(ctx.obj, ctx.command.name) + if not interval: + print '{}'.format(ctx.obj.ns.export_metric(metric_data)) + else: + i = 1 + while True: + print '{} {}'.format(ctx.obj.ns.export_metric(metric_data),i) + time.sleep(int(interval)) + i+=1 + except ClientException as inst: + print(inst.message) + exit(1) + + #################### # Other operations #################### @@ -893,8 +1232,16 @@ def upload_package(ctx, filename): @click.argument('ns_name') @click.pass_context def show_ns_scaling(ctx, ns_name): - check_client_version(ctx.obj, ctx.command.name, 'v1') - resp = ctx.obj.ns.list() + '''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', @@ -929,14 +1276,27 @@ def show_ns_scaling(ctx, ns_name): @click.option('--index', prompt=True) @click.pass_context 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) + '''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): - check_client_version(ctx.obj, ctx.command.name, 'v1') + '''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( @@ -951,6 +1311,10 @@ def config_agent_list(ctx): @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) @@ -974,6 +1338,7 @@ def config_agent_delete(ctx, name): 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) @@ -984,6 +1349,7 @@ def config_agent_add(ctx, name, account_type, server, user, secret): @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']) @@ -1005,5 +1371,34 @@ def vcs_list(ctx): print(table) +@cli.command(name='ns-action') +@click.argument('ns_name') +@click.option('--vnf_name', default=None) +@click.option('--action_name', prompt=True) +@click.option('--params', prompt=True) +@click.pass_context +def ns_action(ctx, + ns_name, + vnf_name, + action_name, + params): + '''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={} + if vnf_name: + op_data['vnf_member_index'] = vnf_name + 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) + + except ClientException as inst: + print(inst.message) + exit(1) + + if __name__ == '__main__': cli()