X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=6e0dc9ede7aac9f45512a2e0e008a30d59b71cfa;hb=refs%2Fchanges%2F38%2F8738%2F9;hp=d922ce50e0a9217dc370c47a6bed99237813b33a;hpb=26795d187e2555865ac0daf9fe8834e5d21db31a;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index d922ce5..6e0dc9e 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') @@ -337,8 +359,8 @@ def ns_list(ctx, filter, long): vim = vim_name current_operation = "{} ({})".format(nsr['currentOperation'],nsr['currentOperationID']) 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['errorDescription']: + error_details = "{}\nDetail: {}".format(nsr['errorDescription'], nsr['errorDetail']) else: nsopdata = ctx.obj.ns.get_opdata(ns['id']) nsr = nsopdata['nsr:nsr'] @@ -526,7 +548,7 @@ def nfpkg_list(ctx, nf_type, filter, long): # exit(1) -def vnf_list(ctx, ns, filter): +def vnf_list(ctx, ns, filter, long): # try: if ns or filter: if ns: @@ -541,24 +563,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', @@ -582,19 +603,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 @@ -688,13 +711,13 @@ def ns_op_list(ctx, name, long): 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'] + 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: @@ -708,7 +731,7 @@ def ns_op_list(ctx, name, long): wrap_text(text=detail,width=50)]) else: table.add_row([op['id'], op['lcmOperationType'], action_name, - op['operationState'], date, wrap_text(text=detail,width=50)]) + op['operationState'], date, wrap_text(text=detail or "",width=50)]) table.align = 'l' print(table) @@ -1052,7 +1075,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"])) @@ -1063,8 +1086,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: @@ -1413,13 +1437,13 @@ def nsd_create1(ctx, filename, overwrite, skip_charm_build): @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, charm_folder, overwrite, skip_charm_build): +def nsd_create2(ctx, filename, overwrite, skip_charm_build): """creates a new NSD/NSpkg FILENAME: NSD folder, NSD yaml file or NSpkg tar.gz file """ logger.debug("") - nsd_create(ctx, charm_folder, overwrite=overwrite, skip_charm_build=skip_charm_build) + nsd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build) def vnfd_create(ctx, filename, overwrite, skip_charm_build): @@ -1947,6 +1971,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, @@ -1954,7 +1981,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 @@ -1962,10 +1989,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) @@ -2153,7 +2180,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, @@ -2481,9 +2509,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', @@ -2503,16 +2532,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) @@ -2528,7 +2557,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 @@ -2549,13 +2579,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}'" @@ -2968,15 +2998,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) @@ -3091,9 +3127,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 @@ -3101,6 +3140,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 = {} @@ -3108,7 +3148,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) @@ -3129,16 +3171,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): @@ -3591,13 +3633,16 @@ 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('--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, + wait): """ Executes a VNF scale (adding/removing VDUs) @@ -3610,7 +3655,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) # except ClientException as e: # print(str(e)) # exit(1)