1 # Copyright 2017-2018 Sandvine
2 # Copyright 2018 Telefonica
6 # Licensed under the Apache License, Version 2.0 (the "License"); you may
7 # not use this file except in compliance with the License. You may obtain
8 # a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 # License for the specific language governing permissions and limitations
22 from osmclient
import client
23 from osmclient
.common
.exceptions
import ClientException
, NotFound
24 from prettytable
import PrettyTable
33 from datetime
import datetime
34 from typing
import Any
, Dict
37 def wrap_text(text
, width
):
38 wrapper
= textwrap
.TextWrapper(width
=width
)
39 lines
= text
.splitlines()
40 return "\n".join(map(wrapper
.fill
, lines
))
43 def trunc_text(text
, length
):
44 if len(text
) > length
:
45 return text
[: (length
- 3)] + "..."
50 def check_client_version(obj
, what
, version
="sol005"):
52 Checks the version of the client object and raises error if it not the expected.
54 :param obj: the client object
55 :what: the function or command under evaluation (used when an error is raised)
57 :raises ClientError: if the specified version does not match the client version
60 fullclassname
= obj
.__module
__ + "." + obj
.__class
__.__name
__
61 message
= 'The following commands or options are only supported with the option "--sol005": {}'.format(
65 message
= 'The following commands or options are not supported when using option "--sol005": {}'.format(
68 if fullclassname
!= "osmclient.{}.client.Client".format(version
):
69 raise ClientException(message
)
73 def get_project(project_list
, item
):
74 # project_list = ctx.obj.project.list()
75 item_project_list
= item
.get("_admin", {}).get("projects_read")
79 for p1
in item_project_list
:
81 for p2
in project_list
:
82 if p2
["_id"] == project_id
:
83 project_name
= p2
["name"]
84 return project_id
, project_name
85 return project_id
, project_name
88 def get_vim_name(vim_list
, vim_id
):
91 if v
["uuid"] == vim_id
:
97 def create_config(config_file
, json_string
):
99 Combines a YAML or JSON file with a JSON string into a Python3 structure
100 It loads the YAML or JSON file 'cfile' into a first dictionary.
101 It loads the JSON string into a second dictionary.
102 Then it updates the first dictionary with the info in the second dictionary.
103 If the field is present in both cfile and cdict, the field in cdict prevails.
104 If both cfile and cdict are None, it returns an empty dict (i.e. {})
108 with
open(config_file
, "r") as cf
:
109 config
= yaml
.safe_load(cf
.read())
111 cdict
= yaml
.safe_load(json_string
)
112 for k
, v
in cdict
.items():
118 context_settings
=dict(help_option_names
=["-h", "--help"], max_content_width
=160)
123 envvar
="OSM_HOSTNAME",
124 help="hostname of server. " + "Also can set OSM_HOSTNAME in environment",
126 # @click.option('--sol005/--no-sol005',
128 # envvar='OSM_SOL005',
129 # help='Use ETSI NFV SOL005 API (default) or the previous SO API. ' +
130 # 'Also can set OSM_SOL005 in environment')
135 help="user (defaults to admin). " + "Also can set OSM_USER in environment",
140 envvar
="OSM_PASSWORD",
141 help="password (defaults to admin). " + "Also can set OSM_PASSWORD in environment",
146 envvar
="OSM_PROJECT",
147 help="project (defaults to admin). " + "Also can set OSM_PROJECT in environment",
153 help="increase verbosity (-v INFO, -vv VERBOSE, -vvv DEBUG)",
155 @click.option("--all-projects", default
=None, is_flag
=True, help="include all projects")
157 "--public/--no-public",
159 help="flag for public items (packages, instances, VIM accounts, etc.)",
162 "--project-domain-name",
163 "project_domain_name",
165 envvar
="OSM_PROJECT_DOMAIN_NAME",
166 help="project domain name for keystone authentication (default to None). "
167 + "Also can set OSM_PROJECT_DOMAIN_NAME in environment",
170 "--user-domain-name",
173 envvar
="OSM_USER_DOMAIN_NAME",
174 help="user domain name for keystone authentication (default to None). "
175 + "Also can set OSM_USER_DOMAIN_NAME in environment",
177 # @click.option('--so-port',
179 # envvar='OSM_SO_PORT',
180 # help='hostname of server. ' +
181 # 'Also can set OSM_SO_PORT in environment')
182 # @click.option('--so-project',
184 # envvar='OSM_SO_PROJECT',
185 # help='Project Name in SO. ' +
186 # 'Also can set OSM_SO_PROJECT in environment')
187 # @click.option('--ro-hostname',
189 # envvar='OSM_RO_HOSTNAME',
190 # help='hostname of RO server. ' +
191 # 'Also can set OSM_RO_HOSTNAME in environment')
192 # @click.option('--ro-port',
194 # envvar='OSM_RO_PORT',
195 # help='hostname of RO server. ' +
196 # 'Also can set OSM_RO_PORT in environment')
198 def cli_osm(ctx
, **kwargs
):
200 hostname
= kwargs
.pop("hostname", None)
204 "either hostname option or OSM_HOSTNAME "
205 + "environment variable needs to be specified"
210 kwargs
= {k
: v
for k
, v
in kwargs
.items() if v
is not None}
211 # if so_port is not None:
212 # kwargs['so_port']=so_port
213 # if so_project is not None:
214 # kwargs['so_project']=so_project
215 # if ro_hostname is not None:
216 # kwargs['ro_host']=ro_hostname
217 # if ro_port is not None:
218 # kwargs['ro_port']=ro_port
219 sol005
= os
.getenv("OSM_SOL005", True)
220 # if user is not None:
221 # kwargs['user']=user
222 # if password is not None:
223 # kwargs['password']=password
224 # if project is not None:
225 # kwargs['project']=project
227 # kwargs['all_projects']=all_projects
228 # if public is not None:
229 # kwargs['public']=public
230 ctx
.obj
= client
.Client(host
=hostname
, sol005
=sol005
, **kwargs
)
231 logger
= logging
.getLogger("osmclient")
239 @cli_osm.command(name
="ns-list", short_help
="list all NS instances")
244 help="restricts the list to the NS instances matching the filter.",
249 help="get more details of the NS (project, vim, deployment status, configuration status.",
252 def ns_list(ctx
, filter, long):
253 """list all NS instances
257 --filter filterExpr Restricts the list to the NS instances matching the filter
260 filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
261 concatenated using the "&" character:
264 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
265 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
266 op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
268 value := scalar value
272 * zero or more occurrences
273 ? zero or one occurrence
274 [] grouping of expressions to be used with ? and *
275 "" quotation marks for marking string constants
279 "AttrName" is the name of one attribute in the data type that defines the representation
280 of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
281 <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
282 "Op" stands for the comparison operator. If the expression has concatenated <attrName>
283 entries, it means that the operator "op" is applied to the attribute addressed by the last
284 <attrName> entry included in the concatenation. All simple filter expressions are combined
285 by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
286 the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
287 concatenation of all "attrName" entries except the leaf attribute is called the "attribute
288 prefix". If an attribute referenced in an expression is an array, an object that contains a
289 corresponding array shall be considered to match the expression if any of the elements in the
290 array matches all expressions that have the same attribute prefix.
294 --filter admin-status=ENABLED
295 --filter nsd-ref=<NSD_NAME>
296 --filter nsd.vendor=<VENDOR>
297 --filter nsd.vendor=<VENDOR>&nsd-ref=<NSD_NAME>
298 --filter nsd.constituent-vnfd.vnfd-id-ref=<VNFD_NAME>
301 def summarize_deployment_status(status_dict
):
308 net_list
= status_dict
.get("nets", [])
311 if net
["status"] not in status_nets
:
312 status_nets
[net
["status"]] = 1
314 status_nets
[net
["status"]] += 1
316 for k
, v
in status_nets
.items():
317 message
+= "{}:{},".format(k
, v
)
318 message
+= "TOTAL:{}".format(n_nets
)
319 summary
+= "{}".format(message
)
324 vnf_list
= status_dict
["vnfs"]
326 member_vnf_index
= vnf
["member_vnf_index"]
327 if member_vnf_index
not in status_vnfs
:
328 status_vnfs
[member_vnf_index
] = {}
329 for vm
in vnf
["vms"]:
331 if vm
["status"] not in status_vms
:
332 status_vms
[vm
["status"]] = 1
334 status_vms
[vm
["status"]] += 1
335 if vm
["status"] not in status_vnfs
[member_vnf_index
]:
336 status_vnfs
[member_vnf_index
][vm
["status"]] = 1
338 status_vnfs
[member_vnf_index
][vm
["status"]] += 1
340 for k
, v
in status_vms
.items():
341 message
+= "{}:{},".format(k
, v
)
342 message
+= "TOTAL:{}".format(n_vms
)
343 summary
+= "\n{}".format(message
)
345 for k
, v
in status_vnfs
.items():
347 message
= "\n {} VMs: ".format(k
)
348 for k2
, v2
in v
.items():
349 message
+= "{}:{},".format(k2
, v2
)
351 message
+= "TOTAL:{}".format(total
)
355 def summarize_config_status(ee_list
):
363 if ee
["elementType"] not in status_ee
:
364 status_ee
[ee
["elementType"]] = {}
365 status_ee
[ee
["elementType"]][ee
["status"]] = 1
367 if ee
["status"] in status_ee
[ee
["elementType"]]:
368 status_ee
[ee
["elementType"]][ee
["status"]] += 1
370 status_ee
[ee
["elementType"]][ee
["status"]] = 1
371 for elementType
in ["KDU", "VDU", "PDU", "VNF", "NS"]:
372 if elementType
in status_ee
:
375 for k
, v
in status_ee
[elementType
].items():
376 message
+= "{}:{},".format(k
, v
)
378 message
+= "TOTAL:{}\n".format(total
)
379 summary
+= "{}: {}".format(elementType
, message
)
380 summary
+= "TOTAL Exec. Env.: {}".format(n_ee
)
385 check_client_version(ctx
.obj
, "--filter")
386 filter = "&".join(filter)
387 resp
= ctx
.obj
.ns
.list(filter)
389 resp
= ctx
.obj
.ns
.list()
402 "configuration status",
405 project_list
= ctx
.obj
.project
.list()
407 vim_list
= ctx
.obj
.vim
.list()
422 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
423 if fullclassname
== "osmclient.sol005.client.Client":
425 logger
.debug("NS info: {}".format(nsr
))
426 nsr_name
= nsr
["name"]
428 date
= datetime
.fromtimestamp(nsr
["create-time"]).strftime(
431 ns_state
= nsr
.get("nsState", nsr
["_admin"]["nsState"])
433 deployment_status
= summarize_deployment_status(
434 nsr
.get("deploymentStatus")
436 config_status
= summarize_config_status(nsr
.get("configurationStatus"))
437 project_id
, project_name
= get_project(project_list
, nsr
)
438 # project = '{} ({})'.format(project_name, project_id)
439 project
= project_name
440 vim_id
= nsr
.get("datacenter")
441 vim_name
= get_vim_name(vim_list
, vim_id
)
443 # vim = '{} ({})'.format(vim_name, vim_id)
445 if "currentOperation" in nsr
:
446 current_operation
= "{} ({})".format(
447 nsr
["currentOperation"], nsr
["currentOperationID"]
450 current_operation
= "{} ({})".format(
451 nsr
["_admin"].get("current-operation", "-"),
452 nsr
["_admin"]["nslcmop"],
454 error_details
= "N/A"
457 or ns_state
== "DEGRADED"
458 or ("currentOperation" not in nsr
and nsr
.get("errorDescription"))
460 error_details
= "{}\nDetail: {}".format(
461 nsr
["errorDescription"], nsr
["errorDetail"]
464 nsopdata
= ctx
.obj
.ns
.get_opdata(ns
["id"])
465 nsr
= nsopdata
["nsr:nsr"]
466 nsr_name
= nsr
["name-ref"]
467 nsr_id
= nsr
["ns-instance-config-ref"]
470 deployment_status
= (
471 nsr
["operational-status"]
472 if "operational-status" in nsr
475 ns_state
= deployment_status
476 config_status
= nsr
.get("config-status", "Not found")
477 current_operation
= "Unknown"
478 error_details
= nsr
.get("detailed-status", "Not found")
479 if config_status
== "config_not_needed":
480 config_status
= "configured (no charms)"
490 wrap_text(text
=error_details
, width
=40),
505 wrap_text(text
=error_details
, width
=40),
510 print('To get the history of all operations over a NS, run "osm ns-op-list NS_ID"')
512 'For more details on the current operation, run "osm ns-op-show OPERATION_ID"'
516 def nsd_list(ctx
, filter, long):
519 check_client_version(ctx
.obj
, "--filter")
520 filter = "&".join(filter)
521 resp
= ctx
.obj
.nsd
.list(filter)
523 resp
= ctx
.obj
.nsd
.list()
524 # print(yaml.safe_dump(resp))
525 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
526 if fullclassname
== "osmclient.sol005.client.Client":
540 table
= PrettyTable(["nsd name", "id"])
542 name
= nsd
.get("id", "-")
544 onb_state
= nsd
["_admin"].get("onboardingState", "-")
545 op_state
= nsd
["_admin"].get("operationalState", "-")
546 usage_state
= nsd
["_admin"].get("usageState", "-")
547 date
= datetime
.fromtimestamp(nsd
["_admin"]["created"]).strftime(
550 last_update
= datetime
.fromtimestamp(
551 nsd
["_admin"]["modified"]
552 ).strftime("%Y-%m-%dT%H:%M:%S")
565 table
.add_row([name
, nsd
["_id"]])
567 table
= PrettyTable(["nsd name", "id"])
569 table
.add_row([nsd
["name"], nsd
["id"]])
574 @cli_osm.command(name
="nsd-list", short_help
="list all NS packages")
579 help="restricts the list to the NSD/NSpkg matching the filter",
581 @click.option("--long", is_flag
=True, help="get more details")
583 def nsd_list1(ctx
, filter, long):
584 """list all NSD/NS pkg in the system"""
586 nsd_list(ctx
, filter, long)
589 @cli_osm.command(name
="nspkg-list", short_help
="list all NS packages")
594 help="restricts the list to the NSD/NSpkg matching the filter",
596 @click.option("--long", is_flag
=True, help="get more details")
598 def nsd_list2(ctx
, filter, long):
599 """list all NS packages"""
601 nsd_list(ctx
, filter, long)
604 def pkg_repo_list(ctx
, pkgtype
, filter, repo
, long):
605 resp
= ctx
.obj
.osmrepo
.pkg_list(pkgtype
, filter, repo
)
608 ["nfpkg name", "vendor", "version", "latest", "description", "repository"]
611 table
= PrettyTable(["nfpkg name", "repository"])
613 name
= vnfd
.get("id", vnfd
.get("name", "-"))
614 repository
= vnfd
.get("repository")
616 vendor
= vnfd
.get("provider", vnfd
.get("vendor"))
617 version
= vnfd
.get("version")
618 description
= vnfd
.get("description")
619 latest
= vnfd
.get("latest")
620 table
.add_row([name
, vendor
, version
, latest
, description
, repository
])
622 table
.add_row([name
, repository
])
627 def vnfd_list(ctx
, nf_type
, filter, long):
630 check_client_version(ctx
.obj
, "--nf_type")
632 check_client_version(ctx
.obj
, "--filter")
634 filter = "&".join(filter)
637 nf_filter
= "_admin.type=vnfd"
638 elif nf_type
== "pnf":
639 nf_filter
= "_admin.type=pnfd"
640 elif nf_type
== "hnf":
641 nf_filter
= "_admin.type=hnfd"
643 raise ClientException(
644 'wrong value for "--nf_type" option, allowed values: vnf, pnf, hnf'
647 filter = "{}&{}".format(nf_filter
, filter)
651 resp
= ctx
.obj
.vnfd
.list(filter)
653 resp
= ctx
.obj
.vnfd
.list()
654 # print(yaml.safe_dump(resp))
655 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
656 if fullclassname
== "osmclient.sol005.client.Client":
673 table
= PrettyTable(["nfpkg name", "id", "desc type"])
675 name
= vnfd
.get("id", vnfd
.get("name", "-"))
676 descriptor_type
= "sol006" if "product-name" in vnfd
else "rel8"
678 onb_state
= vnfd
["_admin"].get("onboardingState", "-")
679 op_state
= vnfd
["_admin"].get("operationalState", "-")
680 vendor
= vnfd
.get("provider", vnfd
.get("vendor"))
681 version
= vnfd
.get("version")
682 usage_state
= vnfd
["_admin"].get("usageState", "-")
683 date
= datetime
.fromtimestamp(vnfd
["_admin"]["created"]).strftime(
686 last_update
= datetime
.fromtimestamp(
687 vnfd
["_admin"]["modified"]
688 ).strftime("%Y-%m-%dT%H:%M:%S")
704 table
.add_row([name
, vnfd
["_id"], descriptor_type
])
706 table
= PrettyTable(["nfpkg name", "id"])
708 table
.add_row([vnfd
["name"], vnfd
["id"]])
713 @cli_osm.command(name
="vnfd-list", short_help
="list all xNF packages (VNF, HNF, PNF)")
714 @click.option("--nf_type", help="type of NF (vnf, pnf, hnf)")
719 help="restricts the list to the NF pkg matching the filter",
721 @click.option("--long", is_flag
=True, help="get more details")
723 def vnfd_list1(ctx
, nf_type
, filter, long):
724 """list all xNF packages (VNF, HNF, PNF)"""
726 vnfd_list(ctx
, nf_type
, filter, long)
729 @cli_osm.command(name
="vnfpkg-list", short_help
="list all xNF packages (VNF, HNF, PNF)")
730 @click.option("--nf_type", help="type of NF (vnf, pnf, hnf)")
735 help="restricts the list to the NFpkg matching the filter",
737 @click.option("--long", is_flag
=True, help="get more details")
739 def vnfd_list2(ctx
, nf_type
, filter, long):
740 """list all xNF packages (VNF, HNF, PNF)"""
742 vnfd_list(ctx
, nf_type
, filter, long)
745 @cli_osm.command(name
="nfpkg-list", short_help
="list all xNF packages (VNF, HNF, PNF)")
746 @click.option("--nf_type", help="type of NF (vnf, pnf, hnf)")
751 help="restricts the list to the NFpkg matching the filter",
753 @click.option("--long", is_flag
=True, help="get more details")
755 def nfpkg_list(ctx
, nf_type
, filter, long):
756 """list all xNF packages (VNF, HNF, PNF)"""
759 check_client_version(ctx
.obj
, ctx
.command
.name
)
760 vnfd_list(ctx
, nf_type
, filter, long)
761 # except ClientException as e:
767 name
="vnfpkg-repo-list", short_help
="list all xNF from OSM repositories"
773 help="restricts the list to the NFpkg matching the filter",
776 "--repo", default
=None, help="restricts the list to a particular OSM repository"
778 @click.option("--long", is_flag
=True, help="get more details")
780 def nfpkg_repo_list1(ctx
, filter, repo
, long):
781 """list xNF packages from OSM repositories"""
783 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
787 name
="nfpkg-repo-list", short_help
="list all xNF from OSM repositories"
793 help="restricts the list to the NFpkg matching the filter",
796 "--repo", default
=None, help="restricts the list to a particular OSM repository"
798 @click.option("--long", is_flag
=True, help="get more details")
800 def nfpkg_repo_list2(ctx
, filter, repo
, long):
801 """list xNF packages from OSM repositories"""
803 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
806 def vnf_list(ctx
, ns
, filter, long):
810 check_client_version(ctx
.obj
, "--ns")
812 filter = "&".join(filter)
813 check_client_version(ctx
.obj
, "--filter")
814 resp
= ctx
.obj
.vnf
.list(ns
, filter)
816 resp
= ctx
.obj
.vnf
.list()
817 # except ClientException as e:
820 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
821 if fullclassname
== "osmclient.sol005.client.Client":
843 table
= PrettyTable(field_names
)
845 name
= vnfr
["name"] if "name" in vnfr
else "-"
850 vnfr
["member-vnf-index-ref"],
852 vnfr
["vim-account-id"],
856 date
= datetime
.fromtimestamp(vnfr
["_admin"]["created"]).strftime(
859 last_update
= datetime
.fromtimestamp(
860 vnfr
["_admin"]["modified"]
861 ).strftime("%Y-%m-%dT%H:%M:%S")
862 new_row
.extend([date
, last_update
])
863 table
.add_row(new_row
)
865 table
= PrettyTable(["vnf name", "id", "operational status", "config status"])
867 if "mgmt-interface" not in vnfr
:
868 vnfr
["mgmt-interface"] = {}
869 vnfr
["mgmt-interface"]["ip-address"] = None
874 vnfr
["operational-status"],
875 vnfr
["config-status"],
882 @cli_osm.command(name
="vnf-list", short_help
="list all NF instances")
884 "--ns", default
=None, help="NS instance id or name to restrict the NF list"
890 help="restricts the list to the NF instances matching the filter.",
892 @click.option("--long", is_flag
=True, help="get more details")
894 def vnf_list1(ctx
, ns
, filter, long):
895 """list all NF instances"""
897 vnf_list(ctx
, ns
, filter, long)
900 @cli_osm.command(name
="nsd-repo-list", short_help
="list all NS from OSM repositories")
905 help="restricts the list to the NS matching the filter",
908 "--repo", default
=None, help="restricts the list to a particular OSM repository"
910 @click.option("--long", is_flag
=True, help="get more details")
912 def nspkg_repo_list(ctx
, filter, repo
, long):
913 """list xNF packages from OSM repositories"""
915 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
918 @cli_osm.command(name
="nspkg-repo-list", short_help
="list all NS from OSM repositories")
923 help="restricts the list to the NS matching the filter",
926 "--repo", default
=None, help="restricts the list to a particular OSM repository"
928 @click.option("--long", is_flag
=True, help="get more details")
930 def nspkg_repo_list2(ctx
, filter, repo
, long):
931 """list xNF packages from OSM repositories"""
933 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
936 @cli_osm.command(name
="nf-list", short_help
="list all NF instances")
938 "--ns", default
=None, help="NS instance id or name to restrict the NF list"
944 help="restricts the list to the NF instances matching the filter.",
946 @click.option("--long", is_flag
=True, help="get more details")
948 def nf_list(ctx
, ns
, filter, long):
949 """list all NF instances
953 --ns TEXT NS instance id or name to restrict the VNF list
954 --filter filterExpr Restricts the list to the VNF instances matching the filter
957 filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
958 concatenated using the "&" character:
961 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
962 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
963 op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
965 value := scalar value
969 * zero or more occurrences
970 ? zero or one occurrence
971 [] grouping of expressions to be used with ? and *
972 "" quotation marks for marking string constants
976 "AttrName" is the name of one attribute in the data type that defines the representation
977 of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
978 <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
979 "Op" stands for the comparison operator. If the expression has concatenated <attrName>
980 entries, it means that the operator "op" is applied to the attribute addressed by the last
981 <attrName> entry included in the concatenation. All simple filter expressions are combined
982 by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
983 the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
984 concatenation of all "attrName" entries except the leaf attribute is called the "attribute
985 prefix". If an attribute referenced in an expression is an array, an object that contains a
986 corresponding array shall be considered to match the expression if any of the elements in the
987 array matches all expressions that have the same attribute prefix.
991 --filter vim-account-id=<VIM_ACCOUNT_ID>
992 --filter vnfd-ref=<VNFD_NAME>
993 --filter vdur.ip-address=<IP_ADDRESS>
994 --filter vnfd-ref=<VNFD_NAME>,vdur.ip-address=<IP_ADDRESS>
997 vnf_list(ctx
, ns
, filter, long)
1001 name
="ns-op-list", short_help
="shows the history of operations over a NS instance"
1003 @click.argument("name")
1005 "--long", is_flag
=True, help="get more details of the NS operation (date, )."
1008 def ns_op_list(ctx
, name
, long):
1009 """shows the history of operations over a NS instance
1011 NAME: name or ID of the NS instance
1014 def formatParams(params
):
1015 if params
["lcmOperationType"] == "instantiate":
1016 params
.pop("nsDescription")
1017 params
.pop("nsName")
1019 params
.pop("nsr_id")
1020 elif params
["lcmOperationType"] == "action":
1021 params
.pop("primitive")
1022 params
.pop("lcmOperationType")
1023 params
.pop("nsInstanceId")
1028 check_client_version(ctx
.obj
, ctx
.command
.name
)
1029 resp
= ctx
.obj
.ns
.list_op(name
)
1030 # except ClientException as e:
1035 table
= PrettyTable(
1048 table
= PrettyTable(
1049 ["id", "operation", "action_name", "status", "date", "detail"]
1052 # print(yaml.safe_dump(resp))
1055 if op
["lcmOperationType"] == "action":
1056 action_name
= op
["operationParams"]["primitive"]
1058 if op
["operationState"] == "PROCESSING":
1059 if op
["queuePosition"] is not None and op
["queuePosition"] > 0:
1060 detail
= "In queue. Current position: {}".format(op
["queuePosition"])
1061 elif op
["lcmOperationType"] in ("instantiate", "terminate"):
1063 detail
= op
["stage"]
1064 elif op
["operationState"] in ("FAILED", "FAILED_TEMP"):
1065 detail
= op
.get("errorMessage", "-")
1066 date
= datetime
.fromtimestamp(op
["startTime"]).strftime("%Y-%m-%dT%H:%M:%S")
1067 last_update
= datetime
.fromtimestamp(op
["statusEnteredTime"]).strftime(
1074 op
["lcmOperationType"],
1077 text
=json
.dumps(formatParams(op
["operationParams"]), indent
=2),
1080 op
["operationState"],
1083 wrap_text(text
=detail
, width
=50),
1090 op
["lcmOperationType"],
1092 op
["operationState"],
1094 wrap_text(text
=detail
or "", width
=50),
1101 def nsi_list(ctx
, filter):
1102 """list all Network Slice Instances"""
1105 check_client_version(ctx
.obj
, ctx
.command
.name
)
1107 filter = "&".join(filter)
1108 resp
= ctx
.obj
.nsi
.list(filter)
1109 # except ClientException as e:
1112 table
= PrettyTable(
1114 "netslice instance name",
1116 "operational status",
1122 nsi_name
= nsi
["name"]
1125 nsi
["operational-status"] if "operational-status" in nsi
else "Not found"
1127 configstatus
= nsi
["config-status"] if "config-status" in nsi
else "Not found"
1129 nsi
["detailed-status"] if "detailed-status" in nsi
else "Not found"
1131 if configstatus
== "config_not_needed":
1132 configstatus
= "configured (no charms)"
1133 table
.add_row([nsi_name
, nsi_id
, opstatus
, configstatus
, detailed_status
])
1138 @cli_osm.command(name
="nsi-list", short_help
="list all Network Slice Instances (NSI)")
1143 help="restricts the list to the Network Slice Instances matching the filter",
1146 def nsi_list1(ctx
, filter):
1147 """list all Network Slice Instances (NSI)"""
1149 nsi_list(ctx
, filter)
1153 name
="netslice-instance-list", short_help
="list all Network Slice Instances (NSI)"
1159 help="restricts the list to the Network Slice Instances matching the filter",
1162 def nsi_list2(ctx
, filter):
1163 """list all Network Slice Instances (NSI)"""
1165 nsi_list(ctx
, filter)
1168 def nst_list(ctx
, filter):
1171 check_client_version(ctx
.obj
, ctx
.command
.name
)
1173 filter = "&".join(filter)
1174 resp
= ctx
.obj
.nst
.list(filter)
1175 # except ClientException as e:
1178 # print(yaml.safe_dump(resp))
1179 table
= PrettyTable(["nst name", "id"])
1181 name
= nst
["name"] if "name" in nst
else "-"
1182 table
.add_row([name
, nst
["_id"]])
1187 @cli_osm.command(name
="nst-list", short_help
="list all Network Slice Templates (NST)")
1192 help="restricts the list to the NST matching the filter",
1195 def nst_list1(ctx
, filter):
1196 """list all Network Slice Templates (NST) in the system"""
1198 nst_list(ctx
, filter)
1202 name
="netslice-template-list", short_help
="list all Network Slice Templates (NST)"
1208 help="restricts the list to the NST matching the filter",
1211 def nst_list2(ctx
, filter):
1212 """list all Network Slice Templates (NST) in the system"""
1214 nst_list(ctx
, filter)
1217 def nsi_op_list(ctx
, name
):
1220 check_client_version(ctx
.obj
, ctx
.command
.name
)
1221 resp
= ctx
.obj
.nsi
.list_op(name
)
1222 # except ClientException as e:
1225 table
= PrettyTable(["id", "operation", "status"])
1227 table
.add_row([op
["id"], op
["lcmOperationType"], op
["operationState"]])
1234 short_help
="shows the history of operations over a Network Slice Instance (NSI)",
1236 @click.argument("name")
1238 def nsi_op_list1(ctx
, name
):
1239 """shows the history of operations over a Network Slice Instance (NSI)
1241 NAME: name or ID of the Network Slice Instance
1244 nsi_op_list(ctx
, name
)
1248 name
="netslice-instance-op-list",
1249 short_help
="shows the history of operations over a Network Slice Instance (NSI)",
1251 @click.argument("name")
1253 def nsi_op_list2(ctx
, name
):
1254 """shows the history of operations over a Network Slice Instance (NSI)
1256 NAME: name or ID of the Network Slice Instance
1259 nsi_op_list(ctx
, name
)
1262 @cli_osm.command(name
="pdu-list", short_help
="list all Physical Deployment Units (PDU)")
1267 help="restricts the list to the Physical Deployment Units matching the filter",
1270 def pdu_list(ctx
, filter):
1271 """list all Physical Deployment Units (PDU)"""
1274 check_client_version(ctx
.obj
, ctx
.command
.name
)
1276 filter = "&".join(filter)
1277 resp
= ctx
.obj
.pdu
.list(filter)
1278 # except ClientException as e:
1281 table
= PrettyTable(["pdu name", "id", "type", "mgmt ip address"])
1283 pdu_name
= pdu
["name"]
1285 pdu_type
= pdu
["type"]
1286 pdu_ipaddress
= "None"
1287 for iface
in pdu
["interfaces"]:
1289 pdu_ipaddress
= iface
["ip-address"]
1291 table
.add_row([pdu_name
, pdu_id
, pdu_type
, pdu_ipaddress
])
1296 ####################
1298 ####################
1301 def nsd_show(ctx
, name
, literal
):
1304 resp
= ctx
.obj
.nsd
.get(name
)
1305 # resp = ctx.obj.nsd.get_individual(name)
1306 # except ClientException as e:
1311 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1314 table
= PrettyTable(["field", "value"])
1315 for k
, v
in list(resp
.items()):
1316 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1321 @cli_osm.command(name
="nsd-show", short_help
="shows the details of a NS package")
1322 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1323 @click.argument("name")
1325 def nsd_show1(ctx
, name
, literal
):
1326 """shows the content of a NSD
1328 NAME: name or ID of the NSD/NSpkg
1331 nsd_show(ctx
, name
, literal
)
1334 @cli_osm.command(name
="nspkg-show", short_help
="shows the details of a NS package")
1335 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1336 @click.argument("name")
1338 def nsd_show2(ctx
, name
, literal
):
1339 """shows the content of a NSD
1341 NAME: name or ID of the NSD/NSpkg
1344 nsd_show(ctx
, name
, literal
)
1347 def vnfd_show(ctx
, name
, literal
):
1350 resp
= ctx
.obj
.vnfd
.get(name
)
1351 # resp = ctx.obj.vnfd.get_individual(name)
1352 # except ClientException as e:
1357 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1360 table
= PrettyTable(["field", "value"])
1361 for k
, v
in list(resp
.items()):
1362 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1367 def pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
):
1370 filter = "&".join(filter)
1372 resp
= ctx
.obj
.osmrepo
.pkg_get(pkgtype
, name
, repo
, version
, filter)
1375 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1378 catalog
= pkgtype
+ "-catalog"
1379 full_catalog
= pkgtype
+ ":" + catalog
1380 if resp
.get(catalog
):
1381 resp
= resp
.pop(catalog
)[pkgtype
][0]
1382 elif resp
.get(full_catalog
):
1383 resp
= resp
.pop(full_catalog
)[pkgtype
][0]
1385 table
= PrettyTable(["field", "value"])
1386 for k
, v
in list(resp
.items()):
1387 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1392 @cli_osm.command(name
="vnfd-show", short_help
="shows the details of a NF package")
1393 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1394 @click.argument("name")
1396 def vnfd_show1(ctx
, name
, literal
):
1397 """shows the content of a VNFD
1399 NAME: name or ID of the VNFD/VNFpkg
1402 vnfd_show(ctx
, name
, literal
)
1405 @cli_osm.command(name
="vnfpkg-show", short_help
="shows the details of a NF package")
1406 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1407 @click.argument("name")
1409 def vnfd_show2(ctx
, name
, literal
):
1410 """shows the content of a VNFD
1412 NAME: name or ID of the VNFD/VNFpkg
1415 vnfd_show(ctx
, name
, literal
)
1419 name
="vnfpkg-repo-show",
1420 short_help
="shows the details of a NF package in an OSM repository",
1422 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1423 @click.option("--repo", required
=True, help="Repository name")
1424 @click.argument("name")
1425 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1426 @click.option("--version", default
="latest", help="package version")
1428 def vnfd_show3(ctx
, name
, repo
, version
, literal
=None, filter=None):
1429 """shows the content of a VNFD in a repository
1431 NAME: name or ID of the VNFD/VNFpkg
1434 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1438 name
="nsd-repo-show",
1439 short_help
="shows the details of a NS package in an OSM repository",
1441 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1442 @click.option("--repo", required
=True, help="Repository name")
1443 @click.argument("name")
1444 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1445 @click.option("--version", default
="latest", help="package version")
1447 def nsd_repo_show(ctx
, name
, repo
, version
, literal
=None, filter=None):
1448 """shows the content of a VNFD in a repository
1450 NAME: name or ID of the VNFD/VNFpkg
1453 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1457 name
="nspkg-repo-show",
1458 short_help
="shows the details of a NS package in an OSM repository",
1460 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1461 @click.option("--repo", required
=True, help="Repository name")
1462 @click.argument("name")
1463 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1464 @click.option("--version", default
="latest", help="package version")
1466 def nsd_repo_show2(ctx
, name
, repo
, version
, literal
=None, filter=None):
1467 """shows the content of a VNFD in a repository
1469 NAME: name or ID of the VNFD/VNFpkg
1472 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1475 @cli_osm.command(name
="nfpkg-show", short_help
="shows the details of a NF package")
1476 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1477 @click.argument("name")
1479 def nfpkg_show(ctx
, name
, literal
):
1480 """shows the content of a NF Descriptor
1482 NAME: name or ID of the NFpkg
1485 vnfd_show(ctx
, name
, literal
)
1489 name
="nfpkg-repo-show",
1490 short_help
="shows the details of a NF package in an OSM repository",
1492 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1493 @click.option("--repo", required
=True, help="Repository name")
1494 @click.argument("name")
1495 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1496 @click.option("--version", default
="latest", help="package version")
1498 def vnfd_show4(ctx
, name
, repo
, version
, literal
=None, filter=None):
1499 """shows the content of a VNFD in a repository
1501 NAME: name or ID of the VNFD/VNFpkg
1504 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1507 @cli_osm.command(name
="ns-show", short_help
="shows the info of a NS instance")
1508 @click.argument("name")
1509 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1513 help="restricts the information to the fields in the filter",
1516 def ns_show(ctx
, name
, literal
, filter):
1517 """shows the info of a NS instance
1519 NAME: name or ID of the NS instance
1523 ns
= ctx
.obj
.ns
.get(name
)
1524 # except ClientException as e:
1529 print(yaml
.safe_dump(ns
, indent
=4, default_flow_style
=False))
1532 table
= PrettyTable(["field", "value"])
1534 for k
, v
in list(ns
.items()):
1535 if not filter or k
in filter:
1536 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1538 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
1539 if fullclassname
!= "osmclient.sol005.client.Client":
1540 nsopdata
= ctx
.obj
.ns
.get_opdata(ns
["id"])
1541 nsr_optdata
= nsopdata
["nsr:nsr"]
1542 for k
, v
in list(nsr_optdata
.items()):
1543 if not filter or k
in filter:
1544 table
.add_row([k
, wrap_text(json
.dumps(v
, indent
=2), width
=100)])
1549 @cli_osm.command(name
="vnf-show", short_help
="shows the info of a VNF instance")
1550 @click.argument("name")
1551 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1555 help="restricts the information to the fields in the filter",
1557 @click.option("--kdu", default
=None, help="KDU name (whose status will be shown)")
1559 def vnf_show(ctx
, name
, literal
, filter, kdu
):
1560 """shows the info of a VNF instance
1562 NAME: name or ID of the VNF instance
1565 def print_kdu_status(op_info_status
):
1566 """print KDU status properly formatted"""
1568 op_status
= yaml
.safe_load(op_info_status
)
1570 "namespace" in op_status
1571 and "info" in op_status
1572 and "last_deployed" in op_status
["info"]
1573 and "status" in op_status
["info"]
1574 and "code" in op_status
["info"]["status"]
1575 and "resources" in op_status
["info"]["status"]
1576 and "seconds" in op_status
["info"]["last_deployed"]
1578 last_deployed_time
= datetime
.fromtimestamp(
1579 op_status
["info"]["last_deployed"]["seconds"]
1580 ).strftime("%a %b %d %I:%M:%S %Y")
1581 print("LAST DEPLOYED: {}".format(last_deployed_time
))
1582 print("NAMESPACE: {}".format(op_status
["namespace"]))
1583 status_code
= "UNKNOWN"
1584 if op_status
["info"]["status"]["code"] == 1:
1585 status_code
= "DEPLOYED"
1586 print("STATUS: {}".format(status_code
))
1589 print(op_status
["info"]["status"]["resources"])
1590 if "notes" in op_status
["info"]["status"]:
1592 print(op_status
["info"]["status"]["notes"])
1594 print(op_info_status
)
1596 print(op_info_status
)
1601 raise ClientException(
1602 '"--literal" option is incompatible with "--kdu" option'
1605 raise ClientException(
1606 '"--filter" option is incompatible with "--kdu" option'
1610 check_client_version(ctx
.obj
, ctx
.command
.name
)
1611 resp
= ctx
.obj
.vnf
.get(name
)
1614 ns_id
= resp
["nsr-id-ref"]
1616 op_data
["member_vnf_index"] = resp
["member-vnf-index-ref"]
1617 op_data
["kdu_name"] = kdu
1618 op_data
["primitive"] = "status"
1619 op_data
["primitive_params"] = {}
1620 op_id
= ctx
.obj
.ns
.exec_op(ns_id
, op_name
="action", op_data
=op_data
, wait
=False)
1623 op_info
= ctx
.obj
.ns
.get_op(op_id
)
1624 if op_info
["operationState"] == "COMPLETED":
1625 print_kdu_status(op_info
["detailed-status"])
1629 print("Could not determine KDU status")
1633 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1636 table
= PrettyTable(["field", "value"])
1637 for k
, v
in list(resp
.items()):
1638 if not filter or k
in filter:
1639 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1642 # except ClientException as e:
1647 # @cli_osm.command(name='vnf-monitoring-show')
1648 # @click.argument('vnf_name')
1649 # @click.pass_context
1650 # def vnf_monitoring_show(ctx, vnf_name):
1652 # check_client_version(ctx.obj, ctx.command.name, 'v1')
1653 # resp = ctx.obj.vnf.get_monitoring(vnf_name)
1654 # except ClientException as e:
1658 # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
1659 # if resp is not None:
1660 # for monitor in resp:
1664 # monitor['value-integer'],
1665 # monitor['units']])
1670 # @cli_osm.command(name='ns-monitoring-show')
1671 # @click.argument('ns_name')
1672 # @click.pass_context
1673 # def ns_monitoring_show(ctx, ns_name):
1675 # check_client_version(ctx.obj, ctx.command.name, 'v1')
1676 # resp = ctx.obj.ns.get_monitoring(ns_name)
1677 # except ClientException as e:
1681 # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
1682 # for key, val in list(resp.items()):
1683 # for monitor in val:
1687 # monitor['value-integer'],
1688 # monitor['units']])
1693 @cli_osm.command(name
="ns-op-show", short_help
="shows the info of a NS operation")
1694 @click.argument("id")
1698 help="restricts the information to the fields in the filter",
1700 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1702 def ns_op_show(ctx
, id, filter, literal
):
1703 """shows the detailed info of a NS operation
1705 ID: operation identifier
1709 check_client_version(ctx
.obj
, ctx
.command
.name
)
1710 op_info
= ctx
.obj
.ns
.get_op(id)
1711 # except ClientException as e:
1716 print(yaml
.safe_dump(op_info
, indent
=4, default_flow_style
=False))
1719 table
= PrettyTable(["field", "value"])
1720 for k
, v
in list(op_info
.items()):
1721 if not filter or k
in filter:
1722 table
.add_row([k
, wrap_text(json
.dumps(v
, indent
=2), 100)])
1727 def nst_show(ctx
, name
, literal
):
1730 check_client_version(ctx
.obj
, ctx
.command
.name
)
1731 resp
= ctx
.obj
.nst
.get(name
)
1732 # resp = ctx.obj.nst.get_individual(name)
1733 # except ClientException as e:
1738 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1741 table
= PrettyTable(["field", "value"])
1742 for k
, v
in list(resp
.items()):
1743 table
.add_row([k
, wrap_text(json
.dumps(v
, indent
=2), 100)])
1749 name
="nst-show", short_help
="shows the content of a Network Slice Template (NST)"
1751 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1752 @click.argument("name")
1754 def nst_show1(ctx
, name
, literal
):
1755 """shows the content of a Network Slice Template (NST)
1757 NAME: name or ID of the NST
1760 nst_show(ctx
, name
, literal
)
1764 name
="netslice-template-show",
1765 short_help
="shows the content of a Network Slice Template (NST)",
1767 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1768 @click.argument("name")
1770 def nst_show2(ctx
, name
, literal
):
1771 """shows the content of a Network Slice Template (NST)
1773 NAME: name or ID of the NST
1776 nst_show(ctx
, name
, literal
)
1779 def nsi_show(ctx
, name
, literal
, filter):
1782 check_client_version(ctx
.obj
, ctx
.command
.name
)
1783 nsi
= ctx
.obj
.nsi
.get(name
)
1784 # except ClientException as e:
1789 print(yaml
.safe_dump(nsi
, indent
=4, default_flow_style
=False))
1792 table
= PrettyTable(["field", "value"])
1794 for k
, v
in list(nsi
.items()):
1795 if not filter or k
in filter:
1796 table
.add_row([k
, json
.dumps(v
, indent
=2)])
1803 name
="nsi-show", short_help
="shows the content of a Network Slice Instance (NSI)"
1805 @click.argument("name")
1806 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1810 help="restricts the information to the fields in the filter",
1813 def nsi_show1(ctx
, name
, literal
, filter):
1814 """shows the content of a Network Slice Instance (NSI)
1816 NAME: name or ID of the Network Slice Instance
1819 nsi_show(ctx
, name
, literal
, filter)
1823 name
="netslice-instance-show",
1824 short_help
="shows the content of a Network Slice Instance (NSI)",
1826 @click.argument("name")
1827 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1831 help="restricts the information to the fields in the filter",
1834 def nsi_show2(ctx
, name
, literal
, filter):
1835 """shows the content of a Network Slice Instance (NSI)
1837 NAME: name or ID of the Network Slice Instance
1840 nsi_show(ctx
, name
, literal
, filter)
1843 def nsi_op_show(ctx
, id, filter):
1846 check_client_version(ctx
.obj
, ctx
.command
.name
)
1847 op_info
= ctx
.obj
.nsi
.get_op(id)
1848 # except ClientException as e:
1852 table
= PrettyTable(["field", "value"])
1853 for k
, v
in list(op_info
.items()):
1854 if not filter or k
in filter:
1855 table
.add_row([k
, json
.dumps(v
, indent
=2)])
1862 short_help
="shows the info of an operation over a Network Slice Instance(NSI)",
1864 @click.argument("id")
1868 help="restricts the information to the fields in the filter",
1871 def nsi_op_show1(ctx
, id, filter):
1872 """shows the info of an operation over a Network Slice Instance(NSI)
1874 ID: operation identifier
1877 nsi_op_show(ctx
, id, filter)
1881 name
="netslice-instance-op-show",
1882 short_help
="shows the info of an operation over a Network Slice Instance(NSI)",
1884 @click.argument("id")
1888 help="restricts the information to the fields in the filter",
1891 def nsi_op_show2(ctx
, id, filter):
1892 """shows the info of an operation over a Network Slice Instance(NSI)
1894 ID: operation identifier
1897 nsi_op_show(ctx
, id, filter)
1901 name
="pdu-show", short_help
="shows the content of a Physical Deployment Unit (PDU)"
1903 @click.argument("name")
1904 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1908 help="restricts the information to the fields in the filter",
1911 def pdu_show(ctx
, name
, literal
, filter):
1912 """shows the content of a Physical Deployment Unit (PDU)
1914 NAME: name or ID of the PDU
1918 check_client_version(ctx
.obj
, ctx
.command
.name
)
1919 pdu
= ctx
.obj
.pdu
.get(name
)
1920 # except ClientException as e:
1925 print(yaml
.safe_dump(pdu
, indent
=4, default_flow_style
=False))
1928 table
= PrettyTable(["field", "value"])
1930 for k
, v
in list(pdu
.items()):
1931 if not filter or k
in filter:
1932 table
.add_row([k
, json
.dumps(v
, indent
=2)])
1938 ####################
1940 ####################
1943 def nsd_create(ctx
, filename
, overwrite
, skip_charm_build
, repo
, vendor
, version
):
1946 check_client_version(ctx
.obj
, ctx
.command
.name
)
1948 filename
= ctx
.obj
.osmrepo
.get_pkg("ns", filename
, repo
, vendor
, version
)
1949 ctx
.obj
.nsd
.create(filename
, overwrite
=overwrite
, skip_charm_build
=skip_charm_build
)
1950 # except ClientException as e:
1955 @cli_osm.command(name
="nsd-create", short_help
="creates a new NSD/NSpkg")
1956 @click.argument("filename")
1960 default
=None, # hidden=True,
1961 help="Deprecated. Use override",
1967 help="overrides fields in descriptor, format: "
1968 '"key1.key2...=value[;key3...=value;...]"',
1971 "--skip-charm-build",
1974 help="The charm will not be compiled, it is assumed to already exist",
1976 @click.option("--repo", default
=None, help="[repository]: Repository name")
1977 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
1981 help="[repository]: filter by version. Default: latest",
1984 def nsd_create1(ctx
, filename
, overwrite
, skip_charm_build
, repo
, vendor
, version
):
1985 """onboards a new NSpkg (alias of nspkg-create) (TO BE DEPRECATED)
1988 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
1989 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
1990 If FILENAME is an NF Package folder, it is built and then onboarded.
1996 overwrite
=overwrite
,
1997 skip_charm_build
=skip_charm_build
,
2004 @cli_osm.command(name
="nspkg-create", short_help
="creates a new NSD/NSpkg")
2005 @click.argument("filename")
2009 default
=None, # hidden=True,
2010 help="Deprecated. Use override",
2016 help="overrides fields in descriptor, format: "
2017 '"key1.key2...=value[;key3...=value;...]"',
2020 "--skip-charm-build",
2023 help="The charm will not be compiled, it is assumed to already exist",
2025 @click.option("--repo", default
=None, help="[repository]: Repository name")
2026 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2030 help="[repository]: filter by version. Default: latest",
2033 def nsd_pkg_create(ctx
, filename
, overwrite
, skip_charm_build
, repo
, vendor
, version
):
2034 """onboards a new NSpkg
2036 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2037 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2038 If FILENAME is an NF Package folder, it is built and then onboarded.
2044 overwrite
=overwrite
,
2045 skip_charm_build
=skip_charm_build
,
2066 check_client_version(ctx
.obj
, ctx
.command
.name
)
2068 filename
= ctx
.obj
.osmrepo
.get_pkg("vnf", filename
, repo
, vendor
, version
)
2069 ctx
.obj
.vnfd
.create(
2071 overwrite
=overwrite
,
2072 skip_charm_build
=skip_charm_build
,
2073 override_epa
=override_epa
,
2074 override_nonepa
=override_nonepa
,
2075 override_paravirt
=override_paravirt
,
2077 # except ClientException as e:
2082 @cli_osm.command(name
="vnfd-create", short_help
="creates a new VNFD/VNFpkg")
2083 @click.argument("filename")
2085 "--overwrite", "overwrite", default
=None, help="overwrite deprecated, use override"
2091 help="overrides fields in descriptor, format: "
2092 '"key1.key2...=value[;key3...=value;...]"',
2095 "--skip-charm-build",
2098 help="The charm will not be compiled, it is assumed to already exist",
2105 help="adds guest-epa parameters to all VDU",
2108 "--override-nonepa",
2112 help="removes all guest-epa parameters from all VDU",
2115 "--override-paravirt",
2119 help="overrides all VDU interfaces to PARAVIRT",
2121 @click.option("--repo", default
=None, help="[repository]: Repository name")
2122 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2126 help="[repository]: filter by version. Default: latest",
2141 """creates a new VNFD/VNFpkg
2143 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2144 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2145 If FILENAME is an NF Package folder, it is built and then onboarded.
2151 overwrite
=overwrite
,
2152 skip_charm_build
=skip_charm_build
,
2153 override_epa
=override_epa
,
2154 override_nonepa
=override_nonepa
,
2155 override_paravirt
=override_paravirt
,
2162 @cli_osm.command(name
="vnfpkg-create", short_help
="creates a new VNFD/VNFpkg")
2163 @click.argument("filename")
2167 default
=None, # hidden=True,
2168 help="Deprecated. Use override",
2174 help="overrides fields in descriptor, format: "
2175 '"key1.key2...=value[;key3...=value;...]"',
2178 "--skip-charm-build",
2181 help="The charm will not be compiled, it is assumed to already exist",
2188 help="adds guest-epa parameters to all VDU",
2191 "--override-nonepa",
2195 help="removes all guest-epa parameters from all VDU",
2198 "--override-paravirt",
2202 help="overrides all VDU interfaces to PARAVIRT",
2204 @click.option("--repo", default
=None, help="[repository]: Repository name")
2205 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2209 help="[repository]: filter by version. Default: latest",
2224 """creates a new VNFD/VNFpkg
2226 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2227 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2228 If FILENAME is an NF Package folder, it is built and then onboarded.
2234 overwrite
=overwrite
,
2235 skip_charm_build
=skip_charm_build
,
2236 override_epa
=override_epa
,
2237 override_nonepa
=override_nonepa
,
2238 override_paravirt
=override_paravirt
,
2245 @cli_osm.command(name
="nfpkg-create", short_help
="creates a new NFpkg")
2246 @click.argument("filename")
2250 default
=None, # hidden=True,
2251 help="Deprecated. Use override",
2257 help="overrides fields in descriptor, format: "
2258 '"key1.key2...=value[;key3...=value;...]"',
2261 "--skip-charm-build",
2264 help="The charm will not be compiled, it is assumed to already exist",
2271 help="adds guest-epa parameters to all VDU",
2274 "--override-nonepa",
2278 help="removes all guest-epa parameters from all VDU",
2281 "--override-paravirt",
2285 help="overrides all VDU interfaces to PARAVIRT",
2287 @click.option("--repo", default
=None, help="[repository]: Repository name")
2288 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2292 help="[repository]: filter by version. Default: latest",
2307 """creates a new NFpkg
2310 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2311 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2312 If FILENAME is an NF Package folder, it is built and then onboarded.
2318 overwrite
=overwrite
,
2319 skip_charm_build
=skip_charm_build
,
2320 override_epa
=override_epa
,
2321 override_nonepa
=override_nonepa
,
2322 override_paravirt
=override_paravirt
,
2329 @cli_osm.command(name
="ns-create", short_help
="creates a new Network Service instance")
2330 @click.option("--ns_name", prompt
=True, help="name of the NS instance")
2331 @click.option("--nsd_name", prompt
=True, help="name of the NS descriptor")
2335 help="default VIM account id or name for the deployment",
2337 @click.option("--admin_status", default
="ENABLED", help="administration status")
2341 help="comma separated list of public key files to inject to vnfs",
2343 @click.option("--config", default
=None, help="ns specific yaml configuration")
2344 @click.option("--config_file", default
=None, help="ns specific yaml configuration file")
2350 help="do not return the control immediately, but keep it "
2351 "until the operation is completed, or timeout",
2365 """creates a new NS instance"""
2369 check_client_version(ctx
.obj
, "--config_file")
2371 raise ClientException(
2372 '"--config" option is incompatible with "--config_file" option'
2374 with
open(config_file
, "r") as cf
:
2381 account
=vim_account
,
2384 # except ClientException as e:
2389 def nst_create(ctx
, filename
, overwrite
):
2392 check_client_version(ctx
.obj
, ctx
.command
.name
)
2393 ctx
.obj
.nst
.create(filename
, overwrite
)
2394 # except ClientException as e:
2400 name
="nst-create", short_help
="creates a new Network Slice Template (NST)"
2402 @click.argument("filename")
2406 default
=None, # hidden=True,
2407 help="Deprecated. Use override",
2413 help="overrides fields in descriptor, format: "
2414 '"key1.key2...=value[;key3...=value;...]"',
2417 def nst_create1(ctx
, filename
, overwrite
):
2418 """creates a new Network Slice Template (NST)
2420 FILENAME: NST package folder, NST yaml file or NSTpkg tar.gz file
2423 nst_create(ctx
, filename
, overwrite
)
2427 name
="netslice-template-create",
2428 short_help
="creates a new Network Slice Template (NST)",
2430 @click.argument("filename")
2434 default
=None, # hidden=True,
2435 help="Deprecated. Use override",
2441 help="overrides fields in descriptor, format: "
2442 '"key1.key2...=value[;key3...=value;...]"',
2445 def nst_create2(ctx
, filename
, overwrite
):
2446 """creates a new Network Slice Template (NST)
2448 FILENAME: NST yaml file or NSTpkg tar.gz file
2451 nst_create(ctx
, filename
, overwrite
)
2455 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
2457 """creates a new Network Slice Instance (NSI)"""
2460 check_client_version(ctx
.obj
, ctx
.command
.name
)
2463 raise ClientException(
2464 '"--config" option is incompatible with "--config_file" option'
2466 with
open(config_file
, "r") as cf
:
2473 account
=vim_account
,
2476 # except ClientException as e:
2481 @cli_osm.command(name
="nsi-create", short_help
="creates a new Network Slice Instance")
2482 @click.option("--nsi_name", prompt
=True, help="name of the Network Slice Instance")
2483 @click.option("--nst_name", prompt
=True, help="name of the Network Slice Template")
2487 help="default VIM account id or name for the deployment",
2490 "--ssh_keys", default
=None, help="comma separated list of keys to inject to vnfs"
2495 help="Netslice specific yaml configuration:\n"
2496 "netslice_subnet: [\n"
2497 "id: TEXT, vim_account: TEXT,\n"
2498 "vnf: [member-vnf-index: TEXT, vim_account: TEXT]\n"
2499 "vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]\n"
2500 "additionalParamsForNsi: {param: value, ...}\n"
2501 "additionalParamsForsubnet: [{id: SUBNET_ID, additionalParamsForNs: {}, additionalParamsForVnf: {}}]\n"
2503 "netslice-vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]",
2506 "--config_file", default
=None, help="nsi specific yaml configuration file"
2513 help="do not return the control immediately, but keep it "
2514 "until the operation is completed, or timeout",
2518 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
2520 """creates a new Network Slice Instance (NSI)"""
2523 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
=wait
2528 name
="netslice-instance-create", short_help
="creates a new Network Slice Instance"
2530 @click.option("--nsi_name", prompt
=True, help="name of the Network Slice Instance")
2531 @click.option("--nst_name", prompt
=True, help="name of the Network Slice Template")
2535 help="default VIM account id or name for the deployment",
2538 "--ssh_keys", default
=None, help="comma separated list of keys to inject to vnfs"
2543 help="Netslice specific yaml configuration:\n"
2544 "netslice_subnet: [\n"
2545 "id: TEXT, vim_account: TEXT,\n"
2546 "vnf: [member-vnf-index: TEXT, vim_account: TEXT]\n"
2547 "vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]"
2549 "netslice-vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]",
2552 "--config_file", default
=None, help="nsi specific yaml configuration file"
2559 help="do not return the control immediately, but keep it "
2560 "until the operation is completed, or timeout",
2564 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
2566 """creates a new Network Slice Instance (NSI)"""
2569 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
=wait
2574 name
="pdu-create", short_help
="adds a new Physical Deployment Unit to the catalog"
2576 @click.option("--name", help="name of the Physical Deployment Unit")
2577 @click.option("--pdu_type", help="type of PDU (e.g. router, firewall, FW001)")
2580 help="interface(s) of the PDU: name=<NAME>,mgmt=<true|false>,ip-address=<IP_ADDRESS>"
2581 + "[,type=<overlay|underlay>][,mac-address=<MAC_ADDRESS>][,vim-network-name=<VIM_NET_NAME>]",
2584 @click.option("--description", help="human readable description")
2587 help="list of VIM accounts (in the same VIM) that can reach this PDU\n"
2588 + "The format for multiple VIMs is --vim_account <vim_account_id_1> "
2589 + "--vim_account <vim_account_id_2> ... --vim_account <vim_account_id_N>",
2593 "--descriptor_file",
2595 help="PDU descriptor file (as an alternative to using the other arguments)",
2599 ctx
, name
, pdu_type
, interface
, description
, vim_account
, descriptor_file
2601 """creates a new Physical Deployment Unit (PDU)"""
2604 check_client_version(ctx
.obj
, ctx
.command
.name
)
2606 pdu
= create_pdu_dictionary(name
, pdu_type
, interface
, description
, vim_account
, descriptor_file
)
2607 ctx
.obj
.pdu
.create(pdu
)
2610 ########################
2611 # UPDATE PDU operation #
2612 ########################
2616 name
="pdu-update", short_help
="updates a Physical Deployment Unit to the catalog"
2618 @click.argument("name")
2619 @click.option("--newname", help="New name for the Physical Deployment Unit")
2620 @click.option("--pdu_type", help="type of PDU (e.g. router, firewall, FW001)")
2623 help="interface(s) of the PDU: name=<NAME>,mgmt=<true|false>,ip-address=<IP_ADDRESS>"
2624 + "[,type=<overlay|underlay>][,mac-address=<MAC_ADDRESS>][,vim-network-name=<VIM_NET_NAME>]",
2627 @click.option("--description", help="human readable description")
2630 help="list of VIM accounts (in the same VIM) that can reach this PDU\n"
2631 + "The format for multiple VIMs is --vim_account <vim_account_id_1> "
2632 + "--vim_account <vim_account_id_2> ... --vim_account <vim_account_id_N>",
2636 "--descriptor_file",
2638 help="PDU descriptor file (as an alternative to using the other arguments)",
2642 ctx
, name
, newname
, pdu_type
, interface
, description
, vim_account
, descriptor_file
2644 """Updates a new Physical Deployment Unit (PDU)"""
2647 check_client_version(ctx
.obj
, ctx
.command
.name
)
2654 pdu
= create_pdu_dictionary(newname
, pdu_type
, interface
, description
, vim_account
, descriptor_file
, update
)
2655 ctx
.obj
.pdu
.update(name
, pdu
)
2658 def create_pdu_dictionary(name
, pdu_type
, interface
, description
, vim_account
, descriptor_file
, update
=False):
2663 if not descriptor_file
:
2666 raise ClientException(
2667 'in absence of descriptor file, option "--name" is mandatory'
2670 raise ClientException(
2671 'in absence of descriptor file, option "--pdu_type" is mandatory'
2674 raise ClientException(
2675 'in absence of descriptor file, option "--interface" is mandatory (at least once)'
2678 raise ClientException(
2679 'in absence of descriptor file, option "--vim_account" is mandatory (at least once)'
2682 with
open(descriptor_file
, "r") as df
:
2683 pdu
= yaml
.safe_load(df
.read())
2687 pdu
["type"] = pdu_type
2689 pdu
["description"] = description
2691 pdu
["vim_accounts"] = vim_account
2694 for iface
in interface
:
2695 new_iface
= {k
: v
for k
, v
in [i
.split("=") for i
in iface
.split(",")]}
2696 new_iface
["mgmt"] = new_iface
.get("mgmt", "false").lower() == "true"
2697 ifaces_list
.append(new_iface
)
2698 pdu
["interfaces"] = ifaces_list
2701 ####################
2703 ####################
2706 def nsd_update(ctx
, name
, content
):
2709 check_client_version(ctx
.obj
, ctx
.command
.name
)
2710 ctx
.obj
.nsd
.update(name
, content
)
2711 # except ClientException as e:
2716 @cli_osm.command(name
="nsd-update", short_help
="updates a NSD/NSpkg")
2717 @click.argument("name")
2721 help="filename with the NSD/NSpkg replacing the current one",
2724 def nsd_update1(ctx
, name
, content
):
2725 """updates a NSD/NSpkg
2727 NAME: name or ID of the NSD/NSpkg
2730 nsd_update(ctx
, name
, content
)
2733 @cli_osm.command(name
="nspkg-update", short_help
="updates a NSD/NSpkg")
2734 @click.argument("name")
2738 help="filename with the NSD/NSpkg replacing the current one",
2741 def nsd_update2(ctx
, name
, content
):
2742 """updates a NSD/NSpkg
2744 NAME: name or ID of the NSD/NSpkg
2747 nsd_update(ctx
, name
, content
)
2750 def vnfd_update(ctx
, name
, content
):
2753 check_client_version(ctx
.obj
, ctx
.command
.name
)
2754 ctx
.obj
.vnfd
.update(name
, content
)
2755 # except ClientException as e:
2760 @cli_osm.command(name
="vnfd-update", short_help
="updates a new VNFD/VNFpkg")
2761 @click.argument("name")
2765 help="filename with the VNFD/VNFpkg replacing the current one",
2768 def vnfd_update1(ctx
, name
, content
):
2769 """updates a VNFD/VNFpkg
2771 NAME: name or ID of the VNFD/VNFpkg
2774 vnfd_update(ctx
, name
, content
)
2777 @cli_osm.command(name
="vnfpkg-update", short_help
="updates a VNFD/VNFpkg")
2778 @click.argument("name")
2782 help="filename with the VNFD/VNFpkg replacing the current one",
2785 def vnfd_update2(ctx
, name
, content
):
2786 """updates a VNFD/VNFpkg
2788 NAME: VNFD yaml file or VNFpkg tar.gz file
2791 vnfd_update(ctx
, name
, content
)
2794 @cli_osm.command(name
="nfpkg-update", short_help
="updates a NFpkg")
2795 @click.argument("name")
2797 "--content", default
=None, help="filename with the NFpkg replacing the current one"
2800 def nfpkg_update(ctx
, name
, content
):
2803 NAME: NF Descriptor yaml file or NFpkg tar.gz file
2806 vnfd_update(ctx
, name
, content
)
2809 def nst_update(ctx
, name
, content
):
2812 check_client_version(ctx
.obj
, ctx
.command
.name
)
2813 ctx
.obj
.nst
.update(name
, content
)
2814 # except ClientException as e:
2819 @cli_osm.command(name
="nst-update", short_help
="updates a Network Slice Template (NST)")
2820 @click.argument("name")
2824 help="filename with the NST/NSTpkg replacing the current one",
2827 def nst_update1(ctx
, name
, content
):
2828 """updates a Network Slice Template (NST)
2830 NAME: name or ID of the NSD/NSpkg
2833 nst_update(ctx
, name
, content
)
2837 name
="netslice-template-update", short_help
="updates a Network Slice Template (NST)"
2839 @click.argument("name")
2843 help="filename with the NST/NSTpkg replacing the current one",
2846 def nst_update2(ctx
, name
, content
):
2847 """updates a Network Slice Template (NST)
2849 NAME: name or ID of the NSD/NSpkg
2852 nst_update(ctx
, name
, content
)
2855 ####################
2857 ####################
2860 def nsd_delete(ctx
, name
, force
):
2864 ctx
.obj
.nsd
.delete(name
)
2866 check_client_version(ctx
.obj
, "--force")
2867 ctx
.obj
.nsd
.delete(name
, force
)
2868 # except ClientException as e:
2873 @cli_osm.command(name
="nsd-delete", short_help
="deletes a NSD/NSpkg")
2874 @click.argument("name")
2876 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2879 def nsd_delete1(ctx
, name
, force
):
2880 """deletes a NSD/NSpkg
2882 NAME: name or ID of the NSD/NSpkg to be deleted
2885 nsd_delete(ctx
, name
, force
)
2888 @cli_osm.command(name
="nspkg-delete", short_help
="deletes a NSD/NSpkg")
2889 @click.argument("name")
2891 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2894 def nsd_delete2(ctx
, name
, force
):
2895 """deletes a NSD/NSpkg
2897 NAME: name or ID of the NSD/NSpkg to be deleted
2900 nsd_delete(ctx
, name
, force
)
2903 def vnfd_delete(ctx
, name
, force
):
2907 ctx
.obj
.vnfd
.delete(name
)
2909 check_client_version(ctx
.obj
, "--force")
2910 ctx
.obj
.vnfd
.delete(name
, force
)
2911 # except ClientException as e:
2916 @cli_osm.command(name
="vnfd-delete", short_help
="deletes a VNFD/VNFpkg")
2917 @click.argument("name")
2919 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2922 def vnfd_delete1(ctx
, name
, force
):
2923 """deletes a VNFD/VNFpkg
2925 NAME: name or ID of the VNFD/VNFpkg to be deleted
2928 vnfd_delete(ctx
, name
, force
)
2931 @cli_osm.command(name
="vnfpkg-delete", short_help
="deletes a VNFD/VNFpkg")
2932 @click.argument("name")
2934 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2937 def vnfd_delete2(ctx
, name
, force
):
2938 """deletes a VNFD/VNFpkg
2940 NAME: name or ID of the VNFD/VNFpkg to be deleted
2943 vnfd_delete(ctx
, name
, force
)
2946 @cli_osm.command(name
="nfpkg-delete", short_help
="deletes a NFpkg")
2947 @click.argument("name")
2949 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2952 def nfpkg_delete(ctx
, name
, force
):
2955 NAME: name or ID of the NFpkg to be deleted
2958 vnfd_delete(ctx
, name
, force
)
2961 @cli_osm.command(name
="ns-delete", short_help
="deletes a NS instance")
2962 @click.argument("name")
2964 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2969 help="specific yaml configuration for the termination, e.g. '{autoremove: False, timeout_ns_terminate: "
2970 "600, skip_terminate_primitives: True}'",
2977 help="do not return the control immediately, but keep it "
2978 "until the operation is completed, or timeout",
2981 def ns_delete(ctx
, name
, force
, config
, wait
):
2982 """deletes a NS instance
2984 NAME: name or ID of the NS instance to be deleted
2989 ctx
.obj
.ns
.delete(name
, config
=config
, wait
=wait
)
2991 check_client_version(ctx
.obj
, "--force")
2992 ctx
.obj
.ns
.delete(name
, force
, config
=config
, wait
=wait
)
2993 # except ClientException as e:
2998 def nst_delete(ctx
, name
, force
):
3001 check_client_version(ctx
.obj
, ctx
.command
.name
)
3002 ctx
.obj
.nst
.delete(name
, force
)
3003 # except ClientException as e:
3008 @cli_osm.command(name
="nst-delete", short_help
="deletes a Network Slice Template (NST)")
3009 @click.argument("name")
3011 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3014 def nst_delete1(ctx
, name
, force
):
3015 """deletes a Network Slice Template (NST)
3017 NAME: name or ID of the NST/NSTpkg to be deleted
3020 nst_delete(ctx
, name
, force
)
3024 name
="netslice-template-delete", short_help
="deletes a Network Slice Template (NST)"
3026 @click.argument("name")
3028 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3031 def nst_delete2(ctx
, name
, force
):
3032 """deletes a Network Slice Template (NST)
3034 NAME: name or ID of the NST/NSTpkg to be deleted
3037 nst_delete(ctx
, name
, force
)
3040 def nsi_delete(ctx
, name
, force
, wait
):
3043 check_client_version(ctx
.obj
, ctx
.command
.name
)
3044 ctx
.obj
.nsi
.delete(name
, force
, wait
=wait
)
3045 # except ClientException as e:
3050 @cli_osm.command(name
="nsi-delete", short_help
="deletes a Network Slice Instance (NSI)")
3051 @click.argument("name")
3053 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3060 help="do not return the control immediately, but keep it "
3061 "until the operation is completed, or timeout",
3064 def nsi_delete1(ctx
, name
, force
, wait
):
3065 """deletes a Network Slice Instance (NSI)
3067 NAME: name or ID of the Network Slice instance to be deleted
3070 nsi_delete(ctx
, name
, force
, wait
=wait
)
3074 name
="netslice-instance-delete", short_help
="deletes a Network Slice Instance (NSI)"
3076 @click.argument("name")
3078 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3081 def nsi_delete2(ctx
, name
, force
, wait
):
3082 """deletes a Network Slice Instance (NSI)
3084 NAME: name or ID of the Network Slice instance to be deleted
3087 nsi_delete(ctx
, name
, force
, wait
=wait
)
3091 name
="pdu-delete", short_help
="deletes a Physical Deployment Unit (PDU)"
3093 @click.argument("name")
3095 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3098 def pdu_delete(ctx
, name
, force
):
3099 """deletes a Physical Deployment Unit (PDU)
3101 NAME: name or ID of the PDU to be deleted
3105 check_client_version(ctx
.obj
, ctx
.command
.name
)
3106 ctx
.obj
.pdu
.delete(name
, force
)
3107 # except ClientException as e:
3117 @cli_osm.command(name
="vim-create", short_help
="creates a new VIM account")
3118 @click.option("--name", required
=True, help="Name to create datacenter")
3119 @click.option("--user", default
=None, help="VIM username")
3120 @click.option("--password", default
=None, help="VIM password")
3121 @click.option("--auth_url", default
=None, help="VIM url")
3122 @click.option("--tenant", "--project", "tenant", default
=None, help="VIM tenant/project name")
3123 @click.option("--config", default
=None, help="VIM specific config parameters")
3124 @click.option("--config_file", default
=None, help="VIM specific config parameters in YAML or JSON file")
3125 @click.option("--account_type", default
="openstack", help="VIM type")
3126 @click.option("--description", default
=None, help="human readable description")
3130 help="Name or id of the SDN controller associated to this VIM account",
3133 "--sdn_port_mapping",
3135 help="File describing the port mapping between compute nodes' ports and switch ports",
3142 help="do not return the control immediately, but keep it "
3143 "until the operation is completed, or timeout",
3145 @click.option("--vca", default
=None, help="VCA to be used in this VIM account")
3146 @click.option("--creds", default
=None, help="credentials file (only applycable for GCP VIM type)")
3165 """creates a new VIM account"""
3169 check_client_version(ctx
.obj
, "--sdn_controller")
3170 if sdn_port_mapping
:
3171 check_client_version(ctx
.obj
, "--sdn_port_mapping")
3173 vim
["vim-username"] = user
3174 vim
["vim-password"] = password
3175 vim
["vim-url"] = auth_url
3176 vim
["vim-tenant-name"] = tenant
3177 vim
["vim-type"] = account_type
3178 vim
["description"] = description
3181 vim_config
= create_config(config_file
, config
)
3183 with
open(creds
, "r") as cf
:
3184 vim_config
["credentials"] = yaml
.safe_load(cf
.read())
3185 ctx
.obj
.vim
.create(name
, vim
, vim_config
, sdn_controller
, sdn_port_mapping
, wait
=wait
)
3186 # except ClientException as e:
3191 @cli_osm.command(name
="vim-update", short_help
="updates a VIM account")
3192 @click.argument("name")
3193 @click.option("--newname", help="New name for the VIM account")
3194 @click.option("--user", help="VIM username")
3195 @click.option("--password", help="VIM password")
3196 @click.option("--auth_url", help="VIM url")
3197 @click.option("--tenant", help="VIM tenant name")
3198 @click.option("--config", help="VIM specific config parameters")
3199 @click.option("--config_file", default
=None, help="VIM specific config parameters in YAML or JSON file")
3200 @click.option("--account_type", help="VIM type")
3201 @click.option("--description", help="human readable description")
3205 help="Name or id of the SDN controller to be associated with this VIM"
3206 "account. Use empty string to disassociate",
3209 "--sdn_port_mapping",
3211 help="File describing the port mapping between compute nodes' ports and switch ports",
3218 help="do not return the control immediately, but keep it "
3219 "until the operation is completed, or timeout",
3221 @click.option("--creds", default
=None, help="credentials file (only applycable for GCP VIM type)")
3240 """updates a VIM account
3242 NAME: name or ID of the VIM account
3246 check_client_version(ctx
.obj
, ctx
.command
.name
)
3249 vim
["name"] = newname
3251 vim
["vim_user"] = user
3253 vim
["vim_password"] = password
3255 vim
["vim_url"] = auth_url
3257 vim
["vim-tenant-name"] = tenant
3259 vim
["vim_type"] = account_type
3261 vim
["description"] = description
3263 if config
or config_file
:
3264 vim_config
= create_config(config_file
, config
)
3266 with
open(creds
, "r") as cf
:
3267 vim_config
["credentials"] = yaml
.safe_load(cf
.read())
3268 logger
.info(f
"VIM: {vim}, VIM config: {vim_config}")
3269 ctx
.obj
.vim
.update(name
, vim
, vim_config
, sdn_controller
, sdn_port_mapping
, wait
=wait
)
3270 # except ClientException as e:
3275 @cli_osm.command(name
="vim-delete", short_help
="deletes a VIM account")
3276 @click.argument("name")
3278 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3285 help="do not return the control immediately, but keep it "
3286 "until the operation is completed, or timeout",
3289 def vim_delete(ctx
, name
, force
, wait
):
3290 """deletes a VIM account
3292 NAME: name or ID of the VIM account to be deleted
3297 ctx
.obj
.vim
.delete(name
, wait
=wait
)
3299 check_client_version(ctx
.obj
, "--force")
3300 ctx
.obj
.vim
.delete(name
, force
, wait
=wait
)
3301 # except ClientException as e:
3306 @cli_osm.command(name
="vim-list", short_help
="list all VIM accounts")
3307 # @click.option('--ro_update/--no_ro_update',
3309 # help='update list from RO')
3314 help="restricts the list to the VIM accounts matching the filter",
3319 help="get more details of the NS (project, vim, deployment status, configuration status.",
3322 def vim_list(ctx
, filter, long):
3323 """list all VIM accounts"""
3326 filter = "&".join(filter)
3327 check_client_version(ctx
.obj
, "--filter")
3329 # check_client_version(ctx.obj, '--ro_update', 'v1')
3330 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
3331 if fullclassname
== "osmclient.sol005.client.Client":
3332 resp
= ctx
.obj
.vim
.list(filter)
3334 # resp = ctx.obj.vim.list(ro_update)
3336 table
= PrettyTable(
3337 ["vim name", "uuid", "project", "operational state", "error details"]
3339 project_list
= ctx
.obj
.project
.list()
3341 table
= PrettyTable(["vim name", "uuid", "operational state"])
3344 if "vim_password" in vim
:
3345 vim
["vim_password"] = "********"
3346 if "config" in vim
and "credentials" in vim
["config"]:
3347 vim
["config"]["credentials"] = "********"
3348 logger
.debug("VIM details: {}".format(yaml
.safe_dump(vim
)))
3349 vim_state
= vim
["_admin"].get("operationalState", "-")
3350 error_details
= "N/A"
3351 if vim_state
== "ERROR":
3352 error_details
= vim
["_admin"].get("detailed-status", "Not found")
3353 project_id
, project_name
= get_project(project_list
, vim
)
3354 # project_info = '{} ({})'.format(project_name, project_id)
3355 project_info
= project_name
3362 wrap_text(text
=error_details
, width
=80),
3367 [vim
["name"], vim
["uuid"], vim
["_admin"].get("operationalState", "-")]
3373 @cli_osm.command(name
="vim-show", short_help
="shows the details of a VIM account")
3374 @click.argument("name")
3378 help="restricts the information to the fields in the filter",
3380 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
3382 def vim_show(ctx
, name
, filter, literal
):
3383 """shows the details of a VIM account
3385 NAME: name or ID of the VIM account
3389 resp
= ctx
.obj
.vim
.get(name
)
3390 if "vim_password" in resp
:
3391 resp
["vim_password"] = "********"
3392 if "config" in resp
and "credentials" in resp
["config"]:
3393 resp
["config"]["credentials"] = "********"
3394 # except ClientException as e:
3399 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
3401 table
= PrettyTable(["key", "attribute"])
3402 for k
, v
in list(resp
.items()):
3403 if not filter or k
in filter:
3404 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
3409 ####################
3411 ####################
3414 @cli_osm.command(name
="wim-create", short_help
="creates a new WIM account")
3415 @click.option("--name", prompt
=True, help="Name for the WIM account")
3416 @click.option("--user", help="WIM username")
3417 @click.option("--password", help="WIM password")
3418 @click.option("--url", prompt
=True, help="WIM url")
3419 # @click.option('--tenant',
3420 # help='wIM tenant name')
3421 @click.option("--config", default
=None, help="WIM specific config parameters")
3422 @click.option("--wim_type", help="WIM type")
3423 @click.option("--description", default
=None, help="human readable description")
3425 "--wim_port_mapping",
3427 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
3428 "(WAN service endpoint id and info)",
3435 help="do not return the control immediately, but keep it "
3436 "until the operation is completed, or timeout",
3452 """creates a new WIM account"""
3455 check_client_version(ctx
.obj
, ctx
.command
.name
)
3456 # if sdn_controller:
3457 # check_client_version(ctx.obj, '--sdn_controller')
3458 # if sdn_port_mapping:
3459 # check_client_version(ctx.obj, '--sdn_port_mapping')
3464 wim
["password"] = password
3466 wim
["wim_url"] = url
3467 # if tenant: wim['tenant'] = tenant
3468 wim
["wim_type"] = wim_type
3470 wim
["description"] = description
3472 wim
["config"] = config
3473 ctx
.obj
.wim
.create(name
, wim
, wim_port_mapping
, wait
=wait
)
3474 # except ClientException as e:
3479 @cli_osm.command(name
="wim-update", short_help
="updates a WIM account")
3480 @click.argument("name")
3481 @click.option("--newname", help="New name for the WIM account")
3482 @click.option("--user", help="WIM username")
3483 @click.option("--password", help="WIM password")
3484 @click.option("--url", help="WIM url")
3485 @click.option("--config", help="WIM specific config parameters")
3486 @click.option("--wim_type", help="WIM type")
3487 @click.option("--description", help="human readable description")
3489 "--wim_port_mapping",
3491 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
3492 "(WAN service endpoint id and info)",
3499 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3515 """updates a WIM account
3517 NAME: name or ID of the WIM account
3521 check_client_version(ctx
.obj
, ctx
.command
.name
)
3524 wim
["name"] = newname
3528 wim
["password"] = password
3531 # if tenant: wim['tenant'] = tenant
3533 wim
["wim_type"] = wim_type
3535 wim
["description"] = description
3537 wim
["config"] = config
3538 ctx
.obj
.wim
.update(name
, wim
, wim_port_mapping
, wait
=wait
)
3539 # except ClientException as e:
3544 @cli_osm.command(name
="wim-delete", short_help
="deletes a WIM account")
3545 @click.argument("name")
3547 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3554 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3557 def wim_delete(ctx
, name
, force
, wait
):
3558 """deletes a WIM account
3560 NAME: name or ID of the WIM account to be deleted
3564 check_client_version(ctx
.obj
, ctx
.command
.name
)
3565 ctx
.obj
.wim
.delete(name
, force
, wait
=wait
)
3566 # except ClientException as e:
3571 @cli_osm.command(name
="wim-list", short_help
="list all WIM accounts")
3576 help="restricts the list to the WIM accounts matching the filter",
3579 def wim_list(ctx
, filter):
3580 """list all WIM accounts"""
3583 check_client_version(ctx
.obj
, ctx
.command
.name
)
3585 filter = "&".join(filter)
3586 resp
= ctx
.obj
.wim
.list(filter)
3587 table
= PrettyTable(["wim name", "uuid"])
3589 table
.add_row([wim
["name"], wim
["uuid"]])
3592 # except ClientException as e:
3597 @cli_osm.command(name
="wim-show", short_help
="shows the details of a WIM account")
3598 @click.argument("name")
3600 def wim_show(ctx
, name
):
3601 """shows the details of a WIM account
3603 NAME: name or ID of the WIM account
3607 check_client_version(ctx
.obj
, ctx
.command
.name
)
3608 resp
= ctx
.obj
.wim
.get(name
)
3609 if "password" in resp
:
3610 resp
["wim_password"] = "********"
3611 # except ClientException as e:
3615 table
= PrettyTable(["key", "attribute"])
3616 for k
, v
in list(resp
.items()):
3617 table
.add_row([k
, json
.dumps(v
, indent
=2)])
3622 ####################
3623 # SDN controller operations
3624 ####################
3627 @cli_osm.command(name
="sdnc-create", short_help
="creates a new SDN controller")
3628 @click.option("--name", prompt
=True, help="Name to create sdn controller")
3629 @click.option("--type", prompt
=True, help="SDN controller type")
3631 "--sdn_controller_version", # hidden=True,
3632 help="Deprecated. Use --config {version: sdn_controller_version}",
3634 @click.option("--url", help="URL in format http[s]://HOST:IP/")
3635 @click.option("--ip_address", help="Deprecated. Use --url") # hidden=True,
3636 @click.option("--port", help="Deprecated. Use --url") # hidden=True,
3638 "--switch_dpid", help="Deprecated. Use --config {switch_id: DPID}" # hidden=True,
3642 help="Extra information for SDN in yaml format, as {switch_id: identity used for the plugin (e.g. DPID: "
3643 "Openflow Datapath ID), version: version}",
3645 @click.option("--user", help="SDN controller username")
3649 confirmation_prompt
=True,
3650 help="SDN controller password",
3652 @click.option("--description", default
=None, help="human readable description")
3658 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3661 def sdnc_create(ctx
, **kwargs
):
3662 """creates a new SDN controller"""
3667 if kwargs
[x
] and x
not in ("wait", "ip_address", "port", "switch_dpid")
3669 if kwargs
.get("port"):
3670 print("option '--port' is deprecated, use '--url' instead")
3671 sdncontroller
["port"] = int(kwargs
["port"])
3672 if kwargs
.get("ip_address"):
3673 print("option '--ip_address' is deprecated, use '--url' instead")
3674 sdncontroller
["ip"] = kwargs
["ip_address"]
3675 if kwargs
.get("switch_dpid"):
3677 "option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead"
3679 sdncontroller
["dpid"] = kwargs
["switch_dpid"]
3680 if kwargs
.get("sdn_controller_version"):
3682 "option '--sdn_controller_version' is deprecated, use '--config={version: SDN_CONTROLLER_VERSION}'"
3686 check_client_version(ctx
.obj
, ctx
.command
.name
)
3687 ctx
.obj
.sdnc
.create(kwargs
["name"], sdncontroller
, wait
=kwargs
["wait"])
3688 # except ClientException as e:
3693 @cli_osm.command(name
="sdnc-update", short_help
="updates an SDN controller")
3694 @click.argument("name")
3695 @click.option("--newname", help="New name for the SDN controller")
3696 @click.option("--description", default
=None, help="human readable description")
3697 @click.option("--type", help="SDN controller type")
3698 @click.option("--url", help="URL in format http[s]://HOST:IP/")
3701 help="Extra information for SDN in yaml format, as "
3702 "{switch_id: identity used for the plugin (e.g. DPID: "
3703 "Openflow Datapath ID), version: version}",
3705 @click.option("--user", help="SDN controller username")
3706 @click.option("--password", help="SDN controller password")
3707 @click.option("--ip_address", help="Deprecated. Use --url") # hidden=True
3708 @click.option("--port", help="Deprecated. Use --url") # hidden=True
3710 "--switch_dpid", help="Deprecated. Use --config {switch_dpid: DPID}"
3713 "--sdn_controller_version", help="Deprecated. Use --config {version: VERSION}"
3720 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3723 def sdnc_update(ctx
, **kwargs
):
3724 """updates an SDN controller
3726 NAME: name or ID of the SDN controller
3733 and x
not in ("wait", "ip_address", "port", "switch_dpid", "new_name")
3735 if kwargs
.get("newname"):
3736 sdncontroller
["name"] = kwargs
["newname"]
3737 if kwargs
.get("port"):
3738 print("option '--port' is deprecated, use '--url' instead")
3739 sdncontroller
["port"] = int(kwargs
["port"])
3740 if kwargs
.get("ip_address"):
3741 print("option '--ip_address' is deprecated, use '--url' instead")
3742 sdncontroller
["ip"] = kwargs
["ip_address"]
3743 if kwargs
.get("switch_dpid"):
3745 "option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead"
3747 sdncontroller
["dpid"] = kwargs
["switch_dpid"]
3748 if kwargs
.get("sdn_controller_version"):
3750 "option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'"
3755 check_client_version(ctx
.obj
, ctx
.command
.name
)
3756 ctx
.obj
.sdnc
.update(kwargs
["name"], sdncontroller
, wait
=kwargs
["wait"])
3757 # except ClientException as e:
3762 @cli_osm.command(name
="sdnc-delete", short_help
="deletes an SDN controller")
3763 @click.argument("name")
3765 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3772 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3775 def sdnc_delete(ctx
, name
, force
, wait
):
3776 """deletes an SDN controller
3778 NAME: name or ID of the SDN controller to be deleted
3782 check_client_version(ctx
.obj
, ctx
.command
.name
)
3783 ctx
.obj
.sdnc
.delete(name
, force
, wait
=wait
)
3784 # except ClientException as e:
3789 @cli_osm.command(name
="sdnc-list", short_help
="list all SDN controllers")
3794 help="restricts the list to the SDN controllers matching the filter with format: 'k[.k..]=v[&k[.k]=v2]'",
3797 def sdnc_list(ctx
, filter):
3798 """list all SDN controllers"""
3801 check_client_version(ctx
.obj
, ctx
.command
.name
)
3803 filter = "&".join(filter)
3804 resp
= ctx
.obj
.sdnc
.list(filter)
3805 # except ClientException as e:
3808 table
= PrettyTable(["sdnc name", "id"])
3810 table
.add_row([sdnc
["name"], sdnc
["_id"]])
3815 @cli_osm.command(name
="sdnc-show", short_help
="shows the details of an SDN controller")
3816 @click.argument("name")
3818 def sdnc_show(ctx
, name
):
3819 """shows the details of an SDN controller
3821 NAME: name or ID of the SDN controller
3825 check_client_version(ctx
.obj
, ctx
.command
.name
)
3826 resp
= ctx
.obj
.sdnc
.get(name
)
3827 # except ClientException as e:
3831 table
= PrettyTable(["key", "attribute"])
3832 for k
, v
in list(resp
.items()):
3833 table
.add_row([k
, json
.dumps(v
, indent
=2)])
3838 ###########################
3839 # K8s cluster operations
3840 ###########################
3843 @cli_osm.command(name
="k8scluster-add", short_help
="adds a K8s cluster to OSM")
3844 @click.argument("name")
3846 "--creds", prompt
=True, help="credentials file, i.e. a valid `.kube/config` file"
3848 @click.option("--version", prompt
=True, help="Kubernetes version")
3850 "--vim", prompt
=True, help="VIM target, the VIM where the cluster resides"
3855 help='''list of VIM networks, in JSON inline format, where the cluster is
3856 accessible via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"''',
3858 @click.option("--description", default
=None, help="human readable description")
3861 default
="kube-system",
3862 help="namespace to be used for its operation, defaults to `kube-system`",
3869 help="do not return the control immediately, but keep it "
3870 "until the operation is completed, or timeout",
3875 help="list of CNI plugins, in JSON inline format, used in the cluster",
3877 # @click.option('--skip-init',
3879 # help='If set, K8s cluster is assumed to be ready for its use with OSM')
3880 # @click.option('--wait',
3882 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
3885 ctx
, name
, creds
, version
, vim
, k8s_nets
, description
, namespace
, wait
, cni
3887 """adds a K8s cluster to OSM
3889 NAME: name of the K8s cluster
3892 check_client_version(ctx
.obj
, ctx
.command
.name
)
3894 cluster
["name"] = name
3895 with
open(creds
, "r") as cf
:
3896 cluster
["credentials"] = yaml
.safe_load(cf
.read())
3897 cluster
["k8s_version"] = version
3898 cluster
["vim_account"] = vim
3899 cluster
["nets"] = yaml
.safe_load(k8s_nets
)
3901 cluster
["description"] = description
3903 cluster
["namespace"] = namespace
3905 cluster
["cni"] = yaml
.safe_load(cni
)
3906 ctx
.obj
.k8scluster
.create(name
, cluster
, wait
)
3907 # except ClientException as e:
3912 @cli_osm.command(name
="k8scluster-update", short_help
="updates a K8s cluster")
3913 @click.argument("name")
3914 @click.option("--newname", help="New name for the K8s cluster")
3915 @click.option("--creds", help="credentials file, i.e. a valid `.kube/config` file")
3916 @click.option("--version", help="Kubernetes version")
3917 @click.option("--vim", help="VIM target, the VIM where the cluster resides")
3920 help='''list of VIM networks, in JSON inline format, where the cluster is accessible
3921 via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"''',
3923 @click.option("--description", help="human readable description")
3926 help="namespace to be used for its operation, defaults to `kube-system`",
3933 help="do not return the control immediately, but keep it "
3934 "until the operation is completed, or timeout",
3937 "--cni", help="list of CNI plugins, in JSON inline format, used in the cluster"
3940 def k8scluster_update(
3941 ctx
, name
, newname
, creds
, version
, vim
, k8s_nets
, description
, namespace
, wait
, cni
3943 """updates a K8s cluster
3945 NAME: name or ID of the K8s cluster
3948 check_client_version(ctx
.obj
, ctx
.command
.name
)
3951 cluster
["name"] = newname
3953 with
open(creds
, "r") as cf
:
3954 cluster
["credentials"] = yaml
.safe_load(cf
.read())
3956 cluster
["k8s_version"] = version
3958 cluster
["vim_account"] = vim
3960 cluster
["nets"] = yaml
.safe_load(k8s_nets
)
3962 cluster
["description"] = description
3964 cluster
["namespace"] = namespace
3966 cluster
["cni"] = yaml
.safe_load(cni
)
3967 ctx
.obj
.k8scluster
.update(name
, cluster
, wait
)
3968 # except ClientException as e:
3973 @cli_osm.command(name
="k8scluster-delete", short_help
="deletes a K8s cluster")
3974 @click.argument("name")
3976 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
3983 help="do not return the control immediately, but keep it "
3984 "until the operation is completed, or timeout",
3987 def k8scluster_delete(ctx
, name
, force
, wait
):
3988 """deletes a K8s cluster
3990 NAME: name or ID of the K8s cluster to be deleted
3993 check_client_version(ctx
.obj
, ctx
.command
.name
)
3994 ctx
.obj
.k8scluster
.delete(name
, force
, wait
)
3995 # except ClientException as e:
4000 @cli_osm.command(name
="k8scluster-list")
4005 help="restricts the list to the K8s clusters matching the filter",
4007 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4008 @click.option("--long", is_flag
=True, help="get more details")
4010 def k8scluster_list(ctx
, filter, literal
, long):
4011 """list all K8s clusters"""
4013 check_client_version(ctx
.obj
, ctx
.command
.name
)
4015 filter = "&".join(filter)
4016 resp
= ctx
.obj
.k8scluster
.list(filter)
4018 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4021 table
= PrettyTable(
4029 "Operational State",
4030 "Op. state (details)",
4035 project_list
= ctx
.obj
.project
.list()
4037 table
= PrettyTable(
4038 ["Name", "Id", "VIM", "Operational State", "Op. state details"]
4041 vim_list
= ctx
.obj
.vim
.list()
4044 for cluster
in resp
:
4045 logger
.debug("Cluster details: {}".format(yaml
.safe_dump(cluster
)))
4046 vim_name
= get_vim_name(vim_list
, cluster
["vim_account"])
4047 # vim_info = '{} ({})'.format(vim_name,cluster['vim_account'])
4049 op_state_details
= "Helm: {}\nJuju: {}".format(
4050 cluster
["_admin"].get("helm-chart", {}).get("operationalState", "-"),
4051 cluster
["_admin"].get("juju-bundle", {}).get("operationalState", "-"),
4054 project_id
, project_name
= get_project(project_list
, cluster
)
4055 # project_info = '{} ({})'.format(project_name, project_id)
4056 project_info
= project_name
4057 detailed_status
= cluster
["_admin"].get("detailed-status", "-")
4063 cluster
["k8s_version"],
4065 json
.dumps(cluster
["nets"]),
4066 cluster
["_admin"]["operationalState"],
4068 trunc_text(cluster
.get("description") or "", 40),
4069 wrap_text(text
=detailed_status
, width
=40),
4078 cluster
["_admin"]["operationalState"],
4084 # except ClientException as e:
4090 name
="k8scluster-show", short_help
="shows the details of a K8s cluster"
4092 @click.argument("name")
4093 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4095 def k8scluster_show(ctx
, name
, literal
):
4096 """shows the details of a K8s cluster
4098 NAME: name or ID of the K8s cluster
4101 resp
= ctx
.obj
.k8scluster
.get(name
)
4103 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4105 table
= PrettyTable(["key", "attribute"])
4106 for k
, v
in list(resp
.items()):
4107 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
4110 # except ClientException as e:
4115 ###########################
4117 ###########################
4120 @cli_osm.command(name
="vca-add", short_help
="adds a VCA (Juju controller) to OSM")
4121 @click.argument("name")
4125 help="Comma-separated list of IP or hostnames of the Juju controller",
4127 @click.option("--user", prompt
=True, help="Username with admin priviledges")
4128 @click.option("--secret", prompt
=True, help="Password of the specified username")
4129 @click.option("--cacert", prompt
=True, help="CA certificate")
4133 help="Name of the cloud that will be used for LXD containers (LXD proxy charms)",
4136 "--lxd-credentials",
4138 help="Name of the cloud credentialsto be used for the LXD cloud",
4143 help="Name of the cloud that will be used for K8s containers (K8s proxy charms)",
4146 "--k8s-credentials",
4148 help="Name of the cloud credentialsto be used for the K8s cloud",
4153 help="Configuration options for the models",
4155 @click.option("--description", default
=None, help="human readable description")
4171 """adds a VCA to OSM
4173 NAME: name of the VCA
4175 check_client_version(ctx
.obj
, ctx
.command
.name
)
4178 vca
["endpoints"] = endpoints
.split(",")
4180 vca
["secret"] = secret
4181 vca
["cacert"] = cacert
4182 vca
["lxd-cloud"] = lxd_cloud
4183 vca
["lxd-credentials"] = lxd_credentials
4184 vca
["k8s-cloud"] = k8s_cloud
4185 vca
["k8s-credentials"] = k8s_credentials
4187 vca
["description"] = description
4189 model_config
= load(model_config
)
4190 vca
["model-config"] = model_config
4191 ctx
.obj
.vca
.create(name
, vca
)
4194 def load(data
: Any
):
4195 if os
.path
.isfile(data
):
4196 return load_file(data
)
4199 return json
.loads(data
)
4200 except ValueError as e
:
4201 raise ClientException(e
)
4204 def load_file(file_path
: str) -> Dict
:
4206 with
open(file_path
, "r") as f
:
4209 return yaml
.safe_load(content
)
4210 except yaml
.scanner
.ScannerError
:
4213 return json
.loads(content
)
4216 raise ClientException(f
"{file_path} must be a valid yaml or json file")
4219 @cli_osm.command(name
="vca-update", short_help
="updates a K8s cluster")
4220 @click.argument("name")
4222 "--endpoints", help="Comma-separated list of IP or hostnames of the Juju controller"
4224 @click.option("--user", help="Username with admin priviledges")
4225 @click.option("--secret", help="Password of the specified username")
4226 @click.option("--cacert", help="CA certificate")
4229 help="Name of the cloud that will be used for LXD containers (LXD proxy charms)",
4232 "--lxd-credentials",
4233 help="Name of the cloud credentialsto be used for the LXD cloud",
4237 help="Name of the cloud that will be used for K8s containers (K8s proxy charms)",
4240 "--k8s-credentials",
4241 help="Name of the cloud credentialsto be used for the K8s cloud",
4245 help="Configuration options for the models",
4247 @click.option("--description", default
=None, help="human readable description")
4263 """updates a K8s cluster
4265 NAME: name or ID of the K8s cluster
4267 check_client_version(ctx
.obj
, ctx
.command
.name
)
4271 vca
["endpoints"] = endpoints
.split(",")
4275 vca
["secret"] = secret
4277 vca
["cacert"] = cacert
4279 vca
["lxd-cloud"] = lxd_cloud
4281 vca
["lxd-credentials"] = lxd_credentials
4283 vca
["k8s-cloud"] = k8s_cloud
4285 vca
["k8s-credentials"] = k8s_credentials
4287 vca
["description"] = description
4289 model_config
= load(model_config
)
4290 vca
["model-config"] = model_config
4291 ctx
.obj
.vca
.update(name
, vca
)
4294 @cli_osm.command(name
="vca-delete", short_help
="deletes a K8s cluster")
4295 @click.argument("name")
4297 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
4300 def vca_delete(ctx
, name
, force
):
4301 """deletes a K8s cluster
4303 NAME: name or ID of the K8s cluster to be deleted
4305 check_client_version(ctx
.obj
, ctx
.command
.name
)
4306 ctx
.obj
.vca
.delete(name
, force
=force
)
4309 @cli_osm.command(name
="vca-list")
4314 help="restricts the list to the VCAs matching the filter",
4316 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4317 @click.option("--long", is_flag
=True, help="get more details")
4319 def vca_list(ctx
, filter, literal
, long):
4321 check_client_version(ctx
.obj
, ctx
.command
.name
)
4323 filter = "&".join(filter)
4324 resp
= ctx
.obj
.vca
.list(filter)
4326 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4329 table
= PrettyTable(
4330 ["Name", "Id", "Project", "Operational State", "Detailed Status"]
4332 project_list
= ctx
.obj
.project
.list()
4334 table
= PrettyTable(["Name", "Id", "Operational State"])
4336 logger
.debug("VCA details: {}".format(yaml
.safe_dump(vca
)))
4338 project_id
, project_name
= get_project(project_list
, vca
)
4339 detailed_status
= vca
.get("_admin", {}).get("detailed-status", "-")
4345 vca
.get("_admin", {}).get("operationalState", "-"),
4346 wrap_text(text
=detailed_status
, width
=40),
4354 vca
.get("_admin", {}).get("operationalState", "-"),
4361 @cli_osm.command(name
="vca-show", short_help
="shows the details of a K8s cluster")
4362 @click.argument("name")
4363 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4365 def vca_show(ctx
, name
, literal
):
4366 """shows the details of a K8s cluster
4368 NAME: name or ID of the K8s cluster
4371 resp
= ctx
.obj
.vca
.get(name
)
4373 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4375 table
= PrettyTable(["key", "attribute"])
4376 for k
, v
in list(resp
.items()):
4377 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
4382 ###########################
4384 ###########################
4387 @cli_osm.command(name
="repo-add", short_help
="adds a repo to OSM")
4388 @click.argument("name")
4389 @click.argument("uri")
4392 type=click
.Choice(["helm-chart", "juju-bundle", "osm"]),
4394 help="type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles, osm for OSM Repositories)",
4396 @click.option("--description", default
=None, help="human readable description")
4398 "--user", default
=None, help="OSM repository: The username of the OSM repository"
4403 help="OSM repository: The password of the OSM repository",
4405 # @click.option('--wait',
4407 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4409 def repo_add(ctx
, **kwargs
):
4410 """adds a repo to OSM
4412 NAME: name of the repo
4413 URI: URI of the repo
4416 kwargs
= {k
: v
for k
, v
in kwargs
.items() if v
is not None}
4418 repo
["url"] = repo
.pop("uri")
4419 if repo
["type"] in ["helm-chart", "juju-bundle"]:
4420 ctx
.obj
.repo
.create(repo
["name"], repo
)
4422 ctx
.obj
.osmrepo
.create(repo
["name"], repo
)
4423 # except ClientException as e:
4428 @cli_osm.command(name
="repo-update", short_help
="updates a repo in OSM")
4429 @click.argument("name")
4430 @click.option("--newname", help="New name for the repo")
4431 @click.option("--uri", help="URI of the repo")
4432 @click.option("--description", help="human readable description")
4433 # @click.option('--wait',
4435 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4437 def repo_update(ctx
, name
, newname
, uri
, description
):
4438 """updates a repo in OSM
4440 NAME: name of the repo
4443 check_client_version(ctx
.obj
, ctx
.command
.name
)
4446 repo
["name"] = newname
4450 repo
["description"] = description
4452 ctx
.obj
.repo
.update(name
, repo
)
4454 ctx
.obj
.osmrepo
.update(name
, repo
)
4456 # except ClientException as e:
4462 name
="repo-index", short_help
="Index a repository from a folder with artifacts"
4465 "--origin", default
=".", help="origin path where the artifacts are located"
4468 "--destination", default
=".", help="destination path where the index is deployed"
4471 def repo_index(ctx
, origin
, destination
):
4472 """Index a repository
4474 NAME: name or ID of the repo to be deleted
4476 check_client_version(ctx
.obj
, ctx
.command
.name
)
4477 ctx
.obj
.osmrepo
.repo_index(origin
, destination
)
4480 @cli_osm.command(name
="repo-delete", short_help
="deletes a repo")
4481 @click.argument("name")
4483 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
4485 # @click.option('--wait',
4487 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4489 def repo_delete(ctx
, name
, force
):
4492 NAME: name or ID of the repo to be deleted
4496 ctx
.obj
.repo
.delete(name
, force
=force
)
4498 ctx
.obj
.osmrepo
.delete(name
, force
=force
)
4499 # except ClientException as e:
4504 @cli_osm.command(name
="repo-list")
4509 help="restricts the list to the repos matching the filter",
4511 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4513 def repo_list(ctx
, filter, literal
):
4514 """list all repos"""
4517 check_client_version(ctx
.obj
, ctx
.command
.name
)
4519 filter = "&".join(filter)
4520 resp
= ctx
.obj
.repo
.list(filter)
4521 resp
+= ctx
.obj
.osmrepo
.list(filter)
4523 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4525 table
= PrettyTable(["Name", "Id", "Type", "URI", "Description"])
4527 # cluster['k8s-nets'] = json.dumps(yaml.safe_load(cluster['k8s-nets']))
4534 trunc_text(repo
.get("description") or "", 40),
4540 # except ClientException as e:
4545 @cli_osm.command(name
="repo-show", short_help
="shows the details of a repo")
4546 @click.argument("name")
4547 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4549 def repo_show(ctx
, name
, literal
):
4550 """shows the details of a repo
4552 NAME: name or ID of the repo
4555 resp
= ctx
.obj
.repo
.get(name
)
4557 resp
= ctx
.obj
.osmrepo
.get(name
)
4561 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4563 table
= PrettyTable(["key", "attribute"])
4565 for k
, v
in list(resp
.items()):
4566 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4570 # except ClientException as e:
4575 ####################
4576 # Project mgmt operations
4577 ####################
4580 @cli_osm.command(name
="project-create", short_help
="creates a new project")
4581 @click.argument("name")
4582 # @click.option('--description',
4583 # default='no description',
4584 # help='human readable description')
4585 @click.option("--domain-name", "domain_name", default
=None, help="assign to a domain")
4591 help="provide quotas. Can be used several times: 'quota1=number[,quota2=number,...]'. Quotas can be one "
4592 "of vnfds, nsds, nsts, pdus, nsrs, nsis, vim_accounts, wim_accounts, sdns, k8sclusters, k8srepos",
4595 def project_create(ctx
, name
, domain_name
, quotas
):
4596 """Creates a new project
4598 NAME: name of the project
4599 DOMAIN_NAME: optional domain name for the project when keystone authentication is used
4600 QUOTAS: set quotas for the project
4603 project
= {"name": name
}
4605 project
["domain_name"] = domain_name
4606 quotas_dict
= _process_project_quotas(quotas
)
4608 project
["quotas"] = quotas_dict
4611 check_client_version(ctx
.obj
, ctx
.command
.name
)
4612 ctx
.obj
.project
.create(name
, project
)
4613 # except ClientException as e:
4618 def _process_project_quotas(quota_list
):
4623 for quota
in quota_list
:
4624 for single_quota
in quota
.split(","):
4625 k
, v
= single_quota
.split("=")
4626 quotas_dict
[k
] = None if v
in ("None", "null", "") else int(v
)
4627 except (ValueError, TypeError):
4628 raise ClientException(
4629 "invalid format for 'quotas'. Use 'k1=v1,v1=v2'. v must be a integer or null"
4634 @cli_osm.command(name
="project-delete", short_help
="deletes a project")
4635 @click.argument("name")
4636 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
4638 def project_delete(ctx
, name
):
4639 """deletes a project
4641 NAME: name or ID of the project to be deleted
4645 check_client_version(ctx
.obj
, ctx
.command
.name
)
4646 ctx
.obj
.project
.delete(name
)
4647 # except ClientException as e:
4652 @cli_osm.command(name
="project-list", short_help
="list all projects")
4657 help="restricts the list to the projects matching the filter",
4660 def project_list(ctx
, filter):
4661 """list all projects"""
4664 check_client_version(ctx
.obj
, ctx
.command
.name
)
4666 filter = "&".join(filter)
4667 resp
= ctx
.obj
.project
.list(filter)
4668 # except ClientException as e:
4671 table
= PrettyTable(["name", "id"])
4673 table
.add_row([proj
["name"], proj
["_id"]])
4678 @cli_osm.command(name
="project-show", short_help
="shows the details of a project")
4679 @click.argument("name")
4681 def project_show(ctx
, name
):
4682 """shows the details of a project
4684 NAME: name or ID of the project
4688 check_client_version(ctx
.obj
, ctx
.command
.name
)
4689 resp
= ctx
.obj
.project
.get(name
)
4690 # except ClientException as e:
4694 table
= PrettyTable(["key", "attribute"])
4695 for k
, v
in resp
.items():
4696 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4702 name
="project-update", short_help
="updates a project (only the name can be updated)"
4704 @click.argument("project")
4705 @click.option("--name", default
=None, help="new name for the project")
4711 help="change quotas. Can be used several times: 'quota1=number|empty[,quota2=...]' "
4712 "(use empty to reset quota to default",
4715 def project_update(ctx
, project
, name
, quotas
):
4717 Update a project name
4720 :param project: id or name of the project to modify
4721 :param name: new name for the project
4722 :param quotas: change quotas of the project
4726 project_changes
= {}
4728 project_changes
["name"] = name
4729 quotas_dict
= _process_project_quotas(quotas
)
4731 project_changes
["quotas"] = quotas_dict
4734 check_client_version(ctx
.obj
, ctx
.command
.name
)
4735 ctx
.obj
.project
.update(project
, project_changes
)
4736 # except ClientException as e:
4740 ####################
4741 # User mgmt operations
4742 ####################
4745 @cli_osm.command(name
="user-create", short_help
="creates a new user")
4746 @click.argument("username")
4751 confirmation_prompt
=True,
4752 help="user password",
4756 # prompt="Comma separate list of projects",
4758 callback
=lambda ctx
, param
, value
: "".join(value
).split(",")
4759 if all(len(x
) == 1 for x
in value
)
4761 help="list of project ids that the user belongs to",
4764 "--project-role-mappings",
4765 "project_role_mappings",
4768 help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4770 @click.option("--domain-name", "domain_name", default
=None, help="assign to a domain")
4772 def user_create(ctx
, username
, password
, projects
, project_role_mappings
, domain_name
):
4773 """Creates a new user
4776 USERNAME: name of the user
4777 PASSWORD: password of the user
4778 PROJECTS: projects assigned to user (internal only)
4779 PROJECT_ROLE_MAPPING: roles in projects assigned to user (keystone)
4780 DOMAIN_NAME: optional domain name for the user when keystone authentication is used
4784 user
["username"] = username
4785 user
["password"] = password
4786 user
["projects"] = projects
4787 user
["project_role_mappings"] = project_role_mappings
4789 user
["domain_name"] = domain_name
4792 check_client_version(ctx
.obj
, ctx
.command
.name
)
4793 ctx
.obj
.user
.create(username
, user
)
4794 # except ClientException as e:
4799 @cli_osm.command(name
="user-update", short_help
="updates user information")
4800 @click.argument("username")
4805 # confirmation_prompt=True,
4806 help="user password",
4808 @click.option("--set-username", "set_username", default
=None, help="change username")
4814 help="create/replace the roles for this project: 'project,role1[,role2,...]'",
4821 help="removes project from user: 'project'",
4824 "--add-project-role",
4828 help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4831 "--remove-project-role",
4832 "remove_project_role",
4835 help="remove role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4846 remove_project_role
,
4848 """Update a user information
4851 USERNAME: name of the user
4852 PASSWORD: new password
4853 SET_USERNAME: new username
4854 SET_PROJECT: creating mappings for project/role(s)
4855 REMOVE_PROJECT: deleting mappings for project/role(s)
4856 ADD_PROJECT_ROLE: adding mappings for project/role(s)
4857 REMOVE_PROJECT_ROLE: removing mappings for project/role(s)
4861 user
["password"] = password
4862 user
["username"] = set_username
4863 user
["set-project"] = set_project
4864 user
["remove-project"] = remove_project
4865 user
["add-project-role"] = add_project_role
4866 user
["remove-project-role"] = remove_project_role
4869 check_client_version(ctx
.obj
, ctx
.command
.name
)
4870 ctx
.obj
.user
.update(username
, user
)
4871 # except ClientException as e:
4876 @cli_osm.command(name
="user-delete", short_help
="deletes a user")
4877 @click.argument("name")
4878 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
4880 def user_delete(ctx
, name
):
4884 NAME: name or ID of the user to be deleted
4888 check_client_version(ctx
.obj
, ctx
.command
.name
)
4889 ctx
.obj
.user
.delete(name
)
4890 # except ClientException as e:
4895 @cli_osm.command(name
="user-list", short_help
="list all users")
4900 help="restricts the list to the users matching the filter",
4903 def user_list(ctx
, filter):
4904 """list all users"""
4906 check_client_version(ctx
.obj
, ctx
.command
.name
)
4908 filter = "&".join(filter)
4909 resp
= ctx
.obj
.user
.list(filter)
4910 # except ClientException as e:
4913 table
= PrettyTable(["name", "id"])
4915 table
.add_row([user
["username"], user
["_id"]])
4920 @cli_osm.command(name
="user-show", short_help
="shows the details of a user")
4921 @click.argument("name")
4923 def user_show(ctx
, name
):
4924 """shows the details of a user
4926 NAME: name or ID of the user
4930 check_client_version(ctx
.obj
, ctx
.command
.name
)
4931 resp
= ctx
.obj
.user
.get(name
)
4932 if "password" in resp
:
4933 resp
["password"] = "********"
4934 # except ClientException as e:
4938 table
= PrettyTable(["key", "attribute"])
4939 for k
, v
in resp
.items():
4940 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4945 ####################
4946 # Fault Management operations
4947 ####################
4950 @cli_osm.command(name
="ns-alarm-create")
4951 @click.argument("name")
4952 @click.option("--ns", prompt
=True, help="NS instance id or name")
4954 "--vnf", prompt
=True, help="VNF name (VNF member index as declared in the NSD)"
4956 @click.option("--vdu", prompt
=True, help="VDU name (VDU name as declared in the VNFD)")
4957 @click.option("--metric", prompt
=True, help="Name of the metric (e.g. cpu_utilization)")
4961 help="severity of the alarm (WARNING, MINOR, MAJOR, CRITICAL, INDETERMINATE)",
4964 "--threshold_value",
4966 help="threshold value that, when crossed, an alarm is triggered",
4969 "--threshold_operator",
4971 help="threshold operator describing the comparison (GE, LE, GT, LT, EQ)",
4976 help="statistic (AVERAGE, MINIMUM, MAXIMUM, COUNT, SUM)",
4979 def ns_alarm_create(
4991 """creates a new alarm for a NS instance"""
4992 # TODO: Check how to validate threshold_value.
4993 # Should it be an integer (1-100), percentage, or decimal (0.01-1.00)?
4996 ns_instance
= ctx
.obj
.ns
.get(ns
)
4998 alarm
["alarm_name"] = name
4999 alarm
["ns_id"] = ns_instance
["_id"]
5000 alarm
["correlation_id"] = ns_instance
["_id"]
5001 alarm
["vnf_member_index"] = vnf
5002 alarm
["vdu_name"] = vdu
5003 alarm
["metric_name"] = metric
5004 alarm
["severity"] = severity
5005 alarm
["threshold_value"] = int(threshold_value
)
5006 alarm
["operation"] = threshold_operator
5007 alarm
["statistic"] = statistic
5008 check_client_version(ctx
.obj
, ctx
.command
.name
)
5009 ctx
.obj
.ns
.create_alarm(alarm
)
5010 # except ClientException as e:
5015 # @cli_osm.command(name='ns-alarm-delete')
5016 # @click.argument('name')
5017 # @click.pass_context
5018 # def ns_alarm_delete(ctx, name):
5019 # """deletes an alarm
5021 # NAME: name of the alarm to be deleted
5024 # check_client_version(ctx.obj, ctx.command.name)
5025 # ctx.obj.ns.delete_alarm(name)
5026 # except ClientException as e:
5031 ####################
5032 # Performance Management operations
5033 ####################
5037 name
="ns-metric-export",
5038 short_help
="exports a metric to the internal OSM bus, which can be read by other apps",
5040 @click.option("--ns", prompt
=True, help="NS instance id or name")
5042 "--vnf", prompt
=True, help="VNF name (VNF member index as declared in the NSD)"
5044 @click.option("--vdu", prompt
=True, help="VDU name (VDU name as declared in the VNFD)")
5045 @click.option("--metric", prompt
=True, help="name of the metric (e.g. cpu_utilization)")
5046 # @click.option('--period', default='1w',
5047 # help='metric collection period (e.g. 20s, 30m, 2h, 3d, 1w)')
5049 "--interval", help="periodic interval (seconds) to export metrics continuously"
5052 def ns_metric_export(ctx
, ns
, vnf
, vdu
, metric
, interval
):
5053 """exports a metric to the internal OSM bus, which can be read by other apps"""
5054 # TODO: Check how to validate interval.
5055 # Should it be an integer (seconds), or should a suffix (s,m,h,d,w) also be permitted?
5058 ns_instance
= ctx
.obj
.ns
.get(ns
)
5060 metric_data
["ns_id"] = ns_instance
["_id"]
5061 metric_data
["correlation_id"] = ns_instance
["_id"]
5062 metric_data
["vnf_member_index"] = vnf
5063 metric_data
["vdu_name"] = vdu
5064 metric_data
["metric_name"] = metric
5065 metric_data
["collection_unit"] = "WEEK"
5066 metric_data
["collection_period"] = 1
5067 check_client_version(ctx
.obj
, ctx
.command
.name
)
5069 print("{}".format(ctx
.obj
.ns
.export_metric(metric_data
)))
5073 print("{} {}".format(ctx
.obj
.ns
.export_metric(metric_data
), i
))
5074 time
.sleep(int(interval
))
5076 # except ClientException as e:
5082 # Subscription operations
5087 name
="subscription-create",
5088 short_help
="creates a new subscription to a specific event",
5092 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5093 type=click
.Choice(["ns"], case_sensitive
=False),
5094 help="event type to be subscribed (for the moment, only ns is supported)",
5096 @click.option("--event", default
=None, help="specific yaml configuration for the event")
5098 "--event_file", default
=None, help="specific yaml configuration file for the event"
5101 def subscription_create(ctx
, event_type
, event
, event_file
):
5102 """creates a new subscription to a specific event"""
5104 check_client_version(ctx
.obj
, ctx
.command
.name
)
5107 raise ClientException(
5108 '"--event" option is incompatible with "--event_file" option'
5110 with
open(event_file
, "r") as cf
:
5112 ctx
.obj
.subscription
.create(event_type
, event
)
5115 @cli_osm.command(name
="subscription-delete", short_help
="deletes a subscription")
5118 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5119 type=click
.Choice(["ns"], case_sensitive
=False),
5120 help="event type to be subscribed (for the moment, only ns is supported)",
5122 @click.argument("subscription_id")
5124 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
5127 def subscription_delete(ctx
, event_type
, subscription_id
, force
):
5128 """deletes a subscription
5130 SUBSCRIPTION_ID: ID of the subscription to be deleted
5133 check_client_version(ctx
.obj
, ctx
.command
.name
)
5134 ctx
.obj
.subscription
.delete(event_type
, subscription_id
, force
)
5137 @cli_osm.command(name
="subscription-list", short_help
="list all subscriptions")
5140 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5141 type=click
.Choice(["ns"], case_sensitive
=False),
5142 help="event type to be subscribed (for the moment, only ns is supported)",
5148 help="restricts the list to the subscriptions matching the filter",
5151 def subscription_list(ctx
, event_type
, filter):
5152 """list all subscriptions"""
5154 check_client_version(ctx
.obj
, ctx
.command
.name
)
5156 filter = "&".join(filter)
5157 resp
= ctx
.obj
.subscription
.list(event_type
, filter)
5158 table
= PrettyTable(["id", "filter", "CallbackUri"])
5163 wrap_text(text
=json
.dumps(sub
["filter"], indent
=2), width
=70),
5172 name
="subscription-show", short_help
="shows the details of a subscription"
5174 @click.argument("subscription_id")
5177 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5178 type=click
.Choice(["ns"], case_sensitive
=False),
5179 help="event type to be subscribed (for the moment, only ns is supported)",
5184 help="restricts the information to the fields in the filter",
5187 def subscription_show(ctx
, event_type
, subscription_id
, filter):
5188 """shows the details of a subscription
5190 SUBSCRIPTION_ID: ID of the subscription
5194 resp
= ctx
.obj
.subscription
.get(subscription_id
)
5195 table
= PrettyTable(["key", "attribute"])
5196 for k
, v
in list(resp
.items()):
5197 if not filter or k
in filter:
5198 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
5203 ####################
5205 ####################
5208 @cli_osm.command(name
="version", short_help
="shows client and server versions")
5210 def get_version(ctx
):
5211 """shows client and server versions"""
5213 check_client_version(ctx
.obj
, "version")
5214 print("Server version: {}".format(ctx
.obj
.get_version()))
5216 "Client version: {}".format(pkg_resources
.get_distribution("osmclient").version
)
5218 # except ClientException as e:
5224 name
="upload-package", short_help
="uploads a VNF package or NS package"
5226 @click.argument("filename")
5228 "--skip-charm-build",
5231 help="the charm will not be compiled, it is assumed to already exist",
5234 def upload_package(ctx
, filename
, skip_charm_build
):
5235 """uploads a vnf package or ns package
5237 filename: vnf or ns package folder, or vnf or ns package file (tar.gz)
5241 ctx
.obj
.package
.upload(filename
, skip_charm_build
=skip_charm_build
)
5242 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
5243 if fullclassname
!= "osmclient.sol005.client.Client":
5244 ctx
.obj
.package
.wait_for_upload(filename
)
5245 # except ClientException as e:
5250 # @cli_osm.command(name='ns-scaling-show')
5251 # @click.argument('ns_name')
5252 # @click.pass_context
5253 # def show_ns_scaling(ctx, ns_name):
5254 # """shows the status of a NS scaling operation
5256 # NS_NAME: name of the NS instance being scaled
5259 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5260 # resp = ctx.obj.ns.list()
5261 # except ClientException as e:
5265 # table = PrettyTable(
5268 # 'operational status',
5273 # if ns_name == ns['name']:
5274 # nsopdata = ctx.obj.ns.get_opdata(ns['id'])
5275 # scaling_records = nsopdata['nsr:nsr']['scaling-group-record']
5276 # for record in scaling_records:
5277 # if 'instance' in record:
5278 # instances = record['instance']
5279 # for inst in instances:
5281 # [record['scaling-group-name-ref'],
5282 # inst['instance-id'],
5283 # inst['op-status'],
5284 # time.strftime('%Y-%m-%d %H:%M:%S',
5286 # inst['create-time'])),
5292 # @cli_osm.command(name='ns-scale')
5293 # @click.argument('ns_name')
5294 # @click.option('--ns_scale_group', prompt=True)
5295 # @click.option('--index', prompt=True)
5296 # @click.option('--wait',
5300 # help='do not return the control immediately, but keep it \
5301 # until the operation is completed, or timeout')
5302 # @click.pass_context
5303 # def ns_scale(ctx, ns_name, ns_scale_group, index, wait):
5306 # NS_NAME: name of the NS instance to be scaled
5309 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5310 # ctx.obj.ns.scale(ns_name, ns_scale_group, index, wait=wait)
5311 # except ClientException as e:
5316 # @cli_osm.command(name='config-agent-list')
5317 # @click.pass_context
5318 # def config_agent_list(ctx):
5319 # """list config agents"""
5321 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5322 # except ClientException as e:
5325 # table = PrettyTable(['name', 'account-type', 'details'])
5326 # for account in ctx.obj.vca.list():
5329 # account['account-type'],
5335 # @cli_osm.command(name='config-agent-delete')
5336 # @click.argument('name')
5337 # @click.pass_context
5338 # def config_agent_delete(ctx, name):
5339 # """deletes a config agent
5341 # NAME: name of the config agent to be deleted
5344 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5345 # ctx.obj.vca.delete(name)
5346 # except ClientException as e:
5351 # @cli_osm.command(name='config-agent-add')
5352 # @click.option('--name',
5354 # @click.option('--account_type',
5356 # @click.option('--server',
5358 # @click.option('--user',
5360 # @click.option('--secret',
5363 # confirmation_prompt=True)
5364 # @click.pass_context
5365 # def config_agent_add(ctx, name, account_type, server, user, secret):
5366 # """adds a config agent"""
5368 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5369 # ctx.obj.vca.create(name, account_type, server, user, secret)
5370 # except ClientException as e:
5375 # @cli_osm.command(name='ro-dump')
5376 # @click.pass_context
5378 # """shows RO agent information"""
5379 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5380 # resp = ctx.obj.vim.get_resource_orchestrator()
5381 # table = PrettyTable(['key', 'attribute'])
5382 # for k, v in list(resp.items()):
5383 # table.add_row([k, json.dumps(v, indent=2)])
5388 # @cli_osm.command(name='vcs-list')
5389 # @click.pass_context
5390 # def vcs_list(ctx):
5391 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5392 # resp = ctx.obj.utils.get_vcs_info()
5393 # table = PrettyTable(['component name', 'state'])
5394 # for component in resp:
5395 # table.add_row([component['component_name'], component['state']])
5401 name
="ns-action", short_help
="executes an action/primitive over a NS instance"
5403 @click.argument("ns_name")
5407 help="member-vnf-index if the target is a vnf instead of a ns)",
5409 @click.option("--kdu_name", default
=None, help="kdu-name if the target is a kdu)")
5410 @click.option("--vdu_id", default
=None, help="vdu-id if the target is a vdu")
5412 "--vdu_count", default
=None, type=int, help="number of vdu instance of this vdu_id"
5414 @click.option("--action_name", prompt
=True, help="action name")
5415 @click.option("--params", default
=None, help="action params in YAML/JSON inline string")
5416 @click.option("--params_file", default
=None, help="YAML/JSON file with action params")
5418 "--timeout", required
=False, default
=None, type=int, help="timeout in seconds"
5425 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5441 """executes an action/primitive over a NS instance
5443 NS_NAME: name or ID of the NS instance
5447 check_client_version(ctx
.obj
, ctx
.command
.name
)
5450 op_data
["member_vnf_index"] = vnf_name
5452 op_data
["kdu_name"] = kdu_name
5454 op_data
["vdu_id"] = vdu_id
5455 if vdu_count
is not None:
5456 op_data
["vdu_count_index"] = vdu_count
5458 op_data
["timeout_ns_action"] = timeout
5459 op_data
["primitive"] = action_name
5461 with
open(params_file
, "r") as pf
:
5464 op_data
["primitive_params"] = yaml
.safe_load(params
)
5466 op_data
["primitive_params"] = {}
5467 print(ctx
.obj
.ns
.exec_op(ns_name
, op_name
="action", op_data
=op_data
, wait
=wait
))
5469 # except ClientException as e:
5475 name
="vnf-scale", short_help
="executes a VNF scale (adding/removing VDUs)"
5477 @click.argument("ns_name")
5478 @click.argument("vnf_name")
5480 "--scaling-group", prompt
=True, help="scaling-group-descriptor name to use"
5483 "--scale-in", default
=False, is_flag
=True, help="performs a scale in operation"
5489 help="performs a scale out operation (by default)",
5492 "--timeout", required
=False, default
=None, type=int, help="timeout in seconds"
5499 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5503 ctx
, ns_name
, vnf_name
, scaling_group
, scale_in
, scale_out
, timeout
, wait
5506 Executes a VNF scale (adding/removing VDUs)
5509 NS_NAME: name or ID of the NS instance.
5510 VNF_NAME: member-vnf-index in the NS to be scaled.
5514 check_client_version(ctx
.obj
, ctx
.command
.name
)
5515 if not scale_in
and not scale_out
:
5517 ctx
.obj
.ns
.scale_vnf(
5518 ns_name
, vnf_name
, scaling_group
, scale_in
, scale_out
, wait
, timeout
5520 # except ClientException as e:
5525 @cli_osm.command(name
="alarm-show", short_help
="show alarm details")
5526 @click.argument("uuid")
5528 def alarm_show(ctx
, uuid
):
5529 """Show alarm's detail information"""
5531 check_client_version(ctx
.obj
, ctx
.command
.name
)
5532 resp
= ctx
.obj
.ns
.get_alarm(uuid
=uuid
)
5546 table
= PrettyTable(["key", "attribute"])
5548 # Arrange and return the response data
5549 resp
= resp
.replace("ObjectId", "")
5551 for key
in alarm_filter
:
5553 value
= alarm
.get(key
)
5556 value
= alarm
.get(key
)
5558 elif key
== "ns-id":
5559 value
= alarm
["tags"].get("ns_id")
5560 elif key
== "vdu_name":
5561 value
= alarm
["tags"].get("vdu_name")
5562 elif key
== "status":
5563 value
= alarm
["alarm_status"]
5566 table
.add_row([key
, wrap_text(text
=json
.dumps(value
, indent
=2), width
=100)])
5574 @cli_osm.command(name
="alarm-list", short_help
="list all alarms")
5576 "--ns_id", default
=None, required
=False, help="List out alarm for given ns id"
5579 def alarm_list(ctx
, ns_id
):
5580 """list all alarm"""
5582 check_client_version(ctx
.obj
, ctx
.command
.name
)
5583 project_name
= os
.getenv("OSM_PROJECT", "admin")
5584 resp
= ctx
.obj
.ns
.get_alarm(project_name
=project_name
, ns_id
=ns_id
)
5586 table
= PrettyTable(
5587 ["alarm-id", "metric", "threshold", "operation", "action", "status"]
5590 # return the response data in a table
5591 resp
= resp
.replace("ObjectId", "")
5596 wrap_text(text
=str(alarm
["uuid"]), width
=38),
5600 wrap_text(text
=alarm
["action"], width
=25),
5601 alarm
["alarm_status"],
5609 @cli_osm.command(name
="alarm-update", short_help
="Update a alarm")
5610 @click.argument("uuid")
5611 @click.option("--threshold", default
=None, help="Alarm threshold")
5612 @click.option("--is_enable", default
=None, type=bool, help="enable or disable alarm")
5614 def alarm_update(ctx
, uuid
, threshold
, is_enable
):
5619 if not threshold
and is_enable
is None:
5620 raise ClientException(
5621 "Please provide option to update i.e threshold or is_enable"
5623 ctx
.obj
.ns
.update_alarm(uuid
, threshold
, is_enable
)
5626 ##############################
5627 # Role Management Operations #
5628 ##############################
5631 @cli_osm.command(name
="role-create", short_help
="creates a new role")
5632 @click.argument("name")
5633 @click.option("--permissions", default
=None, help="role permissions using a dictionary")
5635 def role_create(ctx
, name
, permissions
):
5640 NAME: Name or ID of the role.
5641 DEFINITION: Definition of grant/denial of access to resources.
5645 check_client_version(ctx
.obj
, ctx
.command
.name
)
5646 ctx
.obj
.role
.create(name
, permissions
)
5647 # except ClientException as e:
5652 @cli_osm.command(name
="role-update", short_help
="updates a role")
5653 @click.argument("name")
5654 @click.option("--set-name", default
=None, help="change name of rle")
5655 # @click.option('--permissions',
5657 # help='provide a yaml format dictionary with incremental changes. Values can be bool or None to delete')
5661 help="yaml format dictionary with permission: True/False to access grant/denial",
5663 @click.option("--remove", default
=None, help="yaml format list to remove a permission")
5665 def role_update(ctx
, name
, set_name
, add
, remove
):
5670 NAME: Name or ID of the role.
5671 DEFINITION: Definition overwrites the old definition.
5672 ADD: Grant/denial of access to resource to add.
5673 REMOVE: Grant/denial of access to resource to remove.
5677 check_client_version(ctx
.obj
, ctx
.command
.name
)
5678 ctx
.obj
.role
.update(name
, set_name
, None, add
, remove
)
5679 # except ClientException as e:
5684 @cli_osm.command(name
="role-delete", short_help
="deletes a role")
5685 @click.argument("name")
5686 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
5688 def role_delete(ctx
, name
):
5693 NAME: Name or ID of the role.
5697 check_client_version(ctx
.obj
, ctx
.command
.name
)
5698 ctx
.obj
.role
.delete(name
)
5699 # except ClientException as e:
5704 @cli_osm.command(name
="role-list", short_help
="list all roles")
5709 help="restricts the list to the projects matching the filter",
5712 def role_list(ctx
, filter):
5718 check_client_version(ctx
.obj
, ctx
.command
.name
)
5720 filter = "&".join(filter)
5721 resp
= ctx
.obj
.role
.list(filter)
5722 # except ClientException as e:
5725 table
= PrettyTable(["name", "id"])
5727 table
.add_row([role
["name"], role
["_id"]])
5732 @cli_osm.command(name
="role-show", short_help
="show specific role")
5733 @click.argument("name")
5735 def role_show(ctx
, name
):
5737 Shows the details of a role.
5740 NAME: Name or ID of the role.
5744 check_client_version(ctx
.obj
, ctx
.command
.name
)
5745 resp
= ctx
.obj
.role
.get(name
)
5746 # except ClientException as e:
5750 table
= PrettyTable(["key", "attribute"])
5751 for k
, v
in resp
.items():
5752 table
.add_row([k
, json
.dumps(v
, indent
=2)])
5757 @cli_osm.command(name
="package-create", short_help
="Create empty NS package structure")
5758 @click.argument("package-type")
5759 @click.argument("package-name")
5763 help=('(NS/VNF/NST) Set the location for package creation. Default: "."'),
5767 default
="image-name",
5768 help='(VNF) Set the name of the vdu image. Default "image-name"',
5771 "--vdus", default
=1, help="(VNF) Set the number of vdus in a VNF. Default 1"
5774 "--vcpu", default
=1, help="(VNF) Set the number of virtual CPUs in a vdu. Default 1"
5779 help="(VNF) Set the memory size (MB) of the vdu. Default 1024",
5782 "--storage", default
=10, help="(VNF) Set the disk size (GB) of the vdu. Default 10"
5787 help="(VNF) Set the number of additional interfaces apart from the management interface. Default 0",
5790 "--vendor", default
="OSM", help='(NS/VNF) Set the descriptor vendor. Default "OSM"'
5796 help="(NS/VNF/NST) Flag for overriding the package if exists.",
5802 help="(NS/VNF/NST) Flag for generating descriptor .yaml with all possible commented options",
5805 "--netslice-subnets", default
=1, help="(NST) Number of netslice subnets. Default 1"
5808 "--netslice-vlds", default
=1, help="(NST) Number of netslice vlds. Default 1"
5811 "--old", default
=False, is_flag
=True, help="Flag to create a descriptor using the previous OSM format (pre SOL006, OSM<9)"
5833 Creates an OSM NS, VNF, NST package
5836 PACKAGE_TYPE: Package to be created: NS, VNF or NST.
5837 PACKAGE_NAME: Name of the package to create the folder with the content.
5842 check_client_version(ctx
.obj
, ctx
.command
.name
)
5844 "Creating the {} structure: {}/{}".format(
5845 package_type
.upper(), base_directory
, package_name
5848 resp
= ctx
.obj
.package_tool
.create(
5858 interfaces
=interfaces
,
5861 netslice_subnets
=netslice_subnets
,
5862 netslice_vlds
=netslice_vlds
,
5866 # except ClientException as inst:
5867 # print("ERROR: {}".format(inst))
5872 name
="package-validate", short_help
="Validate descriptors given a base directory"
5874 @click.argument("base-directory", default
=".", required
=False)
5876 "--recursive/--no-recursive",
5878 help="The activated recursive option will validate the yaml files"
5879 " within the indicated directory and in its subdirectories",
5885 help="Validates also the descriptors using the previous OSM format (pre SOL006)",
5888 def package_validate(ctx
, base_directory
, recursive
, old
):
5890 Validate descriptors given a base directory.
5893 BASE_DIRECTORY: Base folder for NS, VNF or NST package.
5897 check_client_version(ctx
.obj
, ctx
.command
.name
)
5898 results
= ctx
.obj
.package_tool
.validate(base_directory
, recursive
, old
)
5899 table
= PrettyTable()
5900 table
.field_names
= ["TYPE", "PATH", "VALID", "ERROR"]
5901 # Print the dictionary generated by the validation function
5902 for result
in results
:
5904 [result
["type"], result
["path"], result
["valid"], result
["error"]]
5906 table
.sortby
= "VALID"
5907 table
.align
["PATH"] = "l"
5908 table
.align
["TYPE"] = "l"
5909 table
.align
["ERROR"] = "l"
5911 # except ClientException as inst:
5912 # print("ERROR: {}".format(inst))
5917 name
="package-translate", short_help
="Translate descriptors given a base directory"
5919 @click.argument("base-directory", default
=".", required
=False)
5921 "--recursive/--no-recursive",
5923 help="The activated recursive option will translate the yaml files"
5924 " within the indicated directory and in its subdirectories",
5930 help="Do not translate yet, only make a dry-run to test translation",
5933 def package_translate(ctx
, base_directory
, recursive
, dryrun
):
5935 Translate descriptors given a base directory.
5938 BASE_DIRECTORY: Stub folder for NS, VNF or NST package.
5941 check_client_version(ctx
.obj
, ctx
.command
.name
)
5942 results
= ctx
.obj
.package_tool
.translate(base_directory
, recursive
, dryrun
)
5943 table
= PrettyTable()
5944 table
.field_names
= [
5952 # Print the dictionary generated by the validation function
5953 for result
in results
:
5956 result
["current type"],
5960 result
["translated"],
5964 table
.sortby
= "TRANSLATED"
5965 table
.align
["PATH"] = "l"
5966 table
.align
["TYPE"] = "l"
5967 table
.align
["ERROR"] = "l"
5969 # except ClientException as inst:
5970 # print("ERROR: {}".format(inst))
5974 @cli_osm.command(name
="package-build", short_help
="Build the tar.gz of the package")
5975 @click.argument("package-folder")
5977 "--skip-validation", default
=False, is_flag
=True, help="skip package validation"
5980 "--skip-charm-build",
5983 help="the charm will not be compiled, it is assumed to already exist",
5986 def package_build(ctx
, package_folder
, skip_validation
, skip_charm_build
):
5988 Build the package NS, VNF given the package_folder.
5991 PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged
5995 check_client_version(ctx
.obj
, ctx
.command
.name
)
5996 results
= ctx
.obj
.package_tool
.build(
5998 skip_validation
=skip_validation
,
5999 skip_charm_build
=skip_charm_build
,
6002 # except ClientException as inst:
6003 # print("ERROR: {}".format(inst))
6008 name
="descriptor-translate",
6009 short_help
="Translate input descriptor file from Rel EIGHT OSM descriptors to SOL006 and prints in standard output",
6011 @click.argument("descriptor-file", required
=True)
6013 def descriptor_translate(ctx
, descriptor_file
):
6015 Translate input descriptor.
6018 DESCRIPTOR_FILE: Descriptor file for NS, VNF or Network Slice.
6021 check_client_version(ctx
.obj
, ctx
.command
.name
)
6022 result
= ctx
.obj
.package_tool
.descriptor_translate(descriptor_file
)
6030 except pycurl
.error
as exc
:
6033 'Maybe "--hostname" option or OSM_HOSTNAME environment variable needs to be specified'
6035 except ClientException
as exc
:
6036 print("ERROR: {}".format(exc
))
6037 except (FileNotFoundError
, PermissionError
) as exc
:
6038 print("Cannot open file: {}".format(exc
))
6039 except yaml
.YAMLError
as exc
:
6040 print("Invalid YAML format: {}".format(exc
))
6042 # TODO capture other controlled exceptions here
6043 # TODO remove the ClientException captures from all places, unless they do something different
6046 if __name__
== "__main__":