X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=c73be1f1d4dce2c74bf8bf93c6ed2024861c5554;hb=1ad0860dfe31be33ea8b82e0f3e4bb327d0390d3;hp=12f0576ca771e6125088be5ef461ae6569bb31bf;hpb=961145b6c1ab65c8cc5953aae008781e285c1461;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index 12f0576..c73be1f 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -2564,13 +2564,15 @@ def nsi_create2( @click.option("--description", help="human readable description") @click.option( "--vim_account", - help="list of VIM accounts (in the same VIM) that can reach this PDU", + help="list of VIM accounts (in the same VIM) that can reach this PDU\n" + + "The format for multiple VIMs is --vim_account " + + "--vim_account ... --vim_account ", multiple=True, ) @click.option( "--descriptor_file", default=None, - help="PDU descriptor file (as an alternative to using the other arguments", + help="PDU descriptor file (as an alternative to using the other arguments)", ) @click.pass_context def pdu_create( @@ -2578,26 +2580,84 @@ def pdu_create( ): """creates a new Physical Deployment Unit (PDU)""" logger.debug("") - # try: + check_client_version(ctx.obj, ctx.command.name) + + pdu = create_pdu_dictionary(name, pdu_type, interface, description, vim_account, descriptor_file) + ctx.obj.pdu.create(pdu) + + +######################## +# UPDATE PDU operation # +######################## + + +@cli_osm.command( + name="pdu-update", short_help="updates a Physical Deployment Unit to the catalog" +) +@click.argument("name") +@click.option("--newname", help="New name for the Physical Deployment Unit") +@click.option("--pdu_type", help="type of PDU (e.g. router, firewall, FW001)") +@click.option( + "--interface", + help="interface(s) of the PDU: name=,mgmt=,ip-address=" + + "[,type=][,mac-address=][,vim-network-name=]", + multiple=True, +) +@click.option("--description", help="human readable description") +@click.option( + "--vim_account", + help="list of VIM accounts (in the same VIM) that can reach this PDU\n" + + "The format for multiple VIMs is --vim_account " + + "--vim_account ... --vim_account ", + multiple=True, +) +@click.option( + "--descriptor_file", + default=None, + help="PDU descriptor file (as an alternative to using the other arguments)", +) +@click.pass_context +def pdu_update( + ctx, name, newname, pdu_type, interface, description, vim_account, descriptor_file +): + """Updates a new Physical Deployment Unit (PDU)""" + logger.debug("") + + check_client_version(ctx.obj, ctx.command.name) + + update = True + + if not newname: + newname = name + + pdu = create_pdu_dictionary(newname, pdu_type, interface, description, vim_account, descriptor_file, update) + ctx.obj.pdu.update(name, pdu) + + +def create_pdu_dictionary(name, pdu_type, interface, description, vim_account, descriptor_file, update=False): + + logger.debug("") pdu = {} + if not descriptor_file: - if not name: - raise ClientException( - 'in absence of descriptor file, option "--name" is mandatory' - ) - if not pdu_type: - raise ClientException( - 'in absence of descriptor file, option "--pdu_type" is mandatory' - ) - if not interface: - raise ClientException( - 'in absence of descriptor file, option "--interface" is mandatory (at least once)' - ) - if not vim_account: - raise ClientException( - 'in absence of descriptor file, option "--vim_account" is mandatory (at least once)' - ) + if not update: + if not name: + raise ClientException( + 'in absence of descriptor file, option "--name" is mandatory' + ) + if not pdu_type: + raise ClientException( + 'in absence of descriptor file, option "--pdu_type" is mandatory' + ) + if not interface: + raise ClientException( + 'in absence of descriptor file, option "--interface" is mandatory (at least once)' + ) + if not vim_account: + raise ClientException( + 'in absence of descriptor file, option "--vim_account" is mandatory (at least once)' + ) else: with open(descriptor_file, "r") as df: pdu = yaml.safe_load(df.read()) @@ -2616,11 +2676,7 @@ def pdu_create( new_iface["mgmt"] = new_iface.get("mgmt", "false").lower() == "true" ifaces_list.append(new_iface) pdu["interfaces"] = ifaces_list - ctx.obj.pdu.create(pdu) - # except ClientException as e: - # print(str(e)) - # exit(1) - + return pdu #################### # UPDATE operations @@ -3516,7 +3572,7 @@ def wim_show(ctx, name): check_client_version(ctx.obj, ctx.command.name) resp = ctx.obj.wim.get(name) if "password" in resp: - resp["wim_password"] = "********" + resp["password"] = "********" # except ClientException as e: # print(str(e)) # exit(1) @@ -3770,6 +3826,14 @@ def sdnc_show(ctx, name): default="kube-system", help="namespace to be used for its operation, defaults to `kube-system`", ) +@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.option( "--cni", default=None, @@ -3783,7 +3847,7 @@ def sdnc_show(ctx, name): # help='do not return the control immediately, but keep it until the operation is completed, or timeout') @click.pass_context def k8scluster_add( - ctx, name, creds, version, vim, k8s_nets, description, namespace, cni + ctx, name, creds, version, vim, k8s_nets, description, namespace, wait, cni ): """adds a K8s cluster to OSM @@ -3804,7 +3868,7 @@ def k8scluster_add( cluster["namespace"] = namespace if cni: cluster["cni"] = yaml.safe_load(cni) - ctx.obj.k8scluster.create(name, cluster) + ctx.obj.k8scluster.create(name, cluster, wait) # except ClientException as e: # print(str(e)) # exit(1) @@ -3826,12 +3890,20 @@ def k8scluster_add( "--namespace", help="namespace to be used for its operation, defaults to `kube-system`", ) +@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.option( "--cni", help="list of CNI plugins, in JSON inline format, used in the cluster" ) @click.pass_context def k8scluster_update( - ctx, name, newname, creds, version, vim, k8s_nets, description, namespace, cni + ctx, name, newname, creds, version, vim, k8s_nets, description, namespace, wait, cni ): """updates a K8s cluster @@ -3857,7 +3929,7 @@ def k8scluster_update( cluster["namespace"] = namespace if cni: cluster["cni"] = yaml.safe_load(cni) - ctx.obj.k8scluster.update(name, cluster) + ctx.obj.k8scluster.update(name, cluster, wait) # except ClientException as e: # print(str(e)) # exit(1) @@ -3868,18 +3940,23 @@ def k8scluster_update( @click.option( "--force", is_flag=True, help="forces the deletion from the DB (not recommended)" ) -# @click.option('--wait', -# is_flag=True, -# help='do not return the control immediately, but keep it until the operation is completed, or timeout') +@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 k8scluster_delete(ctx, name, force): +def k8scluster_delete(ctx, name, force, wait): """deletes a K8s cluster NAME: name or ID of the K8s cluster to be deleted """ # try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.k8scluster.delete(name, force=force) + ctx.obj.k8scluster.delete(name, force, wait) # except ClientException as e: # print(str(e)) # exit(1) @@ -4966,6 +5043,128 @@ def ns_metric_export(ctx, ns, vnf, vdu, metric, interval): # exit(1) +################# +# Subscription operations +################# + + +@cli_osm.command( + name="subscription-create", + short_help="creates a new subscription to a specific event", +) +@click.option( + "--event_type", + # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False)) + type=click.Choice(["ns"], case_sensitive=False), + help="event type to be subscribed (for the moment, only ns is supported)", +) +@click.option("--event", default=None, help="specific yaml configuration for the event") +@click.option( + "--event_file", default=None, help="specific yaml configuration file for the event" +) +@click.pass_context +def subscription_create(ctx, event_type, event, event_file): + """creates a new subscription to a specific event""" + logger.debug("") + check_client_version(ctx.obj, ctx.command.name) + if event_file: + if event: + raise ClientException( + '"--event" option is incompatible with "--event_file" option' + ) + with open(event_file, "r") as cf: + event = cf.read() + ctx.obj.subscription.create(event_type, event) + + +@cli_osm.command(name="subscription-delete", short_help="deletes a subscription") +@click.option( + "--event_type", + # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False)) + type=click.Choice(["ns"], case_sensitive=False), + help="event type to be subscribed (for the moment, only ns is supported)", +) +@click.argument("subscription_id") +@click.option( + "--force", is_flag=True, help="forces the deletion bypassing pre-conditions" +) +@click.pass_context +def subscription_delete(ctx, event_type, subscription_id, force): + """deletes a subscription + + SUBSCRIPTION_ID: ID of the subscription to be deleted + """ + logger.debug("") + check_client_version(ctx.obj, ctx.command.name) + ctx.obj.subscription.delete(event_type, subscription_id, force) + + +@cli_osm.command(name="subscription-list", short_help="list all subscriptions") +@click.option( + "--event_type", + # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False)) + type=click.Choice(["ns"], case_sensitive=False), + help="event type to be subscribed (for the moment, only ns is supported)", +) +@click.option( + "--filter", + default=None, + multiple=True, + help="restricts the list to the subscriptions matching the filter", +) +@click.pass_context +def subscription_list(ctx, event_type, filter): + """list all subscriptions""" + logger.debug("") + check_client_version(ctx.obj, ctx.command.name) + if filter: + filter = "&".join(filter) + resp = ctx.obj.subscription.list(event_type, filter) + table = PrettyTable(["id", "filter", "CallbackUri"]) + for sub in resp: + table.add_row( + [ + sub["_id"], + wrap_text(text=json.dumps(sub["filter"], indent=2), width=70), + sub["CallbackUri"], + ] + ) + table.align = "l" + print(table) + + +@cli_osm.command( + name="subscription-show", short_help="shows the details of a subscription" +) +@click.argument("subscription_id") +@click.option( + "--event_type", + # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False)) + type=click.Choice(["ns"], case_sensitive=False), + help="event type to be subscribed (for the moment, only ns is supported)", +) +@click.option( + "--filter", + multiple=True, + help="restricts the information to the fields in the filter", +) +@click.pass_context +def subscription_show(ctx, event_type, subscription_id, filter): + """shows the details of a subscription + + SUBSCRIPTION_ID: ID of the subscription + """ + logger.debug("") + # try: + resp = ctx.obj.subscription.get(subscription_id) + table = PrettyTable(["key", "attribute"]) + for k, v in list(resp.items()): + if not filter or k in filter: + table.add_row([k, wrap_text(text=json.dumps(v, indent=2), width=100)]) + table.align = "l" + print(table) + + #################### # Other operations #################### @@ -5288,6 +5487,107 @@ def vnf_scale( # exit(1) +@cli_osm.command(name="alarm-show", short_help="show alarm details") +@click.argument("uuid") +@click.pass_context +def alarm_show(ctx, uuid): + """Show alarm's detail information""" + + check_client_version(ctx.obj, ctx.command.name) + resp = ctx.obj.ns.get_alarm(uuid=uuid) + alarm_filter = [ + "uuid", + "name", + "metric", + "statistic", + "threshold", + "operation", + "ns-id", + "vnf-id", + "vdu_name", + "action", + "status", + ] + table = PrettyTable(["key", "attribute"]) + try: + # Arrange and return the response data + resp = resp.replace("ObjectId", "") + alarm = eval(resp) + for key in alarm_filter: + if key == "uuid": + value = alarm.get(key) + key = "alarm-id" + elif key == "name": + value = alarm.get(key) + key = "alarm-name" + elif key == "ns-id": + value = alarm["tags"].get("ns_id") + elif key == "vdu_name": + value = alarm["tags"].get("vdu_name") + elif key == "status": + value = alarm["alarm_status"] + else: + value = alarm[key] + table.add_row([key, wrap_text(text=json.dumps(value, indent=2), width=100)]) + table.align = "l" + print(table) + except Exception: + print(resp) + + +# List alarm +@cli_osm.command(name="alarm-list", short_help="list all alarms") +@click.option( + "--ns_id", default=None, required=False, help="List out alarm for given ns id" +) +@click.pass_context +def alarm_list(ctx, ns_id): + """list all alarm""" + + check_client_version(ctx.obj, ctx.command.name) + project_name = os.getenv("OSM_PROJECT", "admin") + resp = ctx.obj.ns.get_alarm(project_name=project_name, ns_id=ns_id) + + table = PrettyTable( + ["alarm-id", "metric", "threshold", "operation", "action", "status"] + ) + if resp: + # return the response data in a table + resp = resp.replace("ObjectId", "") + resp = eval(resp) + for alarm in resp: + table.add_row( + [ + wrap_text(text=str(alarm["uuid"]), width=38), + alarm["metric"], + alarm["threshold"], + alarm["operation"], + wrap_text(text=alarm["action"], width=25), + alarm["alarm_status"], + ] + ) + table.align = "l" + print(table) + + +# Update alarm +@cli_osm.command(name="alarm-update", short_help="Update a alarm") +@click.argument("uuid") +@click.option("--threshold", default=None, help="Alarm threshold") +@click.option("--is_enable", default=None, type=bool, help="enable or disable alarm") +@click.pass_context +def alarm_update(ctx, uuid, threshold, is_enable): + """ + Update alarm + + """ + if not threshold and is_enable is None: + raise ClientException( + "Please provide option to update i.e threshold or is_enable" + ) + ctx.obj.ns.update_alarm(uuid, threshold, is_enable) + + ############################## # Role Management Operations # ############################## @@ -5472,6 +5772,9 @@ def role_show(ctx, name): @click.option( "--netslice-vlds", default=1, help="(NST) Number of netslice vlds. Default 1" ) +@click.option( + "--old", default=False, is_flag=True, help="Support flag for old versions of the OSM IM (OSM<9)" +) @click.pass_context def package_create( ctx, @@ -5489,6 +5792,7 @@ def package_create( detailed, netslice_subnets, netslice_vlds, + old, ): """ Creates an OSM NS, VNF, NST package @@ -5521,6 +5825,7 @@ def package_create( detailed=detailed, netslice_subnets=netslice_subnets, netslice_vlds=netslice_vlds, + old=old, ) print(resp) # except ClientException as inst: