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(
2607 name
, pdu_type
, interface
, description
, vim_account
, descriptor_file
2609 ctx
.obj
.pdu
.create(pdu
)
2612 ########################
2613 # UPDATE PDU operation #
2614 ########################
2618 name
="pdu-update", short_help
="updates a Physical Deployment Unit to the catalog"
2620 @click.argument("name")
2621 @click.option("--newname", help="New name for the Physical Deployment Unit")
2622 @click.option("--pdu_type", help="type of PDU (e.g. router, firewall, FW001)")
2625 help="interface(s) of the PDU: name=<NAME>,mgmt=<true|false>,ip-address=<IP_ADDRESS>"
2626 + "[,type=<overlay|underlay>][,mac-address=<MAC_ADDRESS>][,vim-network-name=<VIM_NET_NAME>]",
2629 @click.option("--description", help="human readable description")
2632 help="list of VIM accounts (in the same VIM) that can reach this PDU\n"
2633 + "The format for multiple VIMs is --vim_account <vim_account_id_1> "
2634 + "--vim_account <vim_account_id_2> ... --vim_account <vim_account_id_N>",
2638 "--descriptor_file",
2640 help="PDU descriptor file (as an alternative to using the other arguments)",
2644 ctx
, name
, newname
, pdu_type
, interface
, description
, vim_account
, descriptor_file
2646 """Updates a new Physical Deployment Unit (PDU)"""
2649 check_client_version(ctx
.obj
, ctx
.command
.name
)
2656 pdu
= create_pdu_dictionary(
2657 newname
, pdu_type
, interface
, description
, vim_account
, descriptor_file
, update
2659 ctx
.obj
.pdu
.update(name
, pdu
)
2662 def create_pdu_dictionary(
2663 name
, pdu_type
, interface
, description
, vim_account
, descriptor_file
, update
=False
2669 if not descriptor_file
:
2672 raise ClientException(
2673 'in absence of descriptor file, option "--name" is mandatory'
2676 raise ClientException(
2677 'in absence of descriptor file, option "--pdu_type" is mandatory'
2680 raise ClientException(
2681 'in absence of descriptor file, option "--interface" is mandatory (at least once)'
2684 raise ClientException(
2685 'in absence of descriptor file, option "--vim_account" is mandatory (at least once)'
2688 with
open(descriptor_file
, "r") as df
:
2689 pdu
= yaml
.safe_load(df
.read())
2693 pdu
["type"] = pdu_type
2695 pdu
["description"] = description
2697 pdu
["vim_accounts"] = vim_account
2700 for iface
in interface
:
2701 new_iface
= {k
: v
for k
, v
in [i
.split("=") for i
in iface
.split(",")]}
2702 new_iface
["mgmt"] = new_iface
.get("mgmt", "false").lower() == "true"
2703 ifaces_list
.append(new_iface
)
2704 pdu
["interfaces"] = ifaces_list
2708 ####################
2710 ####################
2713 def nsd_update(ctx
, name
, content
):
2716 check_client_version(ctx
.obj
, ctx
.command
.name
)
2717 ctx
.obj
.nsd
.update(name
, content
)
2718 # except ClientException as e:
2723 @cli_osm.command(name
="nsd-update", short_help
="updates a NSD/NSpkg")
2724 @click.argument("name")
2728 help="filename with the NSD/NSpkg replacing the current one",
2731 def nsd_update1(ctx
, name
, content
):
2732 """updates a NSD/NSpkg
2734 NAME: name or ID of the NSD/NSpkg
2737 nsd_update(ctx
, name
, content
)
2740 @cli_osm.command(name
="nspkg-update", short_help
="updates a NSD/NSpkg")
2741 @click.argument("name")
2745 help="filename with the NSD/NSpkg replacing the current one",
2748 def nsd_update2(ctx
, name
, content
):
2749 """updates a NSD/NSpkg
2751 NAME: name or ID of the NSD/NSpkg
2754 nsd_update(ctx
, name
, content
)
2757 def vnfd_update(ctx
, name
, content
):
2760 check_client_version(ctx
.obj
, ctx
.command
.name
)
2761 ctx
.obj
.vnfd
.update(name
, content
)
2762 # except ClientException as e:
2767 @cli_osm.command(name
="vnfd-update", short_help
="updates a new VNFD/VNFpkg")
2768 @click.argument("name")
2772 help="filename with the VNFD/VNFpkg replacing the current one",
2775 def vnfd_update1(ctx
, name
, content
):
2776 """updates a VNFD/VNFpkg
2778 NAME: name or ID of the VNFD/VNFpkg
2781 vnfd_update(ctx
, name
, content
)
2784 @cli_osm.command(name
="vnfpkg-update", short_help
="updates a VNFD/VNFpkg")
2785 @click.argument("name")
2789 help="filename with the VNFD/VNFpkg replacing the current one",
2792 def vnfd_update2(ctx
, name
, content
):
2793 """updates a VNFD/VNFpkg
2795 NAME: VNFD yaml file or VNFpkg tar.gz file
2798 vnfd_update(ctx
, name
, content
)
2801 @cli_osm.command(name
="nfpkg-update", short_help
="updates a NFpkg")
2802 @click.argument("name")
2804 "--content", default
=None, help="filename with the NFpkg replacing the current one"
2807 def nfpkg_update(ctx
, name
, content
):
2810 NAME: NF Descriptor yaml file or NFpkg tar.gz file
2813 vnfd_update(ctx
, name
, content
)
2816 def nst_update(ctx
, name
, content
):
2819 check_client_version(ctx
.obj
, ctx
.command
.name
)
2820 ctx
.obj
.nst
.update(name
, content
)
2821 # except ClientException as e:
2826 @cli_osm.command(name
="nst-update", short_help
="updates a Network Slice Template (NST)")
2827 @click.argument("name")
2831 help="filename with the NST/NSTpkg replacing the current one",
2834 def nst_update1(ctx
, name
, content
):
2835 """updates a Network Slice Template (NST)
2837 NAME: name or ID of the NSD/NSpkg
2840 nst_update(ctx
, name
, content
)
2844 name
="netslice-template-update", short_help
="updates a Network Slice Template (NST)"
2846 @click.argument("name")
2850 help="filename with the NST/NSTpkg replacing the current one",
2853 def nst_update2(ctx
, name
, content
):
2854 """updates a Network Slice Template (NST)
2856 NAME: name or ID of the NSD/NSpkg
2859 nst_update(ctx
, name
, content
)
2862 ####################
2864 ####################
2867 def nsd_delete(ctx
, name
, force
):
2871 ctx
.obj
.nsd
.delete(name
)
2873 check_client_version(ctx
.obj
, "--force")
2874 ctx
.obj
.nsd
.delete(name
, force
)
2875 # except ClientException as e:
2880 @cli_osm.command(name
="nsd-delete", short_help
="deletes a NSD/NSpkg")
2881 @click.argument("name")
2883 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2886 def nsd_delete1(ctx
, name
, force
):
2887 """deletes a NSD/NSpkg
2889 NAME: name or ID of the NSD/NSpkg to be deleted
2892 nsd_delete(ctx
, name
, force
)
2895 @cli_osm.command(name
="nspkg-delete", short_help
="deletes a NSD/NSpkg")
2896 @click.argument("name")
2898 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2901 def nsd_delete2(ctx
, name
, force
):
2902 """deletes a NSD/NSpkg
2904 NAME: name or ID of the NSD/NSpkg to be deleted
2907 nsd_delete(ctx
, name
, force
)
2910 def vnfd_delete(ctx
, name
, force
):
2914 ctx
.obj
.vnfd
.delete(name
)
2916 check_client_version(ctx
.obj
, "--force")
2917 ctx
.obj
.vnfd
.delete(name
, force
)
2918 # except ClientException as e:
2923 @cli_osm.command(name
="vnfd-delete", short_help
="deletes a VNFD/VNFpkg")
2924 @click.argument("name")
2926 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2929 def vnfd_delete1(ctx
, name
, force
):
2930 """deletes a VNFD/VNFpkg
2932 NAME: name or ID of the VNFD/VNFpkg to be deleted
2935 vnfd_delete(ctx
, name
, force
)
2938 @cli_osm.command(name
="vnfpkg-delete", short_help
="deletes a VNFD/VNFpkg")
2939 @click.argument("name")
2941 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2944 def vnfd_delete2(ctx
, name
, force
):
2945 """deletes a VNFD/VNFpkg
2947 NAME: name or ID of the VNFD/VNFpkg to be deleted
2950 vnfd_delete(ctx
, name
, force
)
2953 @cli_osm.command(name
="nfpkg-delete", short_help
="deletes a NFpkg")
2954 @click.argument("name")
2956 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2959 def nfpkg_delete(ctx
, name
, force
):
2962 NAME: name or ID of the NFpkg to be deleted
2965 vnfd_delete(ctx
, name
, force
)
2968 @cli_osm.command(name
="ns-delete", short_help
="deletes a NS instance")
2969 @click.argument("name")
2971 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2976 help="specific yaml configuration for the termination, e.g. '{autoremove: False, timeout_ns_terminate: "
2977 "600, skip_terminate_primitives: True}'",
2984 help="do not return the control immediately, but keep it "
2985 "until the operation is completed, or timeout",
2988 def ns_delete(ctx
, name
, force
, config
, wait
):
2989 """deletes a NS instance
2991 NAME: name or ID of the NS instance to be deleted
2996 ctx
.obj
.ns
.delete(name
, config
=config
, wait
=wait
)
2998 check_client_version(ctx
.obj
, "--force")
2999 ctx
.obj
.ns
.delete(name
, force
, config
=config
, wait
=wait
)
3000 # except ClientException as e:
3005 def nst_delete(ctx
, name
, force
):
3008 check_client_version(ctx
.obj
, ctx
.command
.name
)
3009 ctx
.obj
.nst
.delete(name
, force
)
3010 # except ClientException as e:
3015 @cli_osm.command(name
="nst-delete", short_help
="deletes a Network Slice Template (NST)")
3016 @click.argument("name")
3018 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3021 def nst_delete1(ctx
, name
, force
):
3022 """deletes a Network Slice Template (NST)
3024 NAME: name or ID of the NST/NSTpkg to be deleted
3027 nst_delete(ctx
, name
, force
)
3031 name
="netslice-template-delete", short_help
="deletes a Network Slice Template (NST)"
3033 @click.argument("name")
3035 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3038 def nst_delete2(ctx
, name
, force
):
3039 """deletes a Network Slice Template (NST)
3041 NAME: name or ID of the NST/NSTpkg to be deleted
3044 nst_delete(ctx
, name
, force
)
3047 def nsi_delete(ctx
, name
, force
, wait
):
3050 check_client_version(ctx
.obj
, ctx
.command
.name
)
3051 ctx
.obj
.nsi
.delete(name
, force
, wait
=wait
)
3052 # except ClientException as e:
3057 @cli_osm.command(name
="nsi-delete", short_help
="deletes a Network Slice Instance (NSI)")
3058 @click.argument("name")
3060 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3067 help="do not return the control immediately, but keep it "
3068 "until the operation is completed, or timeout",
3071 def nsi_delete1(ctx
, name
, force
, wait
):
3072 """deletes a Network Slice Instance (NSI)
3074 NAME: name or ID of the Network Slice instance to be deleted
3077 nsi_delete(ctx
, name
, force
, wait
=wait
)
3081 name
="netslice-instance-delete", short_help
="deletes a Network Slice Instance (NSI)"
3083 @click.argument("name")
3085 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3088 def nsi_delete2(ctx
, name
, force
, wait
):
3089 """deletes a Network Slice Instance (NSI)
3091 NAME: name or ID of the Network Slice instance to be deleted
3094 nsi_delete(ctx
, name
, force
, wait
=wait
)
3098 name
="pdu-delete", short_help
="deletes a Physical Deployment Unit (PDU)"
3100 @click.argument("name")
3102 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3105 def pdu_delete(ctx
, name
, force
):
3106 """deletes a Physical Deployment Unit (PDU)
3108 NAME: name or ID of the PDU to be deleted
3112 check_client_version(ctx
.obj
, ctx
.command
.name
)
3113 ctx
.obj
.pdu
.delete(name
, force
)
3114 # except ClientException as e:
3124 @cli_osm.command(name
="vim-create", short_help
="creates a new VIM account")
3125 @click.option("--name", required
=True, help="Name to create datacenter")
3126 @click.option("--user", default
=None, help="VIM username")
3127 @click.option("--password", default
=None, help="VIM password")
3128 @click.option("--auth_url", default
=None, help="VIM url")
3129 @click.option("--tenant", "--project", "tenant", default
=None, help="VIM tenant/project name")
3130 @click.option("--config", default
=None, help="VIM specific config parameters")
3131 @click.option("--config_file", default
=None, help="VIM specific config parameters in YAML or JSON file")
3132 @click.option("--account_type", default
="openstack", help="VIM type")
3133 @click.option("--description", default
=None, help="human readable description")
3137 help="Name or id of the SDN controller associated to this VIM account",
3140 "--sdn_port_mapping",
3142 help="File describing the port mapping between compute nodes' ports and switch ports",
3149 help="do not return the control immediately, but keep it "
3150 "until the operation is completed, or timeout",
3152 @click.option("--vca", default
=None, help="VCA to be used in this VIM account")
3153 @click.option("--creds", default
=None, help="credentials file (only applycable for GCP VIM type)")
3172 """creates a new VIM account"""
3176 check_client_version(ctx
.obj
, "--sdn_controller")
3177 if sdn_port_mapping
:
3178 check_client_version(ctx
.obj
, "--sdn_port_mapping")
3180 vim
["vim-username"] = user
3181 vim
["vim-password"] = password
3182 vim
["vim-url"] = auth_url
3183 vim
["vim-tenant-name"] = tenant
3184 vim
["vim-type"] = account_type
3185 vim
["description"] = description
3188 vim_config
= create_config(config_file
, config
)
3190 with
open(creds
, "r") as cf
:
3191 vim_config
["credentials"] = yaml
.safe_load(cf
.read())
3192 ctx
.obj
.vim
.create(name
, vim
, vim_config
, sdn_controller
, sdn_port_mapping
, wait
=wait
)
3193 # except ClientException as e:
3198 @cli_osm.command(name
="vim-update", short_help
="updates a VIM account")
3199 @click.argument("name")
3200 @click.option("--newname", help="New name for the VIM account")
3201 @click.option("--user", help="VIM username")
3202 @click.option("--password", help="VIM password")
3203 @click.option("--auth_url", help="VIM url")
3204 @click.option("--tenant", help="VIM tenant name")
3205 @click.option("--config", help="VIM specific config parameters")
3206 @click.option("--config_file", default
=None, help="VIM specific config parameters in YAML or JSON file")
3207 @click.option("--account_type", help="VIM type")
3208 @click.option("--description", help="human readable description")
3212 help="Name or id of the SDN controller to be associated with this VIM"
3213 "account. Use empty string to disassociate",
3216 "--sdn_port_mapping",
3218 help="File describing the port mapping between compute nodes' ports and switch ports",
3225 help="do not return the control immediately, but keep it "
3226 "until the operation is completed, or timeout",
3228 @click.option("--creds", default
=None, help="credentials file (only applycable for GCP VIM type)")
3247 """updates a VIM account
3249 NAME: name or ID of the VIM account
3253 check_client_version(ctx
.obj
, ctx
.command
.name
)
3256 vim
["name"] = newname
3258 vim
["vim_user"] = user
3260 vim
["vim_password"] = password
3262 vim
["vim_url"] = auth_url
3264 vim
["vim-tenant-name"] = tenant
3266 vim
["vim_type"] = account_type
3268 vim
["description"] = description
3270 if config
or config_file
:
3271 vim_config
= create_config(config_file
, config
)
3273 with
open(creds
, "r") as cf
:
3274 vim_config
["credentials"] = yaml
.safe_load(cf
.read())
3275 logger
.info(f
"VIM: {vim}, VIM config: {vim_config}")
3276 ctx
.obj
.vim
.update(name
, vim
, vim_config
, sdn_controller
, sdn_port_mapping
, wait
=wait
)
3277 # except ClientException as e:
3282 @cli_osm.command(name
="vim-delete", short_help
="deletes a VIM account")
3283 @click.argument("name")
3285 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3292 help="do not return the control immediately, but keep it "
3293 "until the operation is completed, or timeout",
3296 def vim_delete(ctx
, name
, force
, wait
):
3297 """deletes a VIM account
3299 NAME: name or ID of the VIM account to be deleted
3304 ctx
.obj
.vim
.delete(name
, wait
=wait
)
3306 check_client_version(ctx
.obj
, "--force")
3307 ctx
.obj
.vim
.delete(name
, force
, wait
=wait
)
3308 # except ClientException as e:
3313 @cli_osm.command(name
="vim-list", short_help
="list all VIM accounts")
3314 # @click.option('--ro_update/--no_ro_update',
3316 # help='update list from RO')
3321 help="restricts the list to the VIM accounts matching the filter",
3326 help="get more details of the NS (project, vim, deployment status, configuration status.",
3329 def vim_list(ctx
, filter, long):
3330 """list all VIM accounts"""
3333 filter = "&".join(filter)
3334 check_client_version(ctx
.obj
, "--filter")
3336 # check_client_version(ctx.obj, '--ro_update', 'v1')
3337 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
3338 if fullclassname
== "osmclient.sol005.client.Client":
3339 resp
= ctx
.obj
.vim
.list(filter)
3341 # resp = ctx.obj.vim.list(ro_update)
3343 table
= PrettyTable(
3344 ["vim name", "uuid", "project", "operational state", "error details"]
3346 project_list
= ctx
.obj
.project
.list()
3348 table
= PrettyTable(["vim name", "uuid", "operational state"])
3351 if "vim_password" in vim
:
3352 vim
["vim_password"] = "********"
3353 if "config" in vim
and "credentials" in vim
["config"]:
3354 vim
["config"]["credentials"] = "********"
3355 logger
.debug("VIM details: {}".format(yaml
.safe_dump(vim
)))
3356 vim_state
= vim
["_admin"].get("operationalState", "-")
3357 error_details
= "N/A"
3358 if vim_state
== "ERROR":
3359 error_details
= vim
["_admin"].get("detailed-status", "Not found")
3360 project_id
, project_name
= get_project(project_list
, vim
)
3361 # project_info = '{} ({})'.format(project_name, project_id)
3362 project_info
= project_name
3369 wrap_text(text
=error_details
, width
=80),
3374 [vim
["name"], vim
["uuid"], vim
["_admin"].get("operationalState", "-")]
3380 @cli_osm.command(name
="vim-show", short_help
="shows the details of a VIM account")
3381 @click.argument("name")
3385 help="restricts the information to the fields in the filter",
3387 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
3389 def vim_show(ctx
, name
, filter, literal
):
3390 """shows the details of a VIM account
3392 NAME: name or ID of the VIM account
3396 resp
= ctx
.obj
.vim
.get(name
)
3397 if "vim_password" in resp
:
3398 resp
["vim_password"] = "********"
3399 if "config" in resp
and "credentials" in resp
["config"]:
3400 resp
["config"]["credentials"] = "********"
3401 # except ClientException as e:
3406 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
3408 table
= PrettyTable(["key", "attribute"])
3409 for k
, v
in list(resp
.items()):
3410 if not filter or k
in filter:
3411 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
3416 ####################
3418 ####################
3421 @cli_osm.command(name
="wim-create", short_help
="creates a new WIM account")
3422 @click.option("--name", prompt
=True, help="Name for the WIM account")
3423 @click.option("--user", help="WIM username")
3424 @click.option("--password", help="WIM password")
3425 @click.option("--url", prompt
=True, help="WIM url")
3426 # @click.option('--tenant',
3427 # help='wIM tenant name')
3428 @click.option("--config", default
=None, help="WIM specific config parameters")
3429 @click.option("--wim_type", help="WIM type")
3430 @click.option("--description", default
=None, help="human readable description")
3432 "--wim_port_mapping",
3434 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
3435 "(WAN service endpoint id and info)",
3442 help="do not return the control immediately, but keep it "
3443 "until the operation is completed, or timeout",
3459 """creates a new WIM account"""
3462 check_client_version(ctx
.obj
, ctx
.command
.name
)
3463 # if sdn_controller:
3464 # check_client_version(ctx.obj, '--sdn_controller')
3465 # if sdn_port_mapping:
3466 # check_client_version(ctx.obj, '--sdn_port_mapping')
3471 wim
["password"] = password
3473 wim
["wim_url"] = url
3474 # if tenant: wim['tenant'] = tenant
3475 wim
["wim_type"] = wim_type
3477 wim
["description"] = description
3479 wim
["config"] = config
3480 ctx
.obj
.wim
.create(name
, wim
, wim_port_mapping
, wait
=wait
)
3481 # except ClientException as e:
3486 @cli_osm.command(name
="wim-update", short_help
="updates a WIM account")
3487 @click.argument("name")
3488 @click.option("--newname", help="New name for the WIM account")
3489 @click.option("--user", help="WIM username")
3490 @click.option("--password", help="WIM password")
3491 @click.option("--url", help="WIM url")
3492 @click.option("--config", help="WIM specific config parameters")
3493 @click.option("--wim_type", help="WIM type")
3494 @click.option("--description", help="human readable description")
3496 "--wim_port_mapping",
3498 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
3499 "(WAN service endpoint id and info)",
3506 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3522 """updates a WIM account
3524 NAME: name or ID of the WIM account
3528 check_client_version(ctx
.obj
, ctx
.command
.name
)
3531 wim
["name"] = newname
3535 wim
["password"] = password
3538 # if tenant: wim['tenant'] = tenant
3540 wim
["wim_type"] = wim_type
3542 wim
["description"] = description
3544 wim
["config"] = config
3545 ctx
.obj
.wim
.update(name
, wim
, wim_port_mapping
, wait
=wait
)
3546 # except ClientException as e:
3551 @cli_osm.command(name
="wim-delete", short_help
="deletes a WIM account")
3552 @click.argument("name")
3554 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3561 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3564 def wim_delete(ctx
, name
, force
, wait
):
3565 """deletes a WIM account
3567 NAME: name or ID of the WIM account to be deleted
3571 check_client_version(ctx
.obj
, ctx
.command
.name
)
3572 ctx
.obj
.wim
.delete(name
, force
, wait
=wait
)
3573 # except ClientException as e:
3578 @cli_osm.command(name
="wim-list", short_help
="list all WIM accounts")
3583 help="restricts the list to the WIM accounts matching the filter",
3586 def wim_list(ctx
, filter):
3587 """list all WIM accounts"""
3590 check_client_version(ctx
.obj
, ctx
.command
.name
)
3592 filter = "&".join(filter)
3593 resp
= ctx
.obj
.wim
.list(filter)
3594 table
= PrettyTable(["wim name", "uuid"])
3596 table
.add_row([wim
["name"], wim
["uuid"]])
3599 # except ClientException as e:
3604 @cli_osm.command(name
="wim-show", short_help
="shows the details of a WIM account")
3605 @click.argument("name")
3607 def wim_show(ctx
, name
):
3608 """shows the details of a WIM account
3610 NAME: name or ID of the WIM account
3614 check_client_version(ctx
.obj
, ctx
.command
.name
)
3615 resp
= ctx
.obj
.wim
.get(name
)
3616 if "password" in resp
:
3617 resp
["wim_password"] = "********"
3618 # except ClientException as e:
3622 table
= PrettyTable(["key", "attribute"])
3623 for k
, v
in list(resp
.items()):
3624 table
.add_row([k
, json
.dumps(v
, indent
=2)])
3629 ####################
3630 # SDN controller operations
3631 ####################
3634 @cli_osm.command(name
="sdnc-create", short_help
="creates a new SDN controller")
3635 @click.option("--name", prompt
=True, help="Name to create sdn controller")
3636 @click.option("--type", prompt
=True, help="SDN controller type")
3638 "--sdn_controller_version", # hidden=True,
3639 help="Deprecated. Use --config {version: sdn_controller_version}",
3641 @click.option("--url", help="URL in format http[s]://HOST:IP/")
3642 @click.option("--ip_address", help="Deprecated. Use --url") # hidden=True,
3643 @click.option("--port", help="Deprecated. Use --url") # hidden=True,
3645 "--switch_dpid", help="Deprecated. Use --config {switch_id: DPID}" # hidden=True,
3649 help="Extra information for SDN in yaml format, as {switch_id: identity used for the plugin (e.g. DPID: "
3650 "Openflow Datapath ID), version: version}",
3652 @click.option("--user", help="SDN controller username")
3656 confirmation_prompt
=True,
3657 help="SDN controller password",
3659 @click.option("--description", default
=None, help="human readable description")
3665 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3668 def sdnc_create(ctx
, **kwargs
):
3669 """creates a new SDN controller"""
3674 if kwargs
[x
] and x
not in ("wait", "ip_address", "port", "switch_dpid")
3676 if kwargs
.get("port"):
3677 print("option '--port' is deprecated, use '--url' instead")
3678 sdncontroller
["port"] = int(kwargs
["port"])
3679 if kwargs
.get("ip_address"):
3680 print("option '--ip_address' is deprecated, use '--url' instead")
3681 sdncontroller
["ip"] = kwargs
["ip_address"]
3682 if kwargs
.get("switch_dpid"):
3684 "option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead"
3686 sdncontroller
["dpid"] = kwargs
["switch_dpid"]
3687 if kwargs
.get("sdn_controller_version"):
3689 "option '--sdn_controller_version' is deprecated, use '--config={version: SDN_CONTROLLER_VERSION}'"
3693 check_client_version(ctx
.obj
, ctx
.command
.name
)
3694 ctx
.obj
.sdnc
.create(kwargs
["name"], sdncontroller
, wait
=kwargs
["wait"])
3695 # except ClientException as e:
3700 @cli_osm.command(name
="sdnc-update", short_help
="updates an SDN controller")
3701 @click.argument("name")
3702 @click.option("--newname", help="New name for the SDN controller")
3703 @click.option("--description", default
=None, help="human readable description")
3704 @click.option("--type", help="SDN controller type")
3705 @click.option("--url", help="URL in format http[s]://HOST:IP/")
3708 help="Extra information for SDN in yaml format, as "
3709 "{switch_id: identity used for the plugin (e.g. DPID: "
3710 "Openflow Datapath ID), version: version}",
3712 @click.option("--user", help="SDN controller username")
3713 @click.option("--password", help="SDN controller password")
3714 @click.option("--ip_address", help="Deprecated. Use --url") # hidden=True
3715 @click.option("--port", help="Deprecated. Use --url") # hidden=True
3717 "--switch_dpid", help="Deprecated. Use --config {switch_dpid: DPID}"
3720 "--sdn_controller_version", help="Deprecated. Use --config {version: VERSION}"
3727 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3730 def sdnc_update(ctx
, **kwargs
):
3731 """updates an SDN controller
3733 NAME: name or ID of the SDN controller
3740 and x
not in ("wait", "ip_address", "port", "switch_dpid", "new_name")
3742 if kwargs
.get("newname"):
3743 sdncontroller
["name"] = kwargs
["newname"]
3744 if kwargs
.get("port"):
3745 print("option '--port' is deprecated, use '--url' instead")
3746 sdncontroller
["port"] = int(kwargs
["port"])
3747 if kwargs
.get("ip_address"):
3748 print("option '--ip_address' is deprecated, use '--url' instead")
3749 sdncontroller
["ip"] = kwargs
["ip_address"]
3750 if kwargs
.get("switch_dpid"):
3752 "option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead"
3754 sdncontroller
["dpid"] = kwargs
["switch_dpid"]
3755 if kwargs
.get("sdn_controller_version"):
3757 "option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'"
3762 check_client_version(ctx
.obj
, ctx
.command
.name
)
3763 ctx
.obj
.sdnc
.update(kwargs
["name"], sdncontroller
, wait
=kwargs
["wait"])
3764 # except ClientException as e:
3769 @cli_osm.command(name
="sdnc-delete", short_help
="deletes an SDN controller")
3770 @click.argument("name")
3772 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3779 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3782 def sdnc_delete(ctx
, name
, force
, wait
):
3783 """deletes an SDN controller
3785 NAME: name or ID of the SDN controller to be deleted
3789 check_client_version(ctx
.obj
, ctx
.command
.name
)
3790 ctx
.obj
.sdnc
.delete(name
, force
, wait
=wait
)
3791 # except ClientException as e:
3796 @cli_osm.command(name
="sdnc-list", short_help
="list all SDN controllers")
3801 help="restricts the list to the SDN controllers matching the filter with format: 'k[.k..]=v[&k[.k]=v2]'",
3804 def sdnc_list(ctx
, filter):
3805 """list all SDN controllers"""
3808 check_client_version(ctx
.obj
, ctx
.command
.name
)
3810 filter = "&".join(filter)
3811 resp
= ctx
.obj
.sdnc
.list(filter)
3812 # except ClientException as e:
3815 table
= PrettyTable(["sdnc name", "id"])
3817 table
.add_row([sdnc
["name"], sdnc
["_id"]])
3822 @cli_osm.command(name
="sdnc-show", short_help
="shows the details of an SDN controller")
3823 @click.argument("name")
3825 def sdnc_show(ctx
, name
):
3826 """shows the details of an SDN controller
3828 NAME: name or ID of the SDN controller
3832 check_client_version(ctx
.obj
, ctx
.command
.name
)
3833 resp
= ctx
.obj
.sdnc
.get(name
)
3834 # except ClientException as e:
3838 table
= PrettyTable(["key", "attribute"])
3839 for k
, v
in list(resp
.items()):
3840 table
.add_row([k
, json
.dumps(v
, indent
=2)])
3845 ###########################
3846 # K8s cluster operations
3847 ###########################
3850 @cli_osm.command(name
="k8scluster-add", short_help
="adds a K8s cluster to OSM")
3851 @click.argument("name")
3853 "--creds", prompt
=True, help="credentials file, i.e. a valid `.kube/config` file"
3855 @click.option("--version", prompt
=True, help="Kubernetes version")
3857 "--vim", prompt
=True, help="VIM target, the VIM where the cluster resides"
3862 help='''list of VIM networks, in JSON inline format, where the cluster is
3863 accessible via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"''',
3865 @click.option("--description", default
=None, help="human readable description")
3868 default
="kube-system",
3869 help="namespace to be used for its operation, defaults to `kube-system`",
3876 help="do not return the control immediately, but keep it "
3877 "until the operation is completed, or timeout",
3882 help="list of CNI plugins, in JSON inline format, used in the cluster",
3884 # @click.option('--skip-init',
3886 # help='If set, K8s cluster is assumed to be ready for its use with OSM')
3887 # @click.option('--wait',
3889 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
3892 ctx
, name
, creds
, version
, vim
, k8s_nets
, description
, namespace
, wait
, cni
3894 """adds a K8s cluster to OSM
3896 NAME: name of the K8s cluster
3899 check_client_version(ctx
.obj
, ctx
.command
.name
)
3901 cluster
["name"] = name
3902 with
open(creds
, "r") as cf
:
3903 cluster
["credentials"] = yaml
.safe_load(cf
.read())
3904 cluster
["k8s_version"] = version
3905 cluster
["vim_account"] = vim
3906 cluster
["nets"] = yaml
.safe_load(k8s_nets
)
3908 cluster
["description"] = description
3910 cluster
["namespace"] = namespace
3912 cluster
["cni"] = yaml
.safe_load(cni
)
3913 ctx
.obj
.k8scluster
.create(name
, cluster
, wait
)
3914 # except ClientException as e:
3919 @cli_osm.command(name
="k8scluster-update", short_help
="updates a K8s cluster")
3920 @click.argument("name")
3921 @click.option("--newname", help="New name for the K8s cluster")
3922 @click.option("--creds", help="credentials file, i.e. a valid `.kube/config` file")
3923 @click.option("--version", help="Kubernetes version")
3924 @click.option("--vim", help="VIM target, the VIM where the cluster resides")
3927 help='''list of VIM networks, in JSON inline format, where the cluster is accessible
3928 via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"''',
3930 @click.option("--description", help="human readable description")
3933 help="namespace to be used for its operation, defaults to `kube-system`",
3940 help="do not return the control immediately, but keep it "
3941 "until the operation is completed, or timeout",
3944 "--cni", help="list of CNI plugins, in JSON inline format, used in the cluster"
3947 def k8scluster_update(
3948 ctx
, name
, newname
, creds
, version
, vim
, k8s_nets
, description
, namespace
, wait
, cni
3950 """updates a K8s cluster
3952 NAME: name or ID of the K8s cluster
3955 check_client_version(ctx
.obj
, ctx
.command
.name
)
3958 cluster
["name"] = newname
3960 with
open(creds
, "r") as cf
:
3961 cluster
["credentials"] = yaml
.safe_load(cf
.read())
3963 cluster
["k8s_version"] = version
3965 cluster
["vim_account"] = vim
3967 cluster
["nets"] = yaml
.safe_load(k8s_nets
)
3969 cluster
["description"] = description
3971 cluster
["namespace"] = namespace
3973 cluster
["cni"] = yaml
.safe_load(cni
)
3974 ctx
.obj
.k8scluster
.update(name
, cluster
, wait
)
3975 # except ClientException as e:
3980 @cli_osm.command(name
="k8scluster-delete", short_help
="deletes a K8s cluster")
3981 @click.argument("name")
3983 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
3990 help="do not return the control immediately, but keep it "
3991 "until the operation is completed, or timeout",
3994 def k8scluster_delete(ctx
, name
, force
, wait
):
3995 """deletes a K8s cluster
3997 NAME: name or ID of the K8s cluster to be deleted
4000 check_client_version(ctx
.obj
, ctx
.command
.name
)
4001 ctx
.obj
.k8scluster
.delete(name
, force
, wait
)
4002 # except ClientException as e:
4007 @cli_osm.command(name
="k8scluster-list")
4012 help="restricts the list to the K8s clusters matching the filter",
4014 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4015 @click.option("--long", is_flag
=True, help="get more details")
4017 def k8scluster_list(ctx
, filter, literal
, long):
4018 """list all K8s clusters"""
4020 check_client_version(ctx
.obj
, ctx
.command
.name
)
4022 filter = "&".join(filter)
4023 resp
= ctx
.obj
.k8scluster
.list(filter)
4025 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4028 table
= PrettyTable(
4036 "Operational State",
4037 "Op. state (details)",
4042 project_list
= ctx
.obj
.project
.list()
4044 table
= PrettyTable(
4045 ["Name", "Id", "VIM", "Operational State", "Op. state details"]
4048 vim_list
= ctx
.obj
.vim
.list()
4051 for cluster
in resp
:
4052 logger
.debug("Cluster details: {}".format(yaml
.safe_dump(cluster
)))
4053 vim_name
= get_vim_name(vim_list
, cluster
["vim_account"])
4054 # vim_info = '{} ({})'.format(vim_name,cluster['vim_account'])
4056 op_state_details
= "Helm: {}\nJuju: {}".format(
4057 cluster
["_admin"].get("helm-chart", {}).get("operationalState", "-"),
4058 cluster
["_admin"].get("juju-bundle", {}).get("operationalState", "-"),
4061 project_id
, project_name
= get_project(project_list
, cluster
)
4062 # project_info = '{} ({})'.format(project_name, project_id)
4063 project_info
= project_name
4064 detailed_status
= cluster
["_admin"].get("detailed-status", "-")
4070 cluster
["k8s_version"],
4072 json
.dumps(cluster
["nets"]),
4073 cluster
["_admin"]["operationalState"],
4075 trunc_text(cluster
.get("description") or "", 40),
4076 wrap_text(text
=detailed_status
, width
=40),
4085 cluster
["_admin"]["operationalState"],
4091 # except ClientException as e:
4097 name
="k8scluster-show", short_help
="shows the details of a K8s cluster"
4099 @click.argument("name")
4100 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4102 def k8scluster_show(ctx
, name
, literal
):
4103 """shows the details of a K8s cluster
4105 NAME: name or ID of the K8s cluster
4108 resp
= ctx
.obj
.k8scluster
.get(name
)
4110 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4112 table
= PrettyTable(["key", "attribute"])
4113 for k
, v
in list(resp
.items()):
4114 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
4117 # except ClientException as e:
4122 ###########################
4124 ###########################
4127 @cli_osm.command(name
="vca-add", short_help
="adds a VCA (Juju controller) to OSM")
4128 @click.argument("name")
4132 help="Comma-separated list of IP or hostnames of the Juju controller",
4134 @click.option("--user", prompt
=True, help="Username with admin priviledges")
4135 @click.option("--secret", prompt
=True, help="Password of the specified username")
4136 @click.option("--cacert", prompt
=True, help="CA certificate")
4140 help="Name of the cloud that will be used for LXD containers (LXD proxy charms)",
4143 "--lxd-credentials",
4145 help="Name of the cloud credentialsto be used for the LXD cloud",
4150 help="Name of the cloud that will be used for K8s containers (K8s proxy charms)",
4153 "--k8s-credentials",
4155 help="Name of the cloud credentialsto be used for the K8s cloud",
4160 help="Configuration options for the models",
4162 @click.option("--description", default
=None, help="human readable description")
4178 """adds a VCA to OSM
4180 NAME: name of the VCA
4182 check_client_version(ctx
.obj
, ctx
.command
.name
)
4185 vca
["endpoints"] = endpoints
.split(",")
4187 vca
["secret"] = secret
4188 vca
["cacert"] = cacert
4189 vca
["lxd-cloud"] = lxd_cloud
4190 vca
["lxd-credentials"] = lxd_credentials
4191 vca
["k8s-cloud"] = k8s_cloud
4192 vca
["k8s-credentials"] = k8s_credentials
4194 vca
["description"] = description
4196 model_config
= load(model_config
)
4197 vca
["model-config"] = model_config
4198 ctx
.obj
.vca
.create(name
, vca
)
4201 def load(data
: Any
):
4202 if os
.path
.isfile(data
):
4203 return load_file(data
)
4206 return json
.loads(data
)
4207 except ValueError as e
:
4208 raise ClientException(e
)
4211 def load_file(file_path
: str) -> Dict
:
4213 with
open(file_path
, "r") as f
:
4216 return yaml
.safe_load(content
)
4217 except yaml
.scanner
.ScannerError
:
4220 return json
.loads(content
)
4223 raise ClientException(f
"{file_path} must be a valid yaml or json file")
4226 @cli_osm.command(name
="vca-update", short_help
="updates a K8s cluster")
4227 @click.argument("name")
4229 "--endpoints", help="Comma-separated list of IP or hostnames of the Juju controller"
4231 @click.option("--user", help="Username with admin priviledges")
4232 @click.option("--secret", help="Password of the specified username")
4233 @click.option("--cacert", help="CA certificate")
4236 help="Name of the cloud that will be used for LXD containers (LXD proxy charms)",
4239 "--lxd-credentials",
4240 help="Name of the cloud credentialsto be used for the LXD cloud",
4244 help="Name of the cloud that will be used for K8s containers (K8s proxy charms)",
4247 "--k8s-credentials",
4248 help="Name of the cloud credentialsto be used for the K8s cloud",
4252 help="Configuration options for the models",
4254 @click.option("--description", default
=None, help="human readable description")
4270 """updates a K8s cluster
4272 NAME: name or ID of the K8s cluster
4274 check_client_version(ctx
.obj
, ctx
.command
.name
)
4278 vca
["endpoints"] = endpoints
.split(",")
4282 vca
["secret"] = secret
4284 vca
["cacert"] = cacert
4286 vca
["lxd-cloud"] = lxd_cloud
4288 vca
["lxd-credentials"] = lxd_credentials
4290 vca
["k8s-cloud"] = k8s_cloud
4292 vca
["k8s-credentials"] = k8s_credentials
4294 vca
["description"] = description
4296 model_config
= load(model_config
)
4297 vca
["model-config"] = model_config
4298 ctx
.obj
.vca
.update(name
, vca
)
4301 @cli_osm.command(name
="vca-delete", short_help
="deletes a K8s cluster")
4302 @click.argument("name")
4304 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
4307 def vca_delete(ctx
, name
, force
):
4308 """deletes a K8s cluster
4310 NAME: name or ID of the K8s cluster to be deleted
4312 check_client_version(ctx
.obj
, ctx
.command
.name
)
4313 ctx
.obj
.vca
.delete(name
, force
=force
)
4316 @cli_osm.command(name
="vca-list")
4321 help="restricts the list to the VCAs matching the filter",
4323 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4324 @click.option("--long", is_flag
=True, help="get more details")
4326 def vca_list(ctx
, filter, literal
, long):
4328 check_client_version(ctx
.obj
, ctx
.command
.name
)
4330 filter = "&".join(filter)
4331 resp
= ctx
.obj
.vca
.list(filter)
4333 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4336 table
= PrettyTable(
4337 ["Name", "Id", "Project", "Operational State", "Detailed Status"]
4339 project_list
= ctx
.obj
.project
.list()
4341 table
= PrettyTable(["Name", "Id", "Operational State"])
4343 logger
.debug("VCA details: {}".format(yaml
.safe_dump(vca
)))
4345 project_id
, project_name
= get_project(project_list
, vca
)
4346 detailed_status
= vca
.get("_admin", {}).get("detailed-status", "-")
4352 vca
.get("_admin", {}).get("operationalState", "-"),
4353 wrap_text(text
=detailed_status
, width
=40),
4361 vca
.get("_admin", {}).get("operationalState", "-"),
4368 @cli_osm.command(name
="vca-show", short_help
="shows the details of a K8s cluster")
4369 @click.argument("name")
4370 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4372 def vca_show(ctx
, name
, literal
):
4373 """shows the details of a K8s cluster
4375 NAME: name or ID of the K8s cluster
4378 resp
= ctx
.obj
.vca
.get(name
)
4380 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4382 table
= PrettyTable(["key", "attribute"])
4383 for k
, v
in list(resp
.items()):
4384 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
4389 ###########################
4391 ###########################
4394 @cli_osm.command(name
="repo-add", short_help
="adds a repo to OSM")
4395 @click.argument("name")
4396 @click.argument("uri")
4399 type=click
.Choice(["helm-chart", "juju-bundle", "osm"]),
4401 help="type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles, osm for OSM Repositories)",
4403 @click.option("--description", default
=None, help="human readable description")
4405 "--user", default
=None, help="OSM repository: The username of the OSM repository"
4410 help="OSM repository: The password of the OSM repository",
4412 # @click.option('--wait',
4414 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4416 def repo_add(ctx
, **kwargs
):
4417 """adds a repo to OSM
4419 NAME: name of the repo
4420 URI: URI of the repo
4423 kwargs
= {k
: v
for k
, v
in kwargs
.items() if v
is not None}
4425 repo
["url"] = repo
.pop("uri")
4426 if repo
["type"] in ["helm-chart", "juju-bundle"]:
4427 ctx
.obj
.repo
.create(repo
["name"], repo
)
4429 ctx
.obj
.osmrepo
.create(repo
["name"], repo
)
4430 # except ClientException as e:
4435 @cli_osm.command(name
="repo-update", short_help
="updates a repo in OSM")
4436 @click.argument("name")
4437 @click.option("--newname", help="New name for the repo")
4438 @click.option("--uri", help="URI of the repo")
4439 @click.option("--description", help="human readable description")
4440 # @click.option('--wait',
4442 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4444 def repo_update(ctx
, name
, newname
, uri
, description
):
4445 """updates a repo in OSM
4447 NAME: name of the repo
4450 check_client_version(ctx
.obj
, ctx
.command
.name
)
4453 repo
["name"] = newname
4457 repo
["description"] = description
4459 ctx
.obj
.repo
.update(name
, repo
)
4461 ctx
.obj
.osmrepo
.update(name
, repo
)
4463 # except ClientException as e:
4469 name
="repo-index", short_help
="Index a repository from a folder with artifacts"
4472 "--origin", default
=".", help="origin path where the artifacts are located"
4475 "--destination", default
=".", help="destination path where the index is deployed"
4478 def repo_index(ctx
, origin
, destination
):
4479 """Index a repository
4481 NAME: name or ID of the repo to be deleted
4483 check_client_version(ctx
.obj
, ctx
.command
.name
)
4484 ctx
.obj
.osmrepo
.repo_index(origin
, destination
)
4487 @cli_osm.command(name
="repo-delete", short_help
="deletes a repo")
4488 @click.argument("name")
4490 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
4492 # @click.option('--wait',
4494 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4496 def repo_delete(ctx
, name
, force
):
4499 NAME: name or ID of the repo to be deleted
4503 ctx
.obj
.repo
.delete(name
, force
=force
)
4505 ctx
.obj
.osmrepo
.delete(name
, force
=force
)
4506 # except ClientException as e:
4511 @cli_osm.command(name
="repo-list")
4516 help="restricts the list to the repos matching the filter",
4518 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4520 def repo_list(ctx
, filter, literal
):
4521 """list all repos"""
4524 check_client_version(ctx
.obj
, ctx
.command
.name
)
4526 filter = "&".join(filter)
4527 resp
= ctx
.obj
.repo
.list(filter)
4528 resp
+= ctx
.obj
.osmrepo
.list(filter)
4530 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4532 table
= PrettyTable(["Name", "Id", "Type", "URI", "Description"])
4534 # cluster['k8s-nets'] = json.dumps(yaml.safe_load(cluster['k8s-nets']))
4541 trunc_text(repo
.get("description") or "", 40),
4547 # except ClientException as e:
4552 @cli_osm.command(name
="repo-show", short_help
="shows the details of a repo")
4553 @click.argument("name")
4554 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4556 def repo_show(ctx
, name
, literal
):
4557 """shows the details of a repo
4559 NAME: name or ID of the repo
4562 resp
= ctx
.obj
.repo
.get(name
)
4564 resp
= ctx
.obj
.osmrepo
.get(name
)
4568 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4570 table
= PrettyTable(["key", "attribute"])
4572 for k
, v
in list(resp
.items()):
4573 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4577 # except ClientException as e:
4582 ####################
4583 # Project mgmt operations
4584 ####################
4587 @cli_osm.command(name
="project-create", short_help
="creates a new project")
4588 @click.argument("name")
4589 # @click.option('--description',
4590 # default='no description',
4591 # help='human readable description')
4592 @click.option("--domain-name", "domain_name", default
=None, help="assign to a domain")
4598 help="provide quotas. Can be used several times: 'quota1=number[,quota2=number,...]'. Quotas can be one "
4599 "of vnfds, nsds, nsts, pdus, nsrs, nsis, vim_accounts, wim_accounts, sdns, k8sclusters, k8srepos",
4602 def project_create(ctx
, name
, domain_name
, quotas
):
4603 """Creates a new project
4605 NAME: name of the project
4606 DOMAIN_NAME: optional domain name for the project when keystone authentication is used
4607 QUOTAS: set quotas for the project
4610 project
= {"name": name
}
4612 project
["domain_name"] = domain_name
4613 quotas_dict
= _process_project_quotas(quotas
)
4615 project
["quotas"] = quotas_dict
4618 check_client_version(ctx
.obj
, ctx
.command
.name
)
4619 ctx
.obj
.project
.create(name
, project
)
4620 # except ClientException as e:
4625 def _process_project_quotas(quota_list
):
4630 for quota
in quota_list
:
4631 for single_quota
in quota
.split(","):
4632 k
, v
= single_quota
.split("=")
4633 quotas_dict
[k
] = None if v
in ("None", "null", "") else int(v
)
4634 except (ValueError, TypeError):
4635 raise ClientException(
4636 "invalid format for 'quotas'. Use 'k1=v1,v1=v2'. v must be a integer or null"
4641 @cli_osm.command(name
="project-delete", short_help
="deletes a project")
4642 @click.argument("name")
4643 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
4645 def project_delete(ctx
, name
):
4646 """deletes a project
4648 NAME: name or ID of the project to be deleted
4652 check_client_version(ctx
.obj
, ctx
.command
.name
)
4653 ctx
.obj
.project
.delete(name
)
4654 # except ClientException as e:
4659 @cli_osm.command(name
="project-list", short_help
="list all projects")
4664 help="restricts the list to the projects matching the filter",
4667 def project_list(ctx
, filter):
4668 """list all projects"""
4671 check_client_version(ctx
.obj
, ctx
.command
.name
)
4673 filter = "&".join(filter)
4674 resp
= ctx
.obj
.project
.list(filter)
4675 # except ClientException as e:
4678 table
= PrettyTable(["name", "id"])
4680 table
.add_row([proj
["name"], proj
["_id"]])
4685 @cli_osm.command(name
="project-show", short_help
="shows the details of a project")
4686 @click.argument("name")
4688 def project_show(ctx
, name
):
4689 """shows the details of a project
4691 NAME: name or ID of the project
4695 check_client_version(ctx
.obj
, ctx
.command
.name
)
4696 resp
= ctx
.obj
.project
.get(name
)
4697 # except ClientException as e:
4701 table
= PrettyTable(["key", "attribute"])
4702 for k
, v
in resp
.items():
4703 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4709 name
="project-update", short_help
="updates a project (only the name can be updated)"
4711 @click.argument("project")
4712 @click.option("--name", default
=None, help="new name for the project")
4718 help="change quotas. Can be used several times: 'quota1=number|empty[,quota2=...]' "
4719 "(use empty to reset quota to default",
4722 def project_update(ctx
, project
, name
, quotas
):
4724 Update a project name
4727 :param project: id or name of the project to modify
4728 :param name: new name for the project
4729 :param quotas: change quotas of the project
4733 project_changes
= {}
4735 project_changes
["name"] = name
4736 quotas_dict
= _process_project_quotas(quotas
)
4738 project_changes
["quotas"] = quotas_dict
4741 check_client_version(ctx
.obj
, ctx
.command
.name
)
4742 ctx
.obj
.project
.update(project
, project_changes
)
4743 # except ClientException as e:
4747 ####################
4748 # User mgmt operations
4749 ####################
4752 @cli_osm.command(name
="user-create", short_help
="creates a new user")
4753 @click.argument("username")
4758 confirmation_prompt
=True,
4759 help="user password",
4763 # prompt="Comma separate list of projects",
4765 callback
=lambda ctx
, param
, value
: "".join(value
).split(",")
4766 if all(len(x
) == 1 for x
in value
)
4768 help="list of project ids that the user belongs to",
4771 "--project-role-mappings",
4772 "project_role_mappings",
4775 help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4777 @click.option("--domain-name", "domain_name", default
=None, help="assign to a domain")
4779 def user_create(ctx
, username
, password
, projects
, project_role_mappings
, domain_name
):
4780 """Creates a new user
4783 USERNAME: name of the user
4784 PASSWORD: password of the user
4785 PROJECTS: projects assigned to user (internal only)
4786 PROJECT_ROLE_MAPPING: roles in projects assigned to user (keystone)
4787 DOMAIN_NAME: optional domain name for the user when keystone authentication is used
4791 user
["username"] = username
4792 user
["password"] = password
4793 user
["projects"] = projects
4794 user
["project_role_mappings"] = project_role_mappings
4796 user
["domain_name"] = domain_name
4799 check_client_version(ctx
.obj
, ctx
.command
.name
)
4800 ctx
.obj
.user
.create(username
, user
)
4801 # except ClientException as e:
4806 @cli_osm.command(name
="user-update", short_help
="updates user information")
4807 @click.argument("username")
4812 # confirmation_prompt=True,
4813 help="user password",
4815 @click.option("--set-username", "set_username", default
=None, help="change username")
4821 help="create/replace the roles for this project: 'project,role1[,role2,...]'",
4828 help="removes project from user: 'project'",
4831 "--add-project-role",
4835 help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4838 "--remove-project-role",
4839 "remove_project_role",
4842 help="remove role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4853 remove_project_role
,
4855 """Update a user information
4858 USERNAME: name of the user
4859 PASSWORD: new password
4860 SET_USERNAME: new username
4861 SET_PROJECT: creating mappings for project/role(s)
4862 REMOVE_PROJECT: deleting mappings for project/role(s)
4863 ADD_PROJECT_ROLE: adding mappings for project/role(s)
4864 REMOVE_PROJECT_ROLE: removing mappings for project/role(s)
4868 user
["password"] = password
4869 user
["username"] = set_username
4870 user
["set-project"] = set_project
4871 user
["remove-project"] = remove_project
4872 user
["add-project-role"] = add_project_role
4873 user
["remove-project-role"] = remove_project_role
4876 check_client_version(ctx
.obj
, ctx
.command
.name
)
4877 ctx
.obj
.user
.update(username
, user
)
4878 # except ClientException as e:
4883 @cli_osm.command(name
="user-delete", short_help
="deletes a user")
4884 @click.argument("name")
4885 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
4887 def user_delete(ctx
, name
):
4891 NAME: name or ID of the user to be deleted
4895 check_client_version(ctx
.obj
, ctx
.command
.name
)
4896 ctx
.obj
.user
.delete(name
)
4897 # except ClientException as e:
4902 @cli_osm.command(name
="user-list", short_help
="list all users")
4907 help="restricts the list to the users matching the filter",
4910 def user_list(ctx
, filter):
4911 """list all users"""
4913 check_client_version(ctx
.obj
, ctx
.command
.name
)
4915 filter = "&".join(filter)
4916 resp
= ctx
.obj
.user
.list(filter)
4917 # except ClientException as e:
4920 table
= PrettyTable(["name", "id"])
4922 table
.add_row([user
["username"], user
["_id"]])
4927 @cli_osm.command(name
="user-show", short_help
="shows the details of a user")
4928 @click.argument("name")
4930 def user_show(ctx
, name
):
4931 """shows the details of a user
4933 NAME: name or ID of the user
4937 check_client_version(ctx
.obj
, ctx
.command
.name
)
4938 resp
= ctx
.obj
.user
.get(name
)
4939 if "password" in resp
:
4940 resp
["password"] = "********"
4941 # except ClientException as e:
4945 table
= PrettyTable(["key", "attribute"])
4946 for k
, v
in resp
.items():
4947 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4952 ####################
4953 # Fault Management operations
4954 ####################
4957 @cli_osm.command(name
="ns-alarm-create")
4958 @click.argument("name")
4959 @click.option("--ns", prompt
=True, help="NS instance id or name")
4961 "--vnf", prompt
=True, help="VNF name (VNF member index as declared in the NSD)"
4963 @click.option("--vdu", prompt
=True, help="VDU name (VDU name as declared in the VNFD)")
4964 @click.option("--metric", prompt
=True, help="Name of the metric (e.g. cpu_utilization)")
4968 help="severity of the alarm (WARNING, MINOR, MAJOR, CRITICAL, INDETERMINATE)",
4971 "--threshold_value",
4973 help="threshold value that, when crossed, an alarm is triggered",
4976 "--threshold_operator",
4978 help="threshold operator describing the comparison (GE, LE, GT, LT, EQ)",
4983 help="statistic (AVERAGE, MINIMUM, MAXIMUM, COUNT, SUM)",
4986 def ns_alarm_create(
4998 """creates a new alarm for a NS instance"""
4999 # TODO: Check how to validate threshold_value.
5000 # Should it be an integer (1-100), percentage, or decimal (0.01-1.00)?
5003 ns_instance
= ctx
.obj
.ns
.get(ns
)
5005 alarm
["alarm_name"] = name
5006 alarm
["ns_id"] = ns_instance
["_id"]
5007 alarm
["correlation_id"] = ns_instance
["_id"]
5008 alarm
["vnf_member_index"] = vnf
5009 alarm
["vdu_name"] = vdu
5010 alarm
["metric_name"] = metric
5011 alarm
["severity"] = severity
5012 alarm
["threshold_value"] = int(threshold_value
)
5013 alarm
["operation"] = threshold_operator
5014 alarm
["statistic"] = statistic
5015 check_client_version(ctx
.obj
, ctx
.command
.name
)
5016 ctx
.obj
.ns
.create_alarm(alarm
)
5017 # except ClientException as e:
5022 # @cli_osm.command(name='ns-alarm-delete')
5023 # @click.argument('name')
5024 # @click.pass_context
5025 # def ns_alarm_delete(ctx, name):
5026 # """deletes an alarm
5028 # NAME: name of the alarm to be deleted
5031 # check_client_version(ctx.obj, ctx.command.name)
5032 # ctx.obj.ns.delete_alarm(name)
5033 # except ClientException as e:
5038 ####################
5039 # Performance Management operations
5040 ####################
5044 name
="ns-metric-export",
5045 short_help
="exports a metric to the internal OSM bus, which can be read by other apps",
5047 @click.option("--ns", prompt
=True, help="NS instance id or name")
5049 "--vnf", prompt
=True, help="VNF name (VNF member index as declared in the NSD)"
5051 @click.option("--vdu", prompt
=True, help="VDU name (VDU name as declared in the VNFD)")
5052 @click.option("--metric", prompt
=True, help="name of the metric (e.g. cpu_utilization)")
5053 # @click.option('--period', default='1w',
5054 # help='metric collection period (e.g. 20s, 30m, 2h, 3d, 1w)')
5056 "--interval", help="periodic interval (seconds) to export metrics continuously"
5059 def ns_metric_export(ctx
, ns
, vnf
, vdu
, metric
, interval
):
5060 """exports a metric to the internal OSM bus, which can be read by other apps"""
5061 # TODO: Check how to validate interval.
5062 # Should it be an integer (seconds), or should a suffix (s,m,h,d,w) also be permitted?
5065 ns_instance
= ctx
.obj
.ns
.get(ns
)
5067 metric_data
["ns_id"] = ns_instance
["_id"]
5068 metric_data
["correlation_id"] = ns_instance
["_id"]
5069 metric_data
["vnf_member_index"] = vnf
5070 metric_data
["vdu_name"] = vdu
5071 metric_data
["metric_name"] = metric
5072 metric_data
["collection_unit"] = "WEEK"
5073 metric_data
["collection_period"] = 1
5074 check_client_version(ctx
.obj
, ctx
.command
.name
)
5076 print("{}".format(ctx
.obj
.ns
.export_metric(metric_data
)))
5080 print("{} {}".format(ctx
.obj
.ns
.export_metric(metric_data
), i
))
5081 time
.sleep(int(interval
))
5083 # except ClientException as e:
5089 # Subscription operations
5094 name
="subscription-create",
5095 short_help
="creates a new subscription to a specific event",
5099 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5100 type=click
.Choice(["ns"], case_sensitive
=False),
5101 help="event type to be subscribed (for the moment, only ns is supported)",
5103 @click.option("--event", default
=None, help="specific yaml configuration for the event")
5105 "--event_file", default
=None, help="specific yaml configuration file for the event"
5108 def subscription_create(ctx
, event_type
, event
, event_file
):
5109 """creates a new subscription to a specific event"""
5111 check_client_version(ctx
.obj
, ctx
.command
.name
)
5114 raise ClientException(
5115 '"--event" option is incompatible with "--event_file" option'
5117 with
open(event_file
, "r") as cf
:
5119 ctx
.obj
.subscription
.create(event_type
, event
)
5122 @cli_osm.command(name
="subscription-delete", short_help
="deletes a subscription")
5125 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5126 type=click
.Choice(["ns"], case_sensitive
=False),
5127 help="event type to be subscribed (for the moment, only ns is supported)",
5129 @click.argument("subscription_id")
5131 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
5134 def subscription_delete(ctx
, event_type
, subscription_id
, force
):
5135 """deletes a subscription
5137 SUBSCRIPTION_ID: ID of the subscription to be deleted
5140 check_client_version(ctx
.obj
, ctx
.command
.name
)
5141 ctx
.obj
.subscription
.delete(event_type
, subscription_id
, force
)
5144 @cli_osm.command(name
="subscription-list", short_help
="list all subscriptions")
5147 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5148 type=click
.Choice(["ns"], case_sensitive
=False),
5149 help="event type to be subscribed (for the moment, only ns is supported)",
5155 help="restricts the list to the subscriptions matching the filter",
5158 def subscription_list(ctx
, event_type
, filter):
5159 """list all subscriptions"""
5161 check_client_version(ctx
.obj
, ctx
.command
.name
)
5163 filter = "&".join(filter)
5164 resp
= ctx
.obj
.subscription
.list(event_type
, filter)
5165 table
= PrettyTable(["id", "filter", "CallbackUri"])
5170 wrap_text(text
=json
.dumps(sub
["filter"], indent
=2), width
=70),
5179 name
="subscription-show", short_help
="shows the details of a subscription"
5181 @click.argument("subscription_id")
5184 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5185 type=click
.Choice(["ns"], case_sensitive
=False),
5186 help="event type to be subscribed (for the moment, only ns is supported)",
5191 help="restricts the information to the fields in the filter",
5194 def subscription_show(ctx
, event_type
, subscription_id
, filter):
5195 """shows the details of a subscription
5197 SUBSCRIPTION_ID: ID of the subscription
5201 resp
= ctx
.obj
.subscription
.get(subscription_id
)
5202 table
= PrettyTable(["key", "attribute"])
5203 for k
, v
in list(resp
.items()):
5204 if not filter or k
in filter:
5205 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
5210 ####################
5212 ####################
5215 @cli_osm.command(name
="version", short_help
="shows client and server versions")
5217 def get_version(ctx
):
5218 """shows client and server versions"""
5220 check_client_version(ctx
.obj
, "version")
5221 print("Server version: {}".format(ctx
.obj
.get_version()))
5223 "Client version: {}".format(pkg_resources
.get_distribution("osmclient").version
)
5225 # except ClientException as e:
5231 name
="upload-package", short_help
="uploads a VNF package or NS package"
5233 @click.argument("filename")
5235 "--skip-charm-build",
5238 help="the charm will not be compiled, it is assumed to already exist",
5241 def upload_package(ctx
, filename
, skip_charm_build
):
5242 """uploads a vnf package or ns package
5244 filename: vnf or ns package folder, or vnf or ns package file (tar.gz)
5248 ctx
.obj
.package
.upload(filename
, skip_charm_build
=skip_charm_build
)
5249 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
5250 if fullclassname
!= "osmclient.sol005.client.Client":
5251 ctx
.obj
.package
.wait_for_upload(filename
)
5252 # except ClientException as e:
5257 # @cli_osm.command(name='ns-scaling-show')
5258 # @click.argument('ns_name')
5259 # @click.pass_context
5260 # def show_ns_scaling(ctx, ns_name):
5261 # """shows the status of a NS scaling operation
5263 # NS_NAME: name of the NS instance being scaled
5266 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5267 # resp = ctx.obj.ns.list()
5268 # except ClientException as e:
5272 # table = PrettyTable(
5275 # 'operational status',
5280 # if ns_name == ns['name']:
5281 # nsopdata = ctx.obj.ns.get_opdata(ns['id'])
5282 # scaling_records = nsopdata['nsr:nsr']['scaling-group-record']
5283 # for record in scaling_records:
5284 # if 'instance' in record:
5285 # instances = record['instance']
5286 # for inst in instances:
5288 # [record['scaling-group-name-ref'],
5289 # inst['instance-id'],
5290 # inst['op-status'],
5291 # time.strftime('%Y-%m-%d %H:%M:%S',
5293 # inst['create-time'])),
5299 # @cli_osm.command(name='ns-scale')
5300 # @click.argument('ns_name')
5301 # @click.option('--ns_scale_group', prompt=True)
5302 # @click.option('--index', prompt=True)
5303 # @click.option('--wait',
5307 # help='do not return the control immediately, but keep it \
5308 # until the operation is completed, or timeout')
5309 # @click.pass_context
5310 # def ns_scale(ctx, ns_name, ns_scale_group, index, wait):
5313 # NS_NAME: name of the NS instance to be scaled
5316 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5317 # ctx.obj.ns.scale(ns_name, ns_scale_group, index, wait=wait)
5318 # except ClientException as e:
5323 # @cli_osm.command(name='config-agent-list')
5324 # @click.pass_context
5325 # def config_agent_list(ctx):
5326 # """list config agents"""
5328 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5329 # except ClientException as e:
5332 # table = PrettyTable(['name', 'account-type', 'details'])
5333 # for account in ctx.obj.vca.list():
5336 # account['account-type'],
5342 # @cli_osm.command(name='config-agent-delete')
5343 # @click.argument('name')
5344 # @click.pass_context
5345 # def config_agent_delete(ctx, name):
5346 # """deletes a config agent
5348 # NAME: name of the config agent to be deleted
5351 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5352 # ctx.obj.vca.delete(name)
5353 # except ClientException as e:
5358 # @cli_osm.command(name='config-agent-add')
5359 # @click.option('--name',
5361 # @click.option('--account_type',
5363 # @click.option('--server',
5365 # @click.option('--user',
5367 # @click.option('--secret',
5370 # confirmation_prompt=True)
5371 # @click.pass_context
5372 # def config_agent_add(ctx, name, account_type, server, user, secret):
5373 # """adds a config agent"""
5375 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5376 # ctx.obj.vca.create(name, account_type, server, user, secret)
5377 # except ClientException as e:
5382 # @cli_osm.command(name='ro-dump')
5383 # @click.pass_context
5385 # """shows RO agent information"""
5386 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5387 # resp = ctx.obj.vim.get_resource_orchestrator()
5388 # table = PrettyTable(['key', 'attribute'])
5389 # for k, v in list(resp.items()):
5390 # table.add_row([k, json.dumps(v, indent=2)])
5395 # @cli_osm.command(name='vcs-list')
5396 # @click.pass_context
5397 # def vcs_list(ctx):
5398 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5399 # resp = ctx.obj.utils.get_vcs_info()
5400 # table = PrettyTable(['component name', 'state'])
5401 # for component in resp:
5402 # table.add_row([component['component_name'], component['state']])
5408 name
="ns-action", short_help
="executes an action/primitive over a NS instance"
5410 @click.argument("ns_name")
5414 help="member-vnf-index if the target is a vnf instead of a ns)",
5416 @click.option("--kdu_name", default
=None, help="kdu-name if the target is a kdu)")
5417 @click.option("--vdu_id", default
=None, help="vdu-id if the target is a vdu")
5419 "--vdu_count", default
=None, type=int, help="number of vdu instance of this vdu_id"
5421 @click.option("--action_name", prompt
=True, help="action name")
5422 @click.option("--params", default
=None, help="action params in YAML/JSON inline string")
5423 @click.option("--params_file", default
=None, help="YAML/JSON file with action params")
5425 "--timeout", required
=False, default
=None, type=int, help="timeout in seconds"
5432 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5448 """executes an action/primitive over a NS instance
5450 NS_NAME: name or ID of the NS instance
5454 check_client_version(ctx
.obj
, ctx
.command
.name
)
5457 op_data
["member_vnf_index"] = vnf_name
5459 op_data
["kdu_name"] = kdu_name
5461 op_data
["vdu_id"] = vdu_id
5462 if vdu_count
is not None:
5463 op_data
["vdu_count_index"] = vdu_count
5465 op_data
["timeout_ns_action"] = timeout
5466 op_data
["primitive"] = action_name
5468 with
open(params_file
, "r") as pf
:
5471 op_data
["primitive_params"] = yaml
.safe_load(params
)
5473 op_data
["primitive_params"] = {}
5474 print(ctx
.obj
.ns
.exec_op(ns_name
, op_name
="action", op_data
=op_data
, wait
=wait
))
5476 # except ClientException as e:
5482 name
="vnf-scale", short_help
="executes a VNF scale (adding/removing VDUs)"
5484 @click.argument("ns_name")
5485 @click.argument("vnf_name")
5487 "--scaling-group", prompt
=True, help="scaling-group-descriptor name to use"
5490 "--scale-in", default
=False, is_flag
=True, help="performs a scale in operation"
5496 help="performs a scale out operation (by default)",
5499 "--timeout", required
=False, default
=None, type=int, help="timeout in seconds"
5506 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5510 ctx
, ns_name
, vnf_name
, scaling_group
, scale_in
, scale_out
, timeout
, wait
5513 Executes a VNF scale (adding/removing VDUs)
5516 NS_NAME: name or ID of the NS instance.
5517 VNF_NAME: member-vnf-index in the NS to be scaled.
5521 check_client_version(ctx
.obj
, ctx
.command
.name
)
5522 if not scale_in
and not scale_out
:
5524 ctx
.obj
.ns
.scale_vnf(
5525 ns_name
, vnf_name
, scaling_group
, scale_in
, scale_out
, wait
, timeout
5527 # except ClientException as e:
5532 @cli_osm.command(name
="alarm-show", short_help
="show alarm details")
5533 @click.argument("uuid")
5535 def alarm_show(ctx
, uuid
):
5536 """Show alarm's detail information"""
5538 check_client_version(ctx
.obj
, ctx
.command
.name
)
5539 resp
= ctx
.obj
.ns
.get_alarm(uuid
=uuid
)
5553 table
= PrettyTable(["key", "attribute"])
5555 # Arrange and return the response data
5556 resp
= resp
.replace("ObjectId", "")
5558 for key
in alarm_filter
:
5560 value
= alarm
.get(key
)
5563 value
= alarm
.get(key
)
5565 elif key
== "ns-id":
5566 value
= alarm
["tags"].get("ns_id")
5567 elif key
== "vdu_name":
5568 value
= alarm
["tags"].get("vdu_name")
5569 elif key
== "status":
5570 value
= alarm
["alarm_status"]
5573 table
.add_row([key
, wrap_text(text
=json
.dumps(value
, indent
=2), width
=100)])
5581 @cli_osm.command(name
="alarm-list", short_help
="list all alarms")
5583 "--ns_id", default
=None, required
=False, help="List out alarm for given ns id"
5586 def alarm_list(ctx
, ns_id
):
5587 """list all alarm"""
5589 check_client_version(ctx
.obj
, ctx
.command
.name
)
5590 project_name
= os
.getenv("OSM_PROJECT", "admin")
5591 resp
= ctx
.obj
.ns
.get_alarm(project_name
=project_name
, ns_id
=ns_id
)
5593 table
= PrettyTable(
5594 ["alarm-id", "metric", "threshold", "operation", "action", "status"]
5597 # return the response data in a table
5598 resp
= resp
.replace("ObjectId", "")
5603 wrap_text(text
=str(alarm
["uuid"]), width
=38),
5607 wrap_text(text
=alarm
["action"], width
=25),
5608 alarm
["alarm_status"],
5616 @cli_osm.command(name
="alarm-update", short_help
="Update a alarm")
5617 @click.argument("uuid")
5618 @click.option("--threshold", default
=None, help="Alarm threshold")
5619 @click.option("--is_enable", default
=None, type=bool, help="enable or disable alarm")
5621 def alarm_update(ctx
, uuid
, threshold
, is_enable
):
5626 if not threshold
and is_enable
is None:
5627 raise ClientException(
5628 "Please provide option to update i.e threshold or is_enable"
5630 ctx
.obj
.ns
.update_alarm(uuid
, threshold
, is_enable
)
5633 ##############################
5634 # Role Management Operations #
5635 ##############################
5638 @cli_osm.command(name
="role-create", short_help
="creates a new role")
5639 @click.argument("name")
5640 @click.option("--permissions", default
=None, help="role permissions using a dictionary")
5642 def role_create(ctx
, name
, permissions
):
5647 NAME: Name or ID of the role.
5648 DEFINITION: Definition of grant/denial of access to resources.
5652 check_client_version(ctx
.obj
, ctx
.command
.name
)
5653 ctx
.obj
.role
.create(name
, permissions
)
5654 # except ClientException as e:
5659 @cli_osm.command(name
="role-update", short_help
="updates a role")
5660 @click.argument("name")
5661 @click.option("--set-name", default
=None, help="change name of rle")
5662 # @click.option('--permissions',
5664 # help='provide a yaml format dictionary with incremental changes. Values can be bool or None to delete')
5668 help="yaml format dictionary with permission: True/False to access grant/denial",
5670 @click.option("--remove", default
=None, help="yaml format list to remove a permission")
5672 def role_update(ctx
, name
, set_name
, add
, remove
):
5677 NAME: Name or ID of the role.
5678 DEFINITION: Definition overwrites the old definition.
5679 ADD: Grant/denial of access to resource to add.
5680 REMOVE: Grant/denial of access to resource to remove.
5684 check_client_version(ctx
.obj
, ctx
.command
.name
)
5685 ctx
.obj
.role
.update(name
, set_name
, None, add
, remove
)
5686 # except ClientException as e:
5691 @cli_osm.command(name
="role-delete", short_help
="deletes a role")
5692 @click.argument("name")
5693 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
5695 def role_delete(ctx
, name
):
5700 NAME: Name or ID of the role.
5704 check_client_version(ctx
.obj
, ctx
.command
.name
)
5705 ctx
.obj
.role
.delete(name
)
5706 # except ClientException as e:
5711 @cli_osm.command(name
="role-list", short_help
="list all roles")
5716 help="restricts the list to the projects matching the filter",
5719 def role_list(ctx
, filter):
5725 check_client_version(ctx
.obj
, ctx
.command
.name
)
5727 filter = "&".join(filter)
5728 resp
= ctx
.obj
.role
.list(filter)
5729 # except ClientException as e:
5732 table
= PrettyTable(["name", "id"])
5734 table
.add_row([role
["name"], role
["_id"]])
5739 @cli_osm.command(name
="role-show", short_help
="show specific role")
5740 @click.argument("name")
5742 def role_show(ctx
, name
):
5744 Shows the details of a role.
5747 NAME: Name or ID of the role.
5751 check_client_version(ctx
.obj
, ctx
.command
.name
)
5752 resp
= ctx
.obj
.role
.get(name
)
5753 # except ClientException as e:
5757 table
= PrettyTable(["key", "attribute"])
5758 for k
, v
in resp
.items():
5759 table
.add_row([k
, json
.dumps(v
, indent
=2)])
5764 @cli_osm.command(name
="package-create", short_help
="Create empty NS package structure")
5765 @click.argument("package-type")
5766 @click.argument("package-name")
5770 help=('(NS/VNF/NST) Set the location for package creation. Default: "."'),
5774 default
="image-name",
5775 help='(VNF) Set the name of the vdu image. Default "image-name"',
5778 "--vdus", default
=1, help="(VNF) Set the number of vdus in a VNF. Default 1"
5781 "--vcpu", default
=1, help="(VNF) Set the number of virtual CPUs in a vdu. Default 1"
5786 help="(VNF) Set the memory size (MB) of the vdu. Default 1024",
5789 "--storage", default
=10, help="(VNF) Set the disk size (GB) of the vdu. Default 10"
5794 help="(VNF) Set the number of additional interfaces apart from the management interface. Default 0",
5797 "--vendor", default
="OSM", help='(NS/VNF) Set the descriptor vendor. Default "OSM"'
5803 help="(NS/VNF/NST) Flag for overriding the package if exists.",
5809 help="(NS/VNF/NST) Flag for generating descriptor .yaml with all possible commented options",
5812 "--netslice-subnets", default
=1, help="(NST) Number of netslice subnets. Default 1"
5815 "--netslice-vlds", default
=1, help="(NST) Number of netslice vlds. Default 1"
5821 help="Flag to create a descriptor using the previous OSM format (pre SOL006, OSM<9)",
5843 Creates an OSM NS, VNF, NST package
5846 PACKAGE_TYPE: Package to be created: NS, VNF or NST.
5847 PACKAGE_NAME: Name of the package to create the folder with the content.
5852 check_client_version(ctx
.obj
, ctx
.command
.name
)
5854 "Creating the {} structure: {}/{}".format(
5855 package_type
.upper(), base_directory
, package_name
5858 resp
= ctx
.obj
.package_tool
.create(
5868 interfaces
=interfaces
,
5871 netslice_subnets
=netslice_subnets
,
5872 netslice_vlds
=netslice_vlds
,
5876 # except ClientException as inst:
5877 # print("ERROR: {}".format(inst))
5882 name
="package-validate", short_help
="Validate descriptors given a base directory"
5884 @click.argument("base-directory", default
=".", required
=False)
5886 "--recursive/--no-recursive",
5888 help="The activated recursive option will validate the yaml files"
5889 " within the indicated directory and in its subdirectories",
5895 help="Validates also the descriptors using the previous OSM format (pre SOL006)",
5898 def package_validate(ctx
, base_directory
, recursive
, old
):
5900 Validate descriptors given a base directory.
5903 BASE_DIRECTORY: Base folder for NS, VNF or NST package.
5907 check_client_version(ctx
.obj
, ctx
.command
.name
)
5908 results
= ctx
.obj
.package_tool
.validate(base_directory
, recursive
, old
)
5909 table
= PrettyTable()
5910 table
.field_names
= ["TYPE", "PATH", "VALID", "ERROR"]
5911 # Print the dictionary generated by the validation function
5912 for result
in results
:
5914 [result
["type"], result
["path"], result
["valid"], result
["error"]]
5916 table
.sortby
= "VALID"
5917 table
.align
["PATH"] = "l"
5918 table
.align
["TYPE"] = "l"
5919 table
.align
["ERROR"] = "l"
5921 # except ClientException as inst:
5922 # print("ERROR: {}".format(inst))
5927 name
="package-translate", short_help
="Translate descriptors given a base directory"
5929 @click.argument("base-directory", default
=".", required
=False)
5931 "--recursive/--no-recursive",
5933 help="The activated recursive option will translate the yaml files"
5934 " within the indicated directory and in its subdirectories",
5940 help="Do not translate yet, only make a dry-run to test translation",
5943 def package_translate(ctx
, base_directory
, recursive
, dryrun
):
5945 Translate descriptors given a base directory.
5948 BASE_DIRECTORY: Stub folder for NS, VNF or NST package.
5951 check_client_version(ctx
.obj
, ctx
.command
.name
)
5952 results
= ctx
.obj
.package_tool
.translate(base_directory
, recursive
, dryrun
)
5953 table
= PrettyTable()
5954 table
.field_names
= [
5962 # Print the dictionary generated by the validation function
5963 for result
in results
:
5966 result
["current type"],
5970 result
["translated"],
5974 table
.sortby
= "TRANSLATED"
5975 table
.align
["PATH"] = "l"
5976 table
.align
["TYPE"] = "l"
5977 table
.align
["ERROR"] = "l"
5979 # except ClientException as inst:
5980 # print("ERROR: {}".format(inst))
5984 @cli_osm.command(name
="package-build", short_help
="Build the tar.gz of the package")
5985 @click.argument("package-folder")
5987 "--skip-validation", default
=False, is_flag
=True, help="skip package validation"
5990 "--skip-charm-build",
5993 help="the charm will not be compiled, it is assumed to already exist",
5996 def package_build(ctx
, package_folder
, skip_validation
, skip_charm_build
):
5998 Build the package NS, VNF given the package_folder.
6001 PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged
6005 check_client_version(ctx
.obj
, ctx
.command
.name
)
6006 results
= ctx
.obj
.package_tool
.build(
6008 skip_validation
=skip_validation
,
6009 skip_charm_build
=skip_charm_build
,
6012 # except ClientException as inst:
6013 # print("ERROR: {}".format(inst))
6018 name
="descriptor-translate",
6019 short_help
="Translate input descriptor file from Rel EIGHT OSM descriptors to SOL006 and prints in standard output",
6021 @click.argument("descriptor-file", required
=True)
6023 def descriptor_translate(ctx
, descriptor_file
):
6025 Translate input descriptor.
6028 DESCRIPTOR_FILE: Descriptor file for NS, VNF or Network Slice.
6031 check_client_version(ctx
.obj
, ctx
.command
.name
)
6032 result
= ctx
.obj
.package_tool
.descriptor_translate(descriptor_file
)
6040 except pycurl
.error
as exc
:
6043 'Maybe "--hostname" option or OSM_HOSTNAME environment variable needs to be specified'
6045 except ClientException
as exc
:
6046 print("ERROR: {}".format(exc
))
6047 except (FileNotFoundError
, PermissionError
) as exc
:
6048 print("Cannot open file: {}".format(exc
))
6049 except yaml
.YAMLError
as exc
:
6050 print("Invalid YAML format: {}".format(exc
))
6052 # TODO capture other controlled exceptions here
6053 # TODO remove the ClientException captures from all places, unless they do something different
6056 if __name__
== "__main__":