X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=c6de974310b56973f3dfd475861b64d730298451;hb=6568d6e3d301476ff902b29ac5f2471fa2e614a2;hp=f61373ecd2db309acfde7d6c8581de28a67fd0a0;hpb=bd39b09580560307a1ac23be4984783d1bea9238;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index f61373e..c6de974 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -97,6 +97,22 @@ def check_client_version(obj, what, version='sol005'): 'Also can set OSM_PROJECT in environment') @click.option('-v', '--verbose', count=True, help='increase verbosity (-v INFO, -vv VERBOSE, -vvv DEBUG)') +@click.option('--all-projects', + default=None, + is_flag=True, + help='include all projects') +@click.option('--public/--no-public', default=None, + help='flag for public items (packages, instances, VIM accounts, etc.)') +@click.option('--project-domain-name', 'project_domain_name', + default=None, + envvar='OSM_PROJECT_DOMAIN_NAME', + help='project domain name for keystone authentication (default to None). ' + + 'Also can set OSM_PROJECT_DOMAIN_NAME in environment') +@click.option('--user-domain-name', 'user_domain_name', + default=None, + envvar='OSM_USER_DOMAIN_NAME', + help='user domain name for keystone authentication (default to None). ' + + 'Also can set OSM_USER_DOMAIN_NAME in environment') #@click.option('--so-port', # default=None, # envvar='OSM_SO_PORT', @@ -118,14 +134,16 @@ def check_client_version(obj, what, version='sol005'): # help='hostname of RO server. ' + # 'Also can set OSM_RO_PORT in environment') @click.pass_context -def cli_osm(ctx, hostname, user, password, project, verbose): +def cli_osm(ctx, **kwargs): global logger + hostname = kwargs.pop("hostname", None) if hostname is None: print(( "either hostname option or OSM_HOSTNAME " + "environment variable needs to be specified")) exit(1) - kwargs = {'verbose': verbose} + # Remove None values + kwargs = {k: v for k, v in kwargs.items() if v is not None} # if so_port is not None: # kwargs['so_port']=so_port # if so_project is not None: @@ -135,12 +153,16 @@ def cli_osm(ctx, hostname, user, password, project, verbose): # 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: - kwargs['password']=password - if project is not None: - kwargs['project']=project +# if user is not None: +# kwargs['user']=user +# if password is not None: +# kwargs['password']=password +# if project is not None: +# kwargs['project']=project +# if all_projects: +# kwargs['all_projects']=all_projects +# if public is not None: +# kwargs['public']=public ctx.obj = client.Client(host=hostname, sol005=sol005, **kwargs) logger = logging.getLogger('osmclient') @@ -152,10 +174,10 @@ def cli_osm(ctx, hostname, user, password, project, verbose): @cli_osm.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.option('--details', is_flag=True, - help='get more details of current operation in the NS.') +@click.option('--long', is_flag=True, + help='get more details of the NS (project, vim, deployment status, configuration status.') @click.pass_context -def ns_list(ctx, filter,details): +def ns_list(ctx, filter, long): """list all NS instances \b @@ -206,9 +228,11 @@ def ns_list(ctx, filter,details): def summarize_deployment_status(status_dict): #Nets summary = "" + if not status_dict: + return summary n_nets = 0 status_nets = {} - net_list = status_dict['nets'] + net_list = status_dict.get('nets',[]) for net in net_list: n_nets += 1 if net['status'] not in status_nets: @@ -256,6 +280,9 @@ def ns_list(ctx, filter,details): return summary def summarize_config_status(ee_list): + summary = "" + if not ee_list: + return summary n_ee = 0 status_ee = {} for ee in ee_list: @@ -268,7 +295,6 @@ def ns_list(ctx, filter,details): status_ee[ee['elementType']][ee['status']] += 1 else: status_ee[ee['elementType']][ee['status']] = 1 - summary = "" for elementType in ["KDU", "VDU", "PDU", "VNF", "NS"]: if elementType in status_ee: message = "" @@ -280,25 +306,32 @@ def ns_list(ctx, filter,details): summary += "{}: {}".format(elementType, message) summary += "TOTAL Exec. Env.: {}".format(n_ee) return summary + logger.debug("") if filter: check_client_version(ctx.obj, '--filter') resp = ctx.obj.ns.list(filter) else: resp = ctx.obj.ns.list() - if details: + if long: table = PrettyTable( ['ns instance name', 'id', + 'date', 'ns state', 'current operation', 'error details', + 'project', + 'vim (inst param)', 'deployment status', 'configuration status']) + project_list = ctx.obj.project.list() + vim_list = ctx.obj.vim.list() else: table = PrettyTable( ['ns instance name', 'id', + 'date', 'ns state', 'current operation', 'error details']) @@ -306,42 +339,69 @@ def ns_list(ctx, filter,details): fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': nsr = ns + logger.debug('NS info: {}'.format(nsr)) nsr_name = nsr['name'] nsr_id = nsr['_id'] - ns_state = nsr['nsState'] - if details: - deployment_status = summarize_deployment_status(nsr['deploymentStatus']) - config_status = summarize_config_status(nsr['configurationStatus']) - current_operation = "{} ({})".format(nsr['currentOperation'],nsr['currentOperationID']) + date = datetime.fromtimestamp(nsr['create-time']).strftime("%Y-%m-%dT%H:%M:%S") + ns_state = nsr.get('nsState', nsr['_admin']['nsState']) + if long: + deployment_status = summarize_deployment_status(nsr.get('deploymentStatus')) + config_status = summarize_config_status(nsr.get('configurationStatus')) + project_id = nsr.get('_admin').get('projects_read')[0] + project_name = '-' + for p in project_list: + if p['_id'] == project_id: + project_name = p['name'] + break + #project = '{} ({})'.format(project_name, project_id) + project = project_name + vim_id = nsr.get('datacenter') + vim_name = '-' + for v in vim_list: + if v['uuid'] == vim_id: + vim_name = v['name'] + break + #vim = '{} ({})'.format(vim_name, vim_id) + vim = vim_name + if 'currentOperation' in nsr: + current_operation = "{} ({})".format(nsr['currentOperation'],nsr['currentOperationID']) + else: + current_operation = "{} ({})".format(nsr['_admin'].get('current-operation','-'), nsr['_admin']['nslcmop']) error_details = "N/A" - if ns_state == "BROKEN" or ns_state == "DEGRADED": - error_details = "{}\nDetail: {}".format(nsr['errorDescription'],nsr['errorDetail']) + if ns_state == "BROKEN" or ns_state == "DEGRADED" or nsr.get('errorDescription'): + error_details = "{}\nDetail: {}".format(nsr['errorDescription'], nsr['errorDetail']) 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'] + date = '-' + project = '-' deployment_status = nsr['operational-status'] if 'operational-status' in nsr else 'Not found' ns_state = deployment_status - config_status = nsr['config-status'] if 'config-status' in nsr else 'Not found' + config_status = nsr.get('config-status', 'Not found') current_operation = "Unknown" - error_details = nsr['detailed-status'] if 'detailed-status' in nsr else 'Not found' + error_details = nsr.get('detailed-status', 'Not found') if config_status == "config_not_needed": config_status = "configured (no charms)" - if details: + if long: table.add_row( [nsr_name, nsr_id, + date, ns_state, current_operation, wrap_text(text=error_details,width=40), + project, + vim, deployment_status, config_status]) else: table.add_row( [nsr_name, nsr_id, + date, ns_state, current_operation, wrap_text(text=error_details,width=40)]) @@ -350,7 +410,7 @@ def ns_list(ctx, filter,details): print('To get the history of all operations over a NS, run "osm ns-op-list NS_ID"') print('For more details on the current operation, run "osm ns-op-show OPERATION_ID"') -def nsd_list(ctx, filter): +def nsd_list(ctx, filter, long): logger.debug("") if filter: check_client_version(ctx.obj, '--filter') @@ -358,15 +418,28 @@ def nsd_list(ctx, filter): else: resp = ctx.obj.nsd.list() # print(yaml.safe_dump(resp)) - table = PrettyTable(['nsd name', 'id']) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': - for ns in resp: - name = ns['name'] if 'name' in ns else '-' - table.add_row([name, ns['_id']]) + if long: + table = PrettyTable(['nsd name', 'id', 'onboarding state', 'operational state', + 'usage state', 'date', 'last update']) + else: + table = PrettyTable(['nsd name', 'id']) + for nsd in resp: + name = nsd.get('name','-') + if long: + onb_state = nsd['_admin'].get('onboardingState','-') + op_state = nsd['_admin'].get('operationalState','-') + usage_state = nsd['_admin'].get('usageState','-') + date = datetime.fromtimestamp(nsd['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(nsd['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S") + table.add_row([name, nsd['_id'], onb_state, op_state, usage_state, date, last_update]) + else: + table.add_row([name, nsd['_id']]) else: - for ns in resp: - table.add_row([ns['name'], ns['id']]) + table = PrettyTable(['nsd name', 'id']) + for nsd in resp: + table.add_row([nsd['name'], nsd['id']]) table.align = 'l' print(table) @@ -374,24 +447,26 @@ def nsd_list(ctx, filter): @cli_osm.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.option('--long', is_flag=True, help='get more details') @click.pass_context -def nsd_list1(ctx, filter): +def nsd_list1(ctx, filter, long): """list all NSD/NS pkg in the system""" logger.debug("") - nsd_list(ctx, filter) + nsd_list(ctx, filter, long) @cli_osm.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.option('--long', is_flag=True, help='get more details') @click.pass_context -def nsd_list2(ctx, filter): +def nsd_list2(ctx, filter, long): """list all NS packages""" logger.debug("") - nsd_list(ctx, filter) + nsd_list(ctx, filter, long) -def vnfd_list(ctx, nf_type, filter): +def vnfd_list(ctx, nf_type, filter, long): logger.debug("") if nf_type: check_client_version(ctx.obj, '--nf_type') @@ -415,13 +490,26 @@ def vnfd_list(ctx, nf_type, filter): else: resp = ctx.obj.vnfd.list() # print(yaml.safe_dump(resp)) - table = PrettyTable(['nfpkg name', 'id']) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': + if long: + table = PrettyTable(['nfpkg name', 'id', 'onboarding state', 'operational state', + 'usage state', 'date', 'last update']) + else: + table = PrettyTable(['nfpkg name', 'id']) for vnfd in resp: name = vnfd['name'] if 'name' in vnfd else '-' - table.add_row([name, vnfd['_id']]) + if long: + onb_state = vnfd['_admin'].get('onboardingState','-') + op_state = vnfd['_admin'].get('operationalState','-') + usage_state = vnfd['_admin'].get('usageState','-') + date = datetime.fromtimestamp(vnfd['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(vnfd['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S") + table.add_row([name, vnfd['_id'], onb_state, op_state, usage_state, date, last_update]) + else: + table.add_row([name, vnfd['_id']]) else: + table = PrettyTable(['nfpkg name', 'id']) for vnfd in resp: table.add_row([vnfd['name'], vnfd['id']]) table.align = 'l' @@ -432,41 +520,44 @@ def vnfd_list(ctx, nf_type, filter): @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.option('--long', is_flag=True, help='get more details') @click.pass_context -def vnfd_list1(ctx, nf_type, filter): +def vnfd_list1(ctx, nf_type, filter, long): """list all xNF packages (VNF, HNF, PNF)""" logger.debug("") - vnfd_list(ctx, nf_type, filter) + vnfd_list(ctx, nf_type, filter, long) @cli_osm.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.option('--long', is_flag=True, help='get more details') @click.pass_context -def vnfd_list2(ctx, nf_type, filter): +def vnfd_list2(ctx, nf_type, filter, long): """list all xNF packages (VNF, HNF, PNF)""" logger.debug("") - vnfd_list(ctx, nf_type, filter) + vnfd_list(ctx, nf_type, filter, long) @cli_osm.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.option('--long', is_flag=True, help='get more details') @click.pass_context -def nfpkg_list(ctx, nf_type, filter): +def nfpkg_list(ctx, nf_type, filter, long): """list all xNF packages (VNF, HNF, PNF)""" logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) - vnfd_list(ctx, nf_type, filter) + vnfd_list(ctx, nf_type, filter, long) # except ClientException as e: # print(str(e)) # exit(1) -def vnf_list(ctx, ns, filter): +def vnf_list(ctx, ns, filter, long): # try: if ns or filter: if ns: @@ -481,24 +572,23 @@ def vnf_list(ctx, ns, filter): # exit(1) 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']) + field_names = ['vnf id', 'name', 'ns id', 'vnf member index', + 'vnfd name', 'vim account id', 'ip address'] + if long: + field_names = ['vnf id', 'name', 'ns id', 'vnf member index', + 'vnfd name', 'vim account id', 'ip address', + 'date', 'last update'] + table = PrettyTable(field_names) 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']]) + new_row = [vnfr['_id'], name, vnfr['nsr-id-ref'], + vnfr['member-vnf-index-ref'], vnfr['vnfd-ref'], + vnfr['vim-account-id'], vnfr['ip-address']] + if long: + date = datetime.fromtimestamp(vnfr['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(vnfr['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S") + new_row.extend([date, last_update]) + table.add_row(new_row) else: table = PrettyTable( ['vnf name', @@ -522,19 +612,21 @@ def vnf_list(ctx, ns, filter): @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.') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def vnf_list1(ctx, ns, filter): +def vnf_list1(ctx, ns, filter, long): """list all NF instances""" logger.debug("") - vnf_list(ctx, ns, filter) + vnf_list(ctx, ns, filter, long) @cli_osm.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.') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def nf_list(ctx, ns, filter): +def nf_list(ctx, ns, filter, long): """list all NF instances \b @@ -588,8 +680,10 @@ def nf_list(ctx, ns, filter): @cli_osm.command(name='ns-op-list', short_help='shows the history of operations over a NS instance') @click.argument('name') +@click.option('--long', is_flag=True, + help='get more details of the NS operation (date, ).') @click.pass_context -def ns_op_list(ctx, name): +def ns_op_list(ctx, name, long): """shows the history of operations over a NS instance NAME: name or ID of the NS instance @@ -614,7 +708,11 @@ def ns_op_list(ctx, name): # print(str(e)) # exit(1) - table = PrettyTable(['id', 'operation', 'action_name', 'operation_params', 'status', 'detail']) + if long: + table = PrettyTable(['id', 'operation', 'action_name', 'operation_params', 'status', 'date', 'last update', 'detail']) + else: + table = PrettyTable(['id', 'operation', 'action_name', 'status', 'date', 'detail']) + #print(yaml.safe_dump(resp)) for op in resp: action_name = "N/A" @@ -622,19 +720,27 @@ def ns_op_list(ctx, name): action_name = op['operationParams']['primitive'] detail = "-" if op['operationState']=='PROCESSING': - if op['lcmOperationType']=='instantiate': + if op['lcmOperationType'] in ('instantiate', 'terminate'): if op['stage']: detail = op['stage'] else: detail = "In queue. Current position: {}".format(op['queuePosition']) - elif op['operationState']=='FAILED' or op['operationState']=='FAILED_TEMP': - detail = op['errorMessage'] - table.add_row([op['id'], - op['lcmOperationType'], - action_name, - wrap_text(text=json.dumps(formatParams(op['operationParams']),indent=2),width=70), - op['operationState'], - wrap_text(text=detail,width=50)]) + elif op['operationState'] in ('FAILED', 'FAILED_TEMP'): + detail = op.get('errorMessage','-') + date = datetime.fromtimestamp(op['startTime']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(op['statusEnteredTime']).strftime("%Y-%m-%dT%H:%M:%S") + if long: + table.add_row([op['id'], + op['lcmOperationType'], + action_name, + wrap_text(text=json.dumps(formatParams(op['operationParams']),indent=2),width=50), + op['operationState'], + date, + last_update, + wrap_text(text=detail,width=50)]) + else: + table.add_row([op['id'], op['lcmOperationType'], action_name, + op['operationState'], date, wrap_text(text=detail or "",width=50)]) table.align = 'l' print(table) @@ -824,7 +930,7 @@ def nsd_show(ctx, name, literal): table = PrettyTable(['field', 'value']) for k, v in list(resp.items()): - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) table.align = 'l' print(table) @@ -872,7 +978,7 @@ def vnfd_show(ctx, name, literal): table = PrettyTable(['field', 'value']) for k, v in list(resp.items()): - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) table.align = 'l' print(table) @@ -978,7 +1084,7 @@ def vnf_show(ctx, name, literal, filter, kdu): if "namespace" in op_status and "info" in op_status and \ "last_deployed" in op_status["info"] and "status" in op_status["info"] and \ "code" in op_status["info"]["status"] and "resources" in op_status["info"]["status"] and \ - "notes" in op_status["info"]["status"] and "seconds" in op_status["info"]["last_deployed"]: + "seconds" in op_status["info"]["last_deployed"]: last_deployed_time = datetime.fromtimestamp(op_status["info"]["last_deployed"]["seconds"]).strftime("%a %b %d %I:%M:%S %Y") print("LAST DEPLOYED: {}".format(last_deployed_time)) print("NAMESPACE: {}".format(op_status["namespace"])) @@ -989,8 +1095,9 @@ def vnf_show(ctx, name, literal, filter, kdu): print() print("RESOURCES:") print(op_status["info"]["status"]["resources"]) - print("NOTES:") - print(op_status["info"]["status"]["notes"]) + if "notes" in op_status["info"]["status"]: + print("NOTES:") + print(op_status["info"]["status"]["notes"]) else: print(op_info_status) except Exception: @@ -1300,11 +1407,11 @@ def pdu_show(ctx, name, literal, filter): # CREATE operations #################### -def nsd_create(ctx, filename, overwrite): +def nsd_create(ctx, filename, overwrite, skip_charm_build): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.nsd.create(filename, overwrite) + ctx.obj.nsd.create(filename, overwrite=overwrite, skip_charm_build=skip_charm_build) # except ClientException as e: # print(str(e)) # exit(1) @@ -1317,14 +1424,16 @@ def nsd_create(ctx, filename, overwrite): @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') @click.pass_context -def nsd_create1(ctx, filename, overwrite): +def nsd_create1(ctx, filename, overwrite, skip_charm_build): """creates a new NSD/NSpkg FILENAME: NSD yaml file or NSpkg tar.gz file """ logger.debug("") - nsd_create(ctx, filename, overwrite) + nsd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build) @cli_osm.command(name='nspkg-create', short_help='creates a new NSD/NSpkg') @@ -1334,21 +1443,25 @@ def nsd_create1(ctx, filename, overwrite): @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') @click.pass_context -def nsd_create2(ctx, filename, overwrite): +def nsd_create2(ctx, filename, overwrite, skip_charm_build): """creates a new NSD/NSpkg - FILENAME: NSD yaml file or NSpkg tar.gz file + FILENAME: NSD folder, NSD yaml file or NSpkg tar.gz file """ logger.debug("") - nsd_create(ctx, filename, overwrite) + nsd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build) -def vnfd_create(ctx, filename, overwrite): +def vnfd_create(ctx, filename, overwrite, skip_charm_build, override_epa, override_nonepa, override_paravirt): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.vnfd.create(filename, overwrite) + ctx.obj.vnfd.create(filename, overwrite=overwrite, skip_charm_build=skip_charm_build, + override_epa=override_epa, override_nonepa=override_nonepa, + override_paravirt=override_paravirt) # except ClientException as e: # print(str(e)) # exit(1) @@ -1361,14 +1474,23 @@ def vnfd_create(ctx, filename, overwrite): @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): +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') +@click.option('--override-epa', required=False, default=False, is_flag=True, + help='adds guest-epa parameters to all VDU') +@click.option('--override-nonepa', required=False, default=False, is_flag=True, + help='removes all guest-epa parameters from all VDU') +@click.option('--override-paravirt', required=False, default=False, is_flag=True, + help='overrides all VDU interfaces to PARAVIRT') +@click.pass_context +def vnfd_create1(ctx, filename, overwrite, skip_charm_build, override_epa, override_nonepa, override_paravirt): """creates a new VNFD/VNFpkg FILENAME: VNFD yaml file or VNFpkg tar.gz file """ logger.debug("") - vnfd_create(ctx, filename, overwrite) + vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build, + override_epa=override_epa, override_nonepa=override_nonepa, override_paravirt=override_paravirt) @cli_osm.command(name='vnfpkg-create', short_help='creates a new VNFD/VNFpkg') @@ -1378,14 +1500,23 @@ def vnfd_create1(ctx, filename, overwrite): @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): +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') +@click.option('--override-epa', required=False, default=False, is_flag=True, + help='adds guest-epa parameters to all VDU') +@click.option('--override-nonepa', required=False, default=False, is_flag=True, + help='removes all guest-epa parameters from all VDU') +@click.option('--override-paravirt', required=False, default=False, is_flag=True, + help='overrides all VDU interfaces to PARAVIRT') +@click.pass_context +def vnfd_create2(ctx, filename, overwrite, skip_charm_build, override_epa, override_nonepa, override_paravirt): """creates a new VNFD/VNFpkg - FILENAME: VNFD yaml file or VNFpkg tar.gz file + FILENAME: NF Package Folder, NF Descriptor yaml file or NFpkg tar.gz file """ logger.debug("") - vnfd_create(ctx, filename, overwrite) + vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build, + override_epa=override_epa, override_nonepa=override_nonepa, override_paravirt=override_paravirt) @cli_osm.command(name='nfpkg-create', short_help='creates a new NFpkg') @@ -1395,14 +1526,23 @@ def vnfd_create2(ctx, filename, overwrite): @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): +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') +@click.option('--override-epa', required=False, default=False, is_flag=True, + help='adds guest-epa parameters to all VDU') +@click.option('--override-nonepa', required=False, default=False, is_flag=True, + help='removes all guest-epa parameters from all VDU') +@click.option('--override-paravirt', required=False, default=False, is_flag=True, + help='overrides all VDU interfaces to PARAVIRT') +@click.pass_context +def nfpkg_create(ctx, filename, overwrite, skip_charm_build, override_epa, override_nonepa, override_paravirt): """creates a new NFpkg - FILENAME: NF Descriptor yaml file or NFpkg tar.gz file + FILENAME: NF Package Folder, NF Descriptor yaml file or NFpkg tar.gz filems to build """ logger.debug("") - vnfd_create(ctx, filename, overwrite) + vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build, + override_epa=override_epa, override_nonepa=override_nonepa, override_paravirt=override_paravirt) @cli_osm.command(name='ns-create', short_help='creates a new Network Service instance') @@ -1479,13 +1619,13 @@ def nst_create(ctx, filename, overwrite): help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') @click.pass_context -def nst_create1(ctx, filename, overwrite): +def nst_create1(ctx, charm_folder, overwrite): """creates a new Network Slice Template (NST) - FILENAME: NST yaml file or NSTpkg tar.gz file + FILENAME: NST package folder, NST yaml file or NSTpkg tar.gz file """ logger.debug("") - nst_create(ctx, filename, overwrite) + nst_create(ctx, charm_folder, overwrite) @cli_osm.command(name='netslice-template-create', short_help='creates a new Network Slice Template (NST)') @@ -1863,6 +2003,9 @@ def nfpkg_delete(ctx, name, force): @cli_osm.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('--config', default=None, + help="specific yaml configuration for the termination, e.g. '{autoremove: False, timeout_ns_terminate: " + "600, skip_terminate_primitives: True}'") @click.option('--wait', required=False, default=False, @@ -1870,7 +2013,7 @@ def nfpkg_delete(ctx, name, force): 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, wait): +def ns_delete(ctx, name, force, config, wait): """deletes a NS instance NAME: name or ID of the NS instance to be deleted @@ -1878,10 +2021,10 @@ def ns_delete(ctx, name, force, wait): logger.debug("") # try: if not force: - ctx.obj.ns.delete(name, wait=wait) + ctx.obj.ns.delete(name, config=config, wait=wait) else: check_client_version(ctx.obj, '--force') - ctx.obj.ns.delete(name, force, wait=wait) + ctx.obj.ns.delete(name, force, config=config, wait=wait) # except ClientException as e: # print(str(e)) # exit(1) @@ -2012,7 +2155,7 @@ def pdu_delete(ctx, name, force): default='openstack', help='VIM type') @click.option('--description', - default='no description', + default=None, 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") @@ -2069,7 +2212,8 @@ def vim_create(ctx, @click.option('--config', help='VIM specific config parameters') @click.option('--account_type', help='VIM type') @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_controller', default=None, help='Name or id of the SDN controller to be associated with this VIM' + 'account. Use empty string to disassociate') @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, @@ -2146,8 +2290,10 @@ def vim_delete(ctx, name, force, wait): # help='update list from RO') @click.option('--filter', default=None, help='restricts the list to the VIM accounts matching the filter') +@click.option('--long', is_flag=True, + help='get more details of the NS (project, vim, deployment status, configuration status.') @click.pass_context -def vim_list(ctx, filter): +def vim_list(ctx, filter, long): """list all VIM accounts""" logger.debug("") if filter: @@ -2159,9 +2305,34 @@ def vim_list(ctx, filter): resp = ctx.obj.vim.list(filter) # else: # resp = ctx.obj.vim.list(ro_update) - table = PrettyTable(['vim name', 'uuid']) + if long: + table = PrettyTable(['vim name', 'uuid', 'project', 'operational state', 'error details']) + else: + table = PrettyTable(['vim name', 'uuid']) for vim in resp: - table.add_row([vim['name'], vim['uuid']]) + if long: + vim_details = ctx.obj.vim.get(vim['uuid']) + if 'vim_password' in vim_details: + vim_details['vim_password']='********' + logger.debug('VIM details: {}'.format(yaml.safe_dump(vim_details))) + vim_state = vim_details['_admin'].get('operationalState', '-') + error_details = 'N/A' + if vim_state == 'ERROR': + error_details = vim_details['_admin'].get('detailed-status', 'Not found') + project_list = ctx.obj.project.list() + vim_project_list = vim_details.get('_admin').get('projects_read') + project_id = 'None' + project_name = 'None' + if vim_project_list: + project_id = vim_project_list[0] + for p in project_list: + if p['_id'] == project_id: + project_name = p['name'] + break + table.add_row([vim['name'], vim['uuid'], '{} ({})'.format(project_name, project_id), + vim_state, wrap_text(text=error_details, width=80)]) + else: + table.add_row([vim['name'], vim['uuid']]) table.align = 'l' print(table) @@ -2213,7 +2384,7 @@ def vim_show(ctx, name): @click.option('--wim_type', help='WIM type') @click.option('--description', - default='no description', + default=None, 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 " @@ -2397,9 +2568,10 @@ def wim_show(ctx, name): @click.option('--port', # hidden=True, help='Deprecated. Use --url') @click.option('--switch_dpid', # hidden=True, - help='Deprecated. Use --config {dpid: DPID}') + help='Deprecated. Use --config {switch_id: DPID}') @click.option('--config', - help='Extra information for SDN in yaml format, as {dpid: (Openflow Datapath ID), version: version}') + help='Extra information for SDN in yaml format, as {switch_id: identity used for the plugin (e.g. DPID: ' + 'Openflow Datapath ID), version: version}') @click.option('--user', help='SDN controller username') @click.option('--password', @@ -2419,16 +2591,16 @@ def sdnc_create(ctx, **kwargs): sdncontroller = {x: kwargs[x] for x in kwargs if kwargs[x] and x not in ("wait", "ip_address", "port", "switch_dpid")} if kwargs.get("port"): - print("option '--port' is deprecated, use '-url' instead") + print("option '--port' is deprecated, use '--url' instead") sdncontroller["port"] = int(kwargs["port"]) if kwargs.get("ip_address"): - print("option '--ip_address' is deprecated, use '-url' instead") + print("option '--ip_address' is deprecated, use '--url' instead") sdncontroller["ip"] = kwargs["ip_address"] if kwargs.get("switch_dpid"): - print("option '--switch_dpid' is deprecated, use '---config={dpid: DPID}' instead") + print("option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead") sdncontroller["dpid"] = kwargs["switch_dpid"] if kwargs.get("sdn_controller_version"): - print("option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'" + print("option '--sdn_controller_version' is deprecated, use '--config={version: SDN_CONTROLLER_VERSION}'" " instead") # try: check_client_version(ctx.obj, ctx.command.name) @@ -2444,7 +2616,8 @@ def sdnc_create(ctx, **kwargs): @click.option('--type', help='SDN controller type') @click.option('--url', help='URL in format http[s]://HOST:IP/') @click.option('--config', help='Extra information for SDN in yaml format, as ' - '{dpid: (Openflow Datapath ID), version: version}') + '{switch_id: identity used for the plugin (e.g. DPID: ' + 'Openflow Datapath ID), version: version}') @click.option('--user', help='SDN controller username') @click.option('--password', help='SDN controller password') @click.option('--ip_address', help='Deprecated. Use --url') # hidden=True @@ -2465,13 +2638,13 @@ def sdnc_update(ctx, **kwargs): if kwargs.get("newname"): sdncontroller["name"] = kwargs["newname"] if kwargs.get("port"): - print("option '--port' is deprecated, use '-url' instead") + print("option '--port' is deprecated, use '--url' instead") sdncontroller["port"] = int(kwargs["port"]) if kwargs.get("ip_address"): - print("option '--ip_address' is deprecated, use '-url' instead") + print("option '--ip_address' is deprecated, use '--url' instead") sdncontroller["ip"] = kwargs["ip_address"] if kwargs.get("switch_dpid"): - print("option '--switch_dpid' is deprecated, use '---config={dpid: DPID}' instead") + print("option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead") sdncontroller["dpid"] = kwargs["switch_dpid"] if kwargs.get("sdn_controller_version"): print("option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'" @@ -2552,7 +2725,7 @@ def sdnc_show(ctx, name): # K8s cluster operations ########################### -@cli_osm.command(name='k8scluster-add') +@cli_osm.command(name='k8scluster-add', short_help='adds a K8s cluster to OSM') @click.argument('name') @click.option('--creds', prompt=True, @@ -2567,7 +2740,7 @@ def sdnc_show(ctx, name): prompt=True, help='list of VIM networks, in JSON inline format, where the cluster is accessible via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"') @click.option('--description', - default='', + default=None, help='human readable description') @click.option('--namespace', default='kube-system', @@ -2604,7 +2777,8 @@ def k8scluster_add(ctx, cluster['k8s_version'] = version cluster['vim_account'] = vim cluster['nets'] = yaml.safe_load(k8s_nets) - cluster['description'] = description + if description: + cluster['description'] = description if namespace: cluster['namespace'] = namespace if cni: cluster['cni'] = yaml.safe_load(cni) ctx.obj.k8scluster.create(name, cluster) @@ -2657,7 +2831,7 @@ def k8scluster_update(ctx, # exit(1) -@cli_osm.command(name='k8scluster-delete') +@cli_osm.command(name='k8scluster-delete', short_help='deletes a K8s cluster') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)') #@click.option('--wait', @@ -2703,7 +2877,7 @@ def k8scluster_list(ctx, filter, literal): # exit(1) -@cli_osm.command(name='k8scluster-show') +@cli_osm.command(name='k8scluster-show', short_help='shows the details of a K8s cluster') @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @@ -2733,7 +2907,7 @@ def k8scluster_show(ctx, name, literal): # Repo operations ########################### -@cli_osm.command(name='repo-add') +@cli_osm.command(name='repo-add', short_help='adds a repo to OSM') @click.argument('name') @click.argument('uri') @click.option('--type', @@ -2741,7 +2915,7 @@ def k8scluster_show(ctx, name, literal): prompt=True, help='type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles)') @click.option('--description', - default='', + default=None, help='human readable description') #@click.option('--wait', # is_flag=True, @@ -2763,14 +2937,15 @@ def repo_add(ctx, repo['name'] = name repo['url'] = uri repo['type'] = type - repo['description'] = description + if description: + repo['description'] = description ctx.obj.repo.create(name, repo) # except ClientException as e: # print(str(e)) # exit(1) -@cli_osm.command(name='repo-update') +@cli_osm.command(name='repo-update', short_help='updates a repo in OSM') @click.argument('name') @click.option('--newname', help='New name for the repo') @click.option('--uri', help='URI of the repo') @@ -2804,7 +2979,7 @@ def repo_update(ctx, # exit(1) -@cli_osm.command(name='repo-delete') +@cli_osm.command(name='repo-delete', short_help='deletes a repo') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)') #@click.option('--wait', @@ -2849,7 +3024,7 @@ def repo_list(ctx, filter, literal): # exit(1) -@cli_osm.command(name='repo-show') +@cli_osm.command(name='repo-show', short_help='shows the details of a repo') @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @@ -2884,15 +3059,21 @@ def repo_show(ctx, name, literal): #@click.option('--description', # default='no description', # help='human readable description') +@click.option('--domain-name', 'domain_name', + default=None, + help='assign to a domain') @click.pass_context -def project_create(ctx, name): +def project_create(ctx, name, domain_name): """Creates a new project NAME: name of the project + DOMAIN_NAME: optional domain name for the project when keystone authentication is used """ logger.debug("") project = {} project['name'] = name + if domain_name: + project['domain_name'] = domain_name # try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.project.create(name, project) @@ -3007,9 +3188,12 @@ def project_update(ctx, project, name): help='list of project ids that the user belongs to') @click.option('--project-role-mappings', 'project_role_mappings', default=None, multiple=True, - help='creating user project/role(s) mapping') + help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'") +@click.option('--domain-name', 'domain_name', + default=None, + help='assign to a domain') @click.pass_context -def user_create(ctx, username, password, projects, project_role_mappings): +def user_create(ctx, username, password, projects, project_role_mappings, domain_name): """Creates a new user \b @@ -3017,6 +3201,7 @@ def user_create(ctx, username, password, projects, project_role_mappings): PASSWORD: password of the user PROJECTS: projects assigned to user (internal only) PROJECT_ROLE_MAPPING: roles in projects assigned to user (keystone) + DOMAIN_NAME: optional domain name for the user when keystone authentication is used """ logger.debug("") user = {} @@ -3024,7 +3209,9 @@ def user_create(ctx, username, password, projects, project_role_mappings): user['password'] = password user['projects'] = projects user['project_role_mappings'] = project_role_mappings - + if domain_name: + user['domain_name'] = domain_name + # try: check_client_version(ctx.obj, ctx.command.name) ctx.obj.user.create(username, user) @@ -3045,16 +3232,16 @@ def user_create(ctx, username, password, projects, project_role_mappings): 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,...\'') + help="create/replace the roles for this project: 'project,role1[,role2,...]'") @click.option('--remove-project', 'remove_project', default=None, multiple=True, - help='removes project from user: \'project\'') + help="removes project from user: 'project'") @click.option('--add-project-role', 'add_project_role', default=None, multiple=True, - help='adds project,role(s) mapping: \'project,role1,role2,...\'') + help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'") @click.option('--remove-project-role', 'remove_project_role', default=None, multiple=True, - help='removes project,role(s) mapping: \'project,role1,role2,...\'') + help="remove role(s) in a project. Can be used several times: 'project,role1[,role2,...]'") @click.pass_context def user_update(ctx, username, password, set_username, set_project, remove_project, add_project_role, remove_project_role): @@ -3262,9 +3449,10 @@ def ns_metric_export(ctx, ns, vnf, vdu, metric, interval): # Other operations #################### -@cli_osm.command(name='version') +@cli_osm.command(name='version', short_help='shows client and server versions') @click.pass_context def get_version(ctx): + """shows client and server versions""" # try: check_client_version(ctx.obj, "version") print ("Server version: {}".format(ctx.obj.get_version())) @@ -3275,15 +3463,17 @@ def get_version(ctx): @cli_osm.command(name='upload-package', short_help='uploads a VNF package or NS package') @click.argument('filename') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='the charm will not be compiled, it is assumed to already exist') @click.pass_context -def upload_package(ctx, filename): - """uploads a VNF package or NS package +def upload_package(ctx, filename, skip_charm_build): + """uploads a vnf package or ns package - FILENAME: VNF or NS package file (tar.gz) + filename: vnf or ns package folder, or vnf or ns package file (tar.gz) """ logger.debug("") # try: - ctx.obj.package.upload(filename) + ctx.obj.package.upload(filename, skip_charm_build=skip_charm_build) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname != 'osmclient.sol005.client.Client': ctx.obj.package.wait_for_upload(filename) @@ -3451,6 +3641,7 @@ def upload_package(ctx, filename): @click.option('--action_name', prompt=True, help='action name') @click.option('--params', default=None, help='action params in YAML/JSON inline string') @click.option('--params_file', default=None, help='YAML/JSON file with action params') +@click.option('--timeout', required=False, default=None, type=int, help='timeout in seconds') @click.option('--wait', required=False, default=False, @@ -3466,6 +3657,7 @@ def ns_action(ctx, action_name, params, params_file, + timeout, wait): """executes an action/primitive over a NS instance @@ -3483,6 +3675,8 @@ def ns_action(ctx, op_data['vdu_id'] = vdu_id if vdu_count: op_data['vdu_count_index'] = vdu_count + if timeout: + op_data['timeout_ns_action'] = timeout op_data['primitive'] = action_name if params_file: with open(params_file, 'r') as pf: @@ -3504,13 +3698,18 @@ def ns_action(ctx, @click.option('--scaling-group', prompt=True, help="scaling-group-descriptor name to use") @click.option('--scale-in', default=False, is_flag=True, help="performs a scale in operation") @click.option('--scale-out', default=False, is_flag=True, help="performs a scale out operation (by default)") +@click.option('--timeout', required=False, default=None, type=int, help='timeout in seconds') +@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 vnf_scale(ctx, ns_name, vnf_name, scaling_group, scale_in, - scale_out): + scale_out, + timeout, + wait): """ Executes a VNF scale (adding/removing VDUs) @@ -3523,7 +3722,7 @@ def vnf_scale(ctx, check_client_version(ctx.obj, ctx.command.name) if not scale_in and not scale_out: scale_out = True - ctx.obj.ns.scale_vnf(ns_name, vnf_name, scaling_group, scale_in, scale_out) + ctx.obj.ns.scale_vnf(ns_name, vnf_name, scaling_group, scale_in, scale_out, wait, timeout) # except ClientException as e: # print(str(e)) # exit(1) @@ -3750,9 +3949,14 @@ def package_create(ctx, @click.argument('base-directory', default=".", required=False) +@click.option('--recursive/--no-recursive', + default=True, + help='The activated recursive option will validate the yaml files' + ' within the indicated directory and in its subdirectories') @click.pass_context def package_validate(ctx, - base_directory): + base_directory, + recursive): """ Validate descriptors given a base directory. @@ -3761,7 +3965,7 @@ def package_validate(ctx, """ # try: check_client_version(ctx.obj, ctx.command.name) - results = ctx.obj.package_tool.validate(base_directory) + results = ctx.obj.package_tool.validate(base_directory, recursive) table = PrettyTable() table.field_names = ["TYPE", "PATH", "VALID", "ERROR"] # Print the dictionary generated by the validation function @@ -3783,10 +3987,13 @@ def package_validate(ctx, default=False, is_flag=True, help='skip package validation') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='the charm will not be compiled, it is assumed to already exist') @click.pass_context def package_build(ctx, package_folder, - skip_validation): + skip_validation, + skip_charm_build): """ Build the package NS, VNF given the package_folder. @@ -3795,7 +4002,9 @@ def package_build(ctx, """ # try: check_client_version(ctx.obj, ctx.command.name) - results = ctx.obj.package_tool.build(package_folder, skip_validation) + results = ctx.obj.package_tool.build(package_folder, + skip_validation=skip_validation, + skip_charm_build=skip_charm_build) print(results) # except ClientException as inst: # print("ERROR: {}".format(inst))