X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osmclient%2Fscripts%2Fosm.py;h=0a1f7c3cd5ae70164ab7548a15e10790a5096f8e;hb=refs%2Fchanges%2F38%2F7038%2F1;hp=c2fe67ff44183c22bcb10fc37ef2a8e508c4903d;hpb=fcb33ebcc77ac7bb6ba0e0989c54bd6f8cefe766;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index c2fe67f..0a1f7c3 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -247,9 +247,25 @@ def nsd_list2(ctx, filter): nsd_list(ctx,filter) -def vnfd_list(ctx, filter): - if filter: +def vnfd_list(ctx, nf_type, filter): + if nf_type: + check_client_version(ctx.obj, '--nf_type') + elif filter: check_client_version(ctx.obj, '--filter') + if nf_type: + if nf_type == "vnf": + nf_filter = "_admin.type=vnfd" + elif nf_type == "pnf": + nf_filter = "_admin.type=pnfd" + elif nf_type == "hnf": + nf_filter = "_admin.type=hnfd" + else: + raise ClientException('wrong value for "--nf_type" option, allowed values: vnf, pnf, hnf') + if filter: + filter = '{}&{}'.format(nf_filter, filter) + else: + filter = nf_filter + if filter: resp = ctx.obj.vnfd.list(filter) else: resp = ctx.obj.vnfd.list() @@ -268,76 +284,41 @@ def vnfd_list(ctx, filter): @cli.command(name='vnfd-list') +@click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') @click.option('--filter', default=None, - help='restricts the list to the VNFD/VNFpkg matching the filter') + help='restricts the list to the NFpkg matching the filter') @click.pass_context -def vnfd_list1(ctx, filter): +def vnfd_list1(ctx, nf_type, filter): '''list all VNFD/VNFpkg in the system''' - vnfd_list(ctx,filter) + vnfd_list(ctx, nf_type, filter) @cli.command(name='vnfpkg-list') +@click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') @click.option('--filter', default=None, - help='restricts the list to the VNFD/VNFpkg matching the filter') + help='restricts the list to the NFpkg matching the filter') @click.pass_context -def vnfd_list2(ctx, filter): +def vnfd_list2(ctx, nf_type, filter): '''list all VNFD/VNFpkg in the system''' - vnfd_list(ctx,filter) + vnfd_list(ctx, nf_type, filter) -@cli.command(name='vnf-list') -@click.option('--ns', default=None, help='NS instance id or name to restrict the VNF list') +@cli.command(name='nfpkg-list') +@click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') @click.option('--filter', default=None, - help='restricts the list to the VNF instances matching the filter.') + help='restricts the list to the NFpkg matching the filter') @click.pass_context -def vnf_list(ctx, ns, filter): - '''list all VNF instances - - \b - Options: - --ns TEXT NS instance id or name to restrict the VNF list - --filter filterExpr Restricts the list to the VNF instances matching the filter - - \b - filterExpr consists of one or more strings formatted according to "simpleFilterExpr", - concatenated using the "&" character: - - \b - filterExpr := ["&"]* - simpleFilterExpr := ["."]*["."]"="[","]* - op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont" - attrName := string - value := scalar value - - \b - where: - * zero or more occurrences - ? zero or one occurrence - [] grouping of expressions to be used with ? and * - "" quotation marks for marking string constants - <> name separator +def nfpkg_list(ctx, nf_type, filter): + '''list all NFpkg (VNFpkg, PNFpkg, HNFpkg) in the system''' + try: + check_client_version(ctx.obj, ctx.command.name) + vnfd_list(ctx,nf_type,filter) + except ClientException as inst: + print((inst.message)) + exit(1) - \b - "AttrName" is the name of one attribute in the data type that defines the representation - of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of - entries to filter by attributes deeper in the hierarchy of a structured document. - "Op" stands for the comparison operator. If the expression has concatenated - entries, it means that the operator "op" is applied to the attribute addressed by the last - entry included in the concatenation. All simple filter expressions are combined - by the "AND" logical operator. In a concatenation of entries in a , - the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The - concatenation of all "attrName" entries except the leaf attribute is called the "attribute - prefix". If an attribute referenced in an expression is an array, an object that contains a - corresponding array shall be considered to match the expression if any of the elements in the - array matches all expressions that have the same attribute prefix. - \b - Filter examples: - --filter vim-account-id= - --filter vnfd-ref= - --filter vdur.ip-address= - --filter vnfd-ref=,vdur.ip-address= - ''' +def vnf_list(ctx, ns, filter): try: if ns or filter: if ns: @@ -388,6 +369,73 @@ def vnf_list(ctx, ns, filter): table.align = 'l' print(table) + +@cli.command(name='vnf-list') +@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.pass_context +def vnf_list1(ctx, ns, filter): + '''list all NF instances''' + vnf_list(ctx, ns, filter) + + +@cli.command(name='nf-list') +@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.pass_context +def nf_list(ctx, ns, filter): + '''list all NF instances + + \b + Options: + --ns TEXT NS instance id or name to restrict the VNF list + --filter filterExpr Restricts the list to the VNF instances matching the filter + + \b + filterExpr consists of one or more strings formatted according to "simpleFilterExpr", + concatenated using the "&" character: + + \b + filterExpr := ["&"]* + simpleFilterExpr := ["."]*["."]"="[","]* + op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont" + attrName := string + value := scalar value + + \b + where: + * zero or more occurrences + ? zero or one occurrence + [] grouping of expressions to be used with ? and * + "" quotation marks for marking string constants + <> name separator + + \b + "AttrName" is the name of one attribute in the data type that defines the representation + of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of + entries to filter by attributes deeper in the hierarchy of a structured document. + "Op" stands for the comparison operator. If the expression has concatenated + entries, it means that the operator "op" is applied to the attribute addressed by the last + entry included in the concatenation. All simple filter expressions are combined + by the "AND" logical operator. In a concatenation of entries in a , + the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The + concatenation of all "attrName" entries except the leaf attribute is called the "attribute + prefix". If an attribute referenced in an expression is an array, an object that contains a + corresponding array shall be considered to match the expression if any of the elements in the + array matches all expressions that have the same attribute prefix. + + \b + Filter examples: + --filter vim-account-id= + --filter vnfd-ref= + --filter vdur.ip-address= + --filter vnfd-ref=,vdur.ip-address= + ''' + vnf_list(ctx, ns, filter) + + @cli.command(name='ns-op-list') @click.argument('name') @click.pass_context @@ -532,6 +580,41 @@ def nsi_op_list2(ctx, name): nsi_op_list(ctx,name) +@cli.command(name='pdu-list') +@click.option('--filter', default=None, + help='restricts the list to the Physical Deployment Units matching the filter') +@click.pass_context +def pdu_list(ctx, filter): + '''list all Physical Deployment Units (PDU)''' + try: + check_client_version(ctx.obj, ctx.command.name) + resp = ctx.obj.pdu.list(filter) + except ClientException as inst: + print((inst.message)) + exit(1) + table = PrettyTable( + ['pdu name', + 'id', + 'type', + 'mgmt ip address']) + for pdu in resp: + pdu_name = pdu['name'] + pdu_id = pdu['_id'] + pdu_type = pdu['type'] + pdu_ipaddress = "None" + for iface in pdu['interfaces']: + if iface['mgmt']: + pdu_ipaddress = iface['ip-address'] + break + table.add_row( + [pdu_name, + pdu_id, + pdu_type, + pdu_ipaddress]) + table.align = 'l' + print(table) + + #################### # SHOW operations #################### @@ -626,6 +709,19 @@ def vnfd_show2(ctx, name, literal): vnfd_show(ctx, name, literal) +@cli.command(name='nfpkg-show', short_help='shows the content of a NF Descriptor') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.argument('name') +@click.pass_context +def nfpkg_show(ctx, name, literal): + '''shows the content of a NF Descriptor + + NAME: name or ID of the NFpkg + ''' + vnfd_show(ctx, name, literal) + + @cli.command(name='ns-show', short_help='shows the info of a NS instance') @click.argument('name') @click.option('--literal', is_flag=True, @@ -900,6 +996,38 @@ def nsi_op_show2(ctx, id, filter): nsi_op_show(ctx, id, filter) +@cli.command(name='pdu-show', short_help='shows the content of a Physical Deployment Unit (PDU)') +@click.argument('name') +@click.option('--literal', is_flag=True, + help='print literally, no pretty table') +@click.option('--filter', default=None) +@click.pass_context +def pdu_show(ctx, name, literal, filter): + '''shows the content of a Physical Deployment Unit (PDU) + + NAME: name or ID of the PDU + ''' + try: + check_client_version(ctx.obj, ctx.command.name) + pdu = ctx.obj.pdu.get(name) + except ClientException as inst: + print((inst.message)) + exit(1) + + if literal: + print(yaml.safe_dump(pdu)) + return + + table = PrettyTable(['field', 'value']) + + for k, v in list(pdu.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 #################### @@ -974,6 +1102,19 @@ def vnfd_create2(ctx, filename, overwrite): vnfd_create(ctx, filename, overwrite) +@cli.command(name='nfpkg-create', short_help='creates a new NFpkg') +@click.argument('filename') +@click.option('--overwrite', default=None, + help='overwrites some fields in NFD') +@click.pass_context +def nfpkg_create(ctx, filename, overwrite): + '''creates a new NFpkg + + FILENAME: NF Descriptor yaml file or NFpkg tar.gz file + ''' + vnfd_create(ctx, filename, overwrite) + + @cli.command(name='ns-create', short_help='creates a new Network Service instance') @click.option('--ns_name', prompt=True, help='name of the NS instance') @@ -1120,6 +1261,51 @@ def nsi_create2(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_f nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file) +@cli.command(name='pdu-create', short_help='adds a new Physical Deployment Unit to the catalog') +@click.option('--name', help='name of 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', 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_create(ctx, name, pdu_type, interface, description, vim_account, descriptor_file): + '''creates a new Physical Deployment Unit (PDU)''' + try: + check_client_version(ctx.obj, ctx.command.name) + 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)') + else: + with open(descriptor_file, 'r') as df: + pdu = yaml.load(df.read()) + if name: pdu["name"] = name + if pdu_type: pdu["type"] = pdu_type + if description: pdu["description"] = description + if vim_account: pdu["vim_accounts"] = vim_account + if interface: + ifaces_list = [] + for iface in interface: + new_iface={k:v for k,v in [i.split('=') for i in iface.split(',')]} + 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 inst: + print((inst.message)) + exit(1) + + #################### # UPDATE operations #################### @@ -1194,6 +1380,19 @@ def vnfd_update2(ctx, name, content): vnfd_update(ctx, name, content) +@cli.command(name='nfpkg-update', short_help='updates a NFpkg') +@click.argument('name') +@click.option('--content', default=None, + help='filename with the NFpkg replacing the current one') +@click.pass_context +def nfpkg_update(ctx, name, content): + '''updates a NFpkg + + NAME: NF Descriptor yaml file or NFpkg tar.gz file + ''' + vnfd_update(ctx, name, content) + + def nst_update(ctx, name, content): try: check_client_version(ctx.obj, ctx.command.name) @@ -1305,6 +1504,18 @@ def vnfd_delete2(ctx, name, force): vnfd_delete(ctx, name, force) +@cli.command(name='nfpkg-delete', short_help='deletes a NFpkg') +@click.argument('name') +@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') +@click.pass_context +def nfpkg_delete(ctx, name, force): + '''deletes a NFpkg + + NAME: name or ID of the NFpkg to be deleted + ''' + vnfd_delete(ctx, name, force) + + @cli.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') @@ -1391,6 +1602,23 @@ def nsi_delete2(ctx, name, force): nsi_delete(ctx, name, force) +@cli.command(name='pdu-delete', short_help='deletes a Physical Deployment Unit (PDU)') +@click.argument('name') +@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions') +@click.pass_context +def pdu_delete(ctx, name, force): + '''deletes a Physical Deployment Unit (PDU) + + NAME: name or ID of the PDU to be deleted + ''' + try: + check_client_version(ctx.obj, ctx.command.name) + ctx.obj.pdu.delete(name, force) + except ClientException as inst: + print((inst.message)) + exit(1) + + #################### # VIM operations ####################