84e2e402ab354076b2f2d7ecc621b8a77fb41b60
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 osmclient
.common
.utils
import validate_uuid4
25 from prettytable
import PrettyTable
34 from datetime
import datetime
35 from typing
import Any
, Dict
38 def wrap_text(text
, width
):
39 wrapper
= textwrap
.TextWrapper(width
=width
)
40 lines
= text
.splitlines()
41 return "\n".join(map(wrapper
.fill
, lines
))
44 def trunc_text(text
, length
):
45 if len(text
) > length
:
46 return text
[: (length
- 3)] + "..."
51 def check_client_version(obj
, what
, version
="sol005"):
53 Checks the version of the client object and raises error if it not the expected.
55 :param obj: the client object
56 :what: the function or command under evaluation (used when an error is raised)
58 :raises ClientError: if the specified version does not match the client version
61 fullclassname
= obj
.__module
__ + "." + obj
.__class
__.__name
__
62 message
= 'The following commands or options are only supported with the option "--sol005": {}'.format(
66 message
= 'The following commands or options are not supported when using option "--sol005": {}'.format(
69 if fullclassname
!= "osmclient.{}.client.Client".format(version
):
70 raise ClientException(message
)
74 def get_project(project_list
, item
):
75 # project_list = ctx.obj.project.list()
76 item_project_list
= item
.get("_admin", {}).get("projects_read")
80 for p1
in item_project_list
:
82 for p2
in project_list
:
83 if p2
["_id"] == project_id
:
84 project_name
= p2
["name"]
85 return project_id
, project_name
86 return project_id
, project_name
89 def get_vim_name(vim_list
, vim_id
):
92 if v
["uuid"] == vim_id
:
98 def create_config(config_file
, json_string
):
100 Combines a YAML or JSON file with a JSON string into a Python3 structure
101 It loads the YAML or JSON file 'cfile' into a first dictionary.
102 It loads the JSON string into a second dictionary.
103 Then it updates the first dictionary with the info in the second dictionary.
104 If the field is present in both cfile and cdict, the field in cdict prevails.
105 If both cfile and cdict are None, it returns an empty dict (i.e. {})
109 with
open(config_file
, "r") as cf
:
110 config
= yaml
.safe_load(cf
.read())
112 cdict
= yaml
.safe_load(json_string
)
113 for k
, v
in cdict
.items():
119 context_settings
=dict(help_option_names
=["-h", "--help"], max_content_width
=160)
124 envvar
="OSM_HOSTNAME",
125 help="hostname of server. " + "Also can set OSM_HOSTNAME in environment",
131 help="user (defaults to admin). " + "Also can set OSM_USER in environment",
136 envvar
="OSM_PASSWORD",
137 help="password (defaults to admin). " + "Also can set OSM_PASSWORD in environment",
142 envvar
="OSM_PROJECT",
143 help="project (defaults to admin). " + "Also can set OSM_PROJECT in environment",
149 help="increase verbosity (-v INFO, -vv VERBOSE, -vvv DEBUG)",
151 @click.option("--all-projects", default
=None, is_flag
=True, help="include all projects")
153 "--public/--no-public",
155 help="flag for public items (packages, instances, VIM accounts, etc.)",
158 "--project-domain-name",
159 "project_domain_name",
161 envvar
="OSM_PROJECT_DOMAIN_NAME",
162 help="project domain name for keystone authentication (default to None). "
163 + "Also can set OSM_PROJECT_DOMAIN_NAME in environment",
166 "--user-domain-name",
169 envvar
="OSM_USER_DOMAIN_NAME",
170 help="user domain name for keystone authentication (default to None). "
171 + "Also can set OSM_USER_DOMAIN_NAME in environment",
174 def cli_osm(ctx
, **kwargs
):
176 hostname
= kwargs
.pop("hostname", None)
180 "either hostname option or OSM_HOSTNAME "
181 + "environment variable needs to be specified"
186 kwargs
= {k
: v
for k
, v
in kwargs
.items() if v
is not None}
187 sol005
= os
.getenv("OSM_SOL005", True)
188 ctx
.obj
= client
.Client(host
=hostname
, sol005
=sol005
, **kwargs
)
189 logger
= logging
.getLogger("osmclient")
197 @cli_osm.command(name
="ns-list", short_help
="list all NS instances")
202 help="restricts the list to the NS instances matching the filter.",
207 help="get more details of the NS (project, vim, deployment status, configuration status.",
210 def ns_list(ctx
, filter, long):
211 """list all NS instances
215 --filter filterExpr Restricts the list to the NS instances matching the filter
218 filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
219 concatenated using the "&" character:
222 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
223 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
224 op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
226 value := scalar value
230 * zero or more occurrences
231 ? zero or one occurrence
232 [] grouping of expressions to be used with ? and *
233 "" quotation marks for marking string constants
237 "AttrName" is the name of one attribute in the data type that defines the representation
238 of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
239 <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
240 "Op" stands for the comparison operator. If the expression has concatenated <attrName>
241 entries, it means that the operator "op" is applied to the attribute addressed by the last
242 <attrName> entry included in the concatenation. All simple filter expressions are combined
243 by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
244 the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
245 concatenation of all "attrName" entries except the leaf attribute is called the "attribute
246 prefix". If an attribute referenced in an expression is an array, an object that contains a
247 corresponding array shall be considered to match the expression if any of the elements in the
248 array matches all expressions that have the same attribute prefix.
252 --filter admin-status=ENABLED
253 --filter nsd-ref=<NSD_NAME>
254 --filter nsd.vendor=<VENDOR>
255 --filter nsd.vendor=<VENDOR>&nsd-ref=<NSD_NAME>
256 --filter nsd.constituent-vnfd.vnfd-id-ref=<VNFD_NAME>
259 def summarize_deployment_status(status_dict
):
266 net_list
= status_dict
.get("nets", [])
269 if net
["status"] not in status_nets
:
270 status_nets
[net
["status"]] = 1
272 status_nets
[net
["status"]] += 1
274 for k
, v
in status_nets
.items():
275 message
+= "{}:{},".format(k
, v
)
276 message
+= "TOTAL:{}".format(n_nets
)
277 summary
+= "{}".format(message
)
282 vnf_list
= status_dict
["vnfs"]
284 member_vnf_index
= vnf
["member_vnf_index"]
285 if member_vnf_index
not in status_vnfs
:
286 status_vnfs
[member_vnf_index
] = {}
287 for vm
in vnf
["vms"]:
289 if vm
["status"] not in status_vms
:
290 status_vms
[vm
["status"]] = 1
292 status_vms
[vm
["status"]] += 1
293 if vm
["status"] not in status_vnfs
[member_vnf_index
]:
294 status_vnfs
[member_vnf_index
][vm
["status"]] = 1
296 status_vnfs
[member_vnf_index
][vm
["status"]] += 1
298 for k
, v
in status_vms
.items():
299 message
+= "{}:{},".format(k
, v
)
300 message
+= "TOTAL:{}".format(n_vms
)
301 summary
+= "\n{}".format(message
)
303 for k
, v
in status_vnfs
.items():
305 message
= "\n {} VMs: ".format(k
)
306 for k2
, v2
in v
.items():
307 message
+= "{}:{},".format(k2
, v2
)
309 message
+= "TOTAL:{}".format(total
)
313 def summarize_config_status(ee_list
):
321 if ee
["elementType"] not in status_ee
:
322 status_ee
[ee
["elementType"]] = {}
323 status_ee
[ee
["elementType"]][ee
["status"]] = 1
325 if ee
["status"] in status_ee
[ee
["elementType"]]:
326 status_ee
[ee
["elementType"]][ee
["status"]] += 1
328 status_ee
[ee
["elementType"]][ee
["status"]] = 1
329 for elementType
in ["KDU", "VDU", "PDU", "VNF", "NS"]:
330 if elementType
in status_ee
:
333 for k
, v
in status_ee
[elementType
].items():
334 message
+= "{}:{},".format(k
, v
)
336 message
+= "TOTAL:{}\n".format(total
)
337 summary
+= "{}: {}".format(elementType
, message
)
338 summary
+= "TOTAL Exec. Env.: {}".format(n_ee
)
343 check_client_version(ctx
.obj
, "--filter")
344 filter = "&".join(filter)
345 resp
= ctx
.obj
.ns
.list(filter)
347 resp
= ctx
.obj
.ns
.list()
360 "configuration status",
363 project_list
= ctx
.obj
.project
.list()
365 vim_list
= ctx
.obj
.vim
.list()
380 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
381 if fullclassname
== "osmclient.sol005.client.Client":
383 logger
.debug("NS info: {}".format(nsr
))
384 nsr_name
= nsr
["name"]
386 date
= datetime
.fromtimestamp(nsr
["create-time"]).strftime(
389 ns_state
= nsr
.get("nsState", nsr
["_admin"]["nsState"])
391 deployment_status
= summarize_deployment_status(
392 nsr
.get("deploymentStatus")
394 config_status
= summarize_config_status(nsr
.get("configurationStatus"))
395 project_id
, project_name
= get_project(project_list
, nsr
)
396 # project = '{} ({})'.format(project_name, project_id)
397 project
= project_name
398 vim_id
= nsr
.get("datacenter")
399 vim_name
= get_vim_name(vim_list
, vim_id
)
401 # vim = '{} ({})'.format(vim_name, vim_id)
403 if "currentOperation" in nsr
:
404 current_operation
= "{} ({})".format(
405 nsr
["currentOperation"], nsr
["currentOperationID"]
408 current_operation
= "{} ({})".format(
409 nsr
["_admin"].get("current-operation", "-"),
410 nsr
["_admin"]["nslcmop"],
412 error_details
= "N/A"
415 or ns_state
== "DEGRADED"
416 or ("currentOperation" not in nsr
and nsr
.get("errorDescription"))
418 error_details
= "{}\nDetail: {}".format(
419 nsr
["errorDescription"], nsr
["errorDetail"]
422 nsopdata
= ctx
.obj
.ns
.get_opdata(ns
["id"])
423 nsr
= nsopdata
["nsr:nsr"]
424 nsr_name
= nsr
["name-ref"]
425 nsr_id
= nsr
["ns-instance-config-ref"]
428 deployment_status
= (
429 nsr
["operational-status"]
430 if "operational-status" in nsr
433 ns_state
= deployment_status
434 config_status
= nsr
.get("config-status", "Not found")
435 current_operation
= "Unknown"
436 error_details
= nsr
.get("detailed-status", "Not found")
437 if config_status
== "config_not_needed":
438 config_status
= "configured (no charms)"
448 wrap_text(text
=error_details
, width
=40),
463 wrap_text(text
=error_details
, width
=40),
468 print('To get the history of all operations over a NS, run "osm ns-op-list NS_ID"')
470 'For more details on the current operation, run "osm ns-op-show OPERATION_ID"'
474 def nsd_list(ctx
, filter, long):
477 check_client_version(ctx
.obj
, "--filter")
478 filter = "&".join(filter)
479 resp
= ctx
.obj
.nsd
.list(filter)
481 resp
= ctx
.obj
.nsd
.list()
482 # print(yaml.safe_dump(resp))
483 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
484 if fullclassname
== "osmclient.sol005.client.Client":
498 table
= PrettyTable(["nsd name", "id"])
500 name
= nsd
.get("id", "-")
502 onb_state
= nsd
["_admin"].get("onboardingState", "-")
503 op_state
= nsd
["_admin"].get("operationalState", "-")
504 usage_state
= nsd
["_admin"].get("usageState", "-")
505 date
= datetime
.fromtimestamp(nsd
["_admin"]["created"]).strftime(
508 last_update
= datetime
.fromtimestamp(
509 nsd
["_admin"]["modified"]
510 ).strftime("%Y-%m-%dT%H:%M:%S")
523 table
.add_row([name
, nsd
["_id"]])
525 table
= PrettyTable(["nsd name", "id"])
527 table
.add_row([nsd
["name"], nsd
["id"]])
532 @cli_osm.command(name
="nsd-list", short_help
="list all NS packages")
537 help="restricts the list to the NSD/NSpkg matching the filter",
539 @click.option("--long", is_flag
=True, help="get more details")
541 def nsd_list1(ctx
, filter, long):
542 """list all NSD/NS pkg in the system"""
544 nsd_list(ctx
, filter, long)
547 @cli_osm.command(name
="nspkg-list", short_help
="list all NS packages")
552 help="restricts the list to the NSD/NSpkg matching the filter",
554 @click.option("--long", is_flag
=True, help="get more details")
556 def nsd_list2(ctx
, filter, long):
557 """list all NS packages"""
559 nsd_list(ctx
, filter, long)
562 def pkg_repo_list(ctx
, pkgtype
, filter, repo
, long):
563 resp
= ctx
.obj
.osmrepo
.pkg_list(pkgtype
, filter, repo
)
566 ["nfpkg name", "vendor", "version", "latest", "description", "repository"]
569 table
= PrettyTable(["nfpkg name", "repository"])
571 name
= vnfd
.get("id", vnfd
.get("name", "-"))
572 repository
= vnfd
.get("repository")
574 vendor
= vnfd
.get("provider", vnfd
.get("vendor"))
575 version
= vnfd
.get("version")
576 description
= vnfd
.get("description")
577 latest
= vnfd
.get("latest")
578 table
.add_row([name
, vendor
, version
, latest
, description
, repository
])
580 table
.add_row([name
, repository
])
585 def vnfd_list(ctx
, nf_type
, filter, long):
588 check_client_version(ctx
.obj
, "--nf_type")
590 check_client_version(ctx
.obj
, "--filter")
592 filter = "&".join(filter)
595 nf_filter
= "_admin.type=vnfd"
596 elif nf_type
== "pnf":
597 nf_filter
= "_admin.type=pnfd"
598 elif nf_type
== "hnf":
599 nf_filter
= "_admin.type=hnfd"
601 raise ClientException(
602 'wrong value for "--nf_type" option, allowed values: vnf, pnf, hnf'
605 filter = "{}&{}".format(nf_filter
, filter)
609 resp
= ctx
.obj
.vnfd
.list(filter)
611 resp
= ctx
.obj
.vnfd
.list()
612 # print(yaml.safe_dump(resp))
613 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
614 if fullclassname
== "osmclient.sol005.client.Client":
631 table
= PrettyTable(["nfpkg name", "id", "desc type"])
633 name
= vnfd
.get("id", vnfd
.get("name", "-"))
634 descriptor_type
= "sol006" if "product-name" in vnfd
else "rel8"
636 onb_state
= vnfd
["_admin"].get("onboardingState", "-")
637 op_state
= vnfd
["_admin"].get("operationalState", "-")
638 vendor
= vnfd
.get("provider", vnfd
.get("vendor"))
639 version
= vnfd
.get("version")
640 usage_state
= vnfd
["_admin"].get("usageState", "-")
641 date
= datetime
.fromtimestamp(vnfd
["_admin"]["created"]).strftime(
644 last_update
= datetime
.fromtimestamp(
645 vnfd
["_admin"]["modified"]
646 ).strftime("%Y-%m-%dT%H:%M:%S")
662 table
.add_row([name
, vnfd
["_id"], descriptor_type
])
664 table
= PrettyTable(["nfpkg name", "id"])
666 table
.add_row([vnfd
["name"], vnfd
["id"]])
671 @cli_osm.command(name
="vnfd-list", short_help
="list all xNF packages (VNF, HNF, PNF)")
672 @click.option("--nf_type", help="type of NF (vnf, pnf, hnf)")
677 help="restricts the list to the NF pkg matching the filter",
679 @click.option("--long", is_flag
=True, help="get more details")
681 def vnfd_list1(ctx
, nf_type
, filter, long):
682 """list all xNF packages (VNF, HNF, PNF)"""
684 vnfd_list(ctx
, nf_type
, filter, long)
687 @cli_osm.command(name
="vnfpkg-list", short_help
="list all xNF packages (VNF, HNF, PNF)")
688 @click.option("--nf_type", help="type of NF (vnf, pnf, hnf)")
693 help="restricts the list to the NFpkg matching the filter",
695 @click.option("--long", is_flag
=True, help="get more details")
697 def vnfd_list2(ctx
, nf_type
, filter, long):
698 """list all xNF packages (VNF, HNF, PNF)"""
700 vnfd_list(ctx
, nf_type
, filter, long)
703 @cli_osm.command(name
="nfpkg-list", short_help
="list all xNF packages (VNF, HNF, PNF)")
704 @click.option("--nf_type", help="type of NF (vnf, pnf, hnf)")
709 help="restricts the list to the NFpkg matching the filter",
711 @click.option("--long", is_flag
=True, help="get more details")
713 def nfpkg_list(ctx
, nf_type
, filter, long):
714 """list all xNF packages (VNF, HNF, PNF)"""
717 check_client_version(ctx
.obj
, ctx
.command
.name
)
718 vnfd_list(ctx
, nf_type
, filter, long)
719 # except ClientException as e:
725 name
="vnfpkg-repo-list", short_help
="list all xNF from OSM repositories"
731 help="restricts the list to the NFpkg matching the filter",
734 "--repo", default
=None, help="restricts the list to a particular OSM repository"
736 @click.option("--long", is_flag
=True, help="get more details")
738 def nfpkg_repo_list1(ctx
, filter, repo
, long):
739 """list xNF packages from OSM repositories"""
741 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
745 name
="nfpkg-repo-list", short_help
="list all xNF from OSM repositories"
751 help="restricts the list to the NFpkg matching the filter",
754 "--repo", default
=None, help="restricts the list to a particular OSM repository"
756 @click.option("--long", is_flag
=True, help="get more details")
758 def nfpkg_repo_list2(ctx
, filter, repo
, long):
759 """list xNF packages from OSM repositories"""
761 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
764 def vnf_list(ctx
, ns
, filter, long):
768 check_client_version(ctx
.obj
, "--ns")
770 filter = "&".join(filter)
771 check_client_version(ctx
.obj
, "--filter")
772 resp
= ctx
.obj
.vnf
.list(ns
, filter)
774 resp
= ctx
.obj
.vnf
.list()
775 # except ClientException as e:
778 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
779 if fullclassname
== "osmclient.sol005.client.Client":
801 table
= PrettyTable(field_names
)
803 name
= vnfr
["name"] if "name" in vnfr
else "-"
808 vnfr
["member-vnf-index-ref"],
810 vnfr
["vim-account-id"],
814 date
= datetime
.fromtimestamp(vnfr
["_admin"]["created"]).strftime(
817 last_update
= datetime
.fromtimestamp(
818 vnfr
["_admin"]["modified"]
819 ).strftime("%Y-%m-%dT%H:%M:%S")
820 new_row
.extend([date
, last_update
])
821 table
.add_row(new_row
)
823 table
= PrettyTable(["vnf name", "id", "operational status", "config status"])
825 if "mgmt-interface" not in vnfr
:
826 vnfr
["mgmt-interface"] = {}
827 vnfr
["mgmt-interface"]["ip-address"] = None
832 vnfr
["operational-status"],
833 vnfr
["config-status"],
840 @cli_osm.command(name
="vnf-list", short_help
="list all NF instances")
842 "--ns", default
=None, help="NS instance id or name to restrict the NF list"
848 help="restricts the list to the NF instances matching the filter.",
850 @click.option("--long", is_flag
=True, help="get more details")
852 def vnf_list1(ctx
, ns
, filter, long):
853 """list all NF instances"""
855 vnf_list(ctx
, ns
, filter, long)
858 @cli_osm.command(name
="nsd-repo-list", short_help
="list all NS from OSM repositories")
863 help="restricts the list to the NS matching the filter",
866 "--repo", default
=None, help="restricts the list to a particular OSM repository"
868 @click.option("--long", is_flag
=True, help="get more details")
870 def nspkg_repo_list(ctx
, filter, repo
, long):
871 """list xNF packages from OSM repositories"""
873 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
876 @cli_osm.command(name
="nspkg-repo-list", short_help
="list all NS from OSM repositories")
881 help="restricts the list to the NS matching the filter",
884 "--repo", default
=None, help="restricts the list to a particular OSM repository"
886 @click.option("--long", is_flag
=True, help="get more details")
888 def nspkg_repo_list2(ctx
, filter, repo
, long):
889 """list xNF packages from OSM repositories"""
891 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
894 @cli_osm.command(name
="nf-list", short_help
="list all NF instances")
896 "--ns", default
=None, help="NS instance id or name to restrict the NF list"
902 help="restricts the list to the NF instances matching the filter.",
904 @click.option("--long", is_flag
=True, help="get more details")
906 def nf_list(ctx
, ns
, filter, long):
907 """list all NF instances
911 --ns TEXT NS instance id or name to restrict the VNF list
912 --filter filterExpr Restricts the list to the VNF instances matching the filter
915 filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
916 concatenated using the "&" character:
919 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
920 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
921 op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
923 value := scalar value
927 * zero or more occurrences
928 ? zero or one occurrence
929 [] grouping of expressions to be used with ? and *
930 "" quotation marks for marking string constants
934 "AttrName" is the name of one attribute in the data type that defines the representation
935 of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
936 <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
937 "Op" stands for the comparison operator. If the expression has concatenated <attrName>
938 entries, it means that the operator "op" is applied to the attribute addressed by the last
939 <attrName> entry included in the concatenation. All simple filter expressions are combined
940 by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
941 the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
942 concatenation of all "attrName" entries except the leaf attribute is called the "attribute
943 prefix". If an attribute referenced in an expression is an array, an object that contains a
944 corresponding array shall be considered to match the expression if any of the elements in the
945 array matches all expressions that have the same attribute prefix.
949 --filter vim-account-id=<VIM_ACCOUNT_ID>
950 --filter vnfd-ref=<VNFD_NAME>
951 --filter vdur.ip-address=<IP_ADDRESS>
952 --filter vnfd-ref=<VNFD_NAME>,vdur.ip-address=<IP_ADDRESS>
955 vnf_list(ctx
, ns
, filter, long)
959 name
="ns-op-list", short_help
="shows the history of operations over a NS instance"
961 @click.argument("name")
963 "--long", is_flag
=True, help="get more details of the NS operation (date, )."
966 def ns_op_list(ctx
, name
, long):
967 """shows the history of operations over a NS instance
969 NAME: name or ID of the NS instance
972 def formatParams(params
):
973 if params
["lcmOperationType"] == "instantiate":
974 params
.pop("nsDescription")
978 elif params
["lcmOperationType"] == "action":
979 params
.pop("primitive")
980 params
.pop("lcmOperationType")
981 params
.pop("nsInstanceId")
986 check_client_version(ctx
.obj
, ctx
.command
.name
)
987 resp
= ctx
.obj
.ns
.list_op(name
)
988 # except ClientException as e:
1006 table
= PrettyTable(
1007 ["id", "operation", "action_name", "status", "date", "detail"]
1010 # print(yaml.safe_dump(resp))
1013 if op
["lcmOperationType"] == "action":
1014 action_name
= op
["operationParams"]["primitive"]
1016 if op
["operationState"] == "PROCESSING":
1017 if op
["queuePosition"] is not None and op
["queuePosition"] > 0:
1018 detail
= "In queue. Current position: {}".format(op
["queuePosition"])
1019 elif op
["lcmOperationType"] in ("instantiate", "terminate"):
1021 detail
= op
["stage"]
1022 elif op
["operationState"] in ("FAILED", "FAILED_TEMP"):
1023 detail
= op
.get("errorMessage", "-")
1024 date
= datetime
.fromtimestamp(op
["startTime"]).strftime("%Y-%m-%dT%H:%M:%S")
1025 last_update
= datetime
.fromtimestamp(op
["statusEnteredTime"]).strftime(
1032 op
["lcmOperationType"],
1035 text
=json
.dumps(formatParams(op
["operationParams"]), indent
=2),
1038 op
["operationState"],
1041 wrap_text(text
=detail
, width
=50),
1048 op
["lcmOperationType"],
1050 op
["operationState"],
1052 wrap_text(text
=detail
or "", width
=50),
1059 def nsi_list(ctx
, filter):
1060 """list all Network Slice Instances"""
1063 check_client_version(ctx
.obj
, ctx
.command
.name
)
1065 filter = "&".join(filter)
1066 resp
= ctx
.obj
.nsi
.list(filter)
1067 # except ClientException as e:
1070 table
= PrettyTable(
1072 "netslice instance name",
1074 "operational status",
1080 nsi_name
= nsi
["name"]
1083 nsi
["operational-status"] if "operational-status" in nsi
else "Not found"
1085 configstatus
= nsi
["config-status"] if "config-status" in nsi
else "Not found"
1087 nsi
["detailed-status"] if "detailed-status" in nsi
else "Not found"
1089 if configstatus
== "config_not_needed":
1090 configstatus
= "configured (no charms)"
1091 table
.add_row([nsi_name
, nsi_id
, opstatus
, configstatus
, detailed_status
])
1096 @cli_osm.command(name
="nsi-list", short_help
="list all Network Slice Instances (NSI)")
1101 help="restricts the list to the Network Slice Instances matching the filter",
1104 def nsi_list1(ctx
, filter):
1105 """list all Network Slice Instances (NSI)"""
1107 nsi_list(ctx
, filter)
1111 name
="netslice-instance-list", short_help
="list all Network Slice Instances (NSI)"
1117 help="restricts the list to the Network Slice Instances matching the filter",
1120 def nsi_list2(ctx
, filter):
1121 """list all Network Slice Instances (NSI)"""
1123 nsi_list(ctx
, filter)
1126 def nst_list(ctx
, filter):
1129 check_client_version(ctx
.obj
, ctx
.command
.name
)
1131 filter = "&".join(filter)
1132 resp
= ctx
.obj
.nst
.list(filter)
1133 # except ClientException as e:
1136 # print(yaml.safe_dump(resp))
1137 table
= PrettyTable(["nst name", "id"])
1139 name
= nst
["name"] if "name" in nst
else "-"
1140 table
.add_row([name
, nst
["_id"]])
1145 @cli_osm.command(name
="nst-list", short_help
="list all Network Slice Templates (NST)")
1150 help="restricts the list to the NST matching the filter",
1153 def nst_list1(ctx
, filter):
1154 """list all Network Slice Templates (NST) in the system"""
1156 nst_list(ctx
, filter)
1160 name
="netslice-template-list", short_help
="list all Network Slice Templates (NST)"
1166 help="restricts the list to the NST matching the filter",
1169 def nst_list2(ctx
, filter):
1170 """list all Network Slice Templates (NST) in the system"""
1172 nst_list(ctx
, filter)
1175 def nsi_op_list(ctx
, name
):
1178 check_client_version(ctx
.obj
, ctx
.command
.name
)
1179 resp
= ctx
.obj
.nsi
.list_op(name
)
1180 # except ClientException as e:
1183 table
= PrettyTable(["id", "operation", "status"])
1185 table
.add_row([op
["id"], op
["lcmOperationType"], op
["operationState"]])
1192 short_help
="shows the history of operations over a Network Slice Instance (NSI)",
1194 @click.argument("name")
1196 def nsi_op_list1(ctx
, name
):
1197 """shows the history of operations over a Network Slice Instance (NSI)
1199 NAME: name or ID of the Network Slice Instance
1202 nsi_op_list(ctx
, name
)
1206 name
="netslice-instance-op-list",
1207 short_help
="shows the history of operations over a Network Slice Instance (NSI)",
1209 @click.argument("name")
1211 def nsi_op_list2(ctx
, name
):
1212 """shows the history of operations over a Network Slice Instance (NSI)
1214 NAME: name or ID of the Network Slice Instance
1217 nsi_op_list(ctx
, name
)
1220 @cli_osm.command(name
="pdu-list", short_help
="list all Physical Deployment Units (PDU)")
1225 help="restricts the list to the Physical Deployment Units matching the filter",
1228 def pdu_list(ctx
, filter):
1229 """list all Physical Deployment Units (PDU)"""
1232 check_client_version(ctx
.obj
, ctx
.command
.name
)
1234 filter = "&".join(filter)
1235 resp
= ctx
.obj
.pdu
.list(filter)
1236 # except ClientException as e:
1239 table
= PrettyTable(["pdu name", "id", "type", "mgmt ip address"])
1241 pdu_name
= pdu
["name"]
1243 pdu_type
= pdu
["type"]
1244 pdu_ipaddress
= "None"
1245 for iface
in pdu
["interfaces"]:
1247 pdu_ipaddress
= iface
["ip-address"]
1249 table
.add_row([pdu_name
, pdu_id
, pdu_type
, pdu_ipaddress
])
1254 ####################
1256 ####################
1259 def nsd_show(ctx
, name
, literal
):
1262 resp
= ctx
.obj
.nsd
.get(name
)
1263 # resp = ctx.obj.nsd.get_individual(name)
1264 # except ClientException as e:
1269 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1272 table
= PrettyTable(["field", "value"])
1273 for k
, v
in list(resp
.items()):
1274 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1279 @cli_osm.command(name
="nsd-show", short_help
="shows the details of a NS package")
1280 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1281 @click.argument("name")
1283 def nsd_show1(ctx
, name
, literal
):
1284 """shows the content of a NSD
1286 NAME: name or ID of the NSD/NSpkg
1289 nsd_show(ctx
, name
, literal
)
1292 @cli_osm.command(name
="nspkg-show", short_help
="shows the details of a NS package")
1293 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1294 @click.argument("name")
1296 def nsd_show2(ctx
, name
, literal
):
1297 """shows the content of a NSD
1299 NAME: name or ID of the NSD/NSpkg
1302 nsd_show(ctx
, name
, literal
)
1305 def vnfd_show(ctx
, name
, literal
):
1308 resp
= ctx
.obj
.vnfd
.get(name
)
1309 # resp = ctx.obj.vnfd.get_individual(name)
1310 # except ClientException as e:
1315 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1318 table
= PrettyTable(["field", "value"])
1319 for k
, v
in list(resp
.items()):
1320 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1325 def pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
):
1328 filter = "&".join(filter)
1330 resp
= ctx
.obj
.osmrepo
.pkg_get(pkgtype
, name
, repo
, version
, filter)
1333 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1336 catalog
= pkgtype
+ "-catalog"
1337 full_catalog
= pkgtype
+ ":" + catalog
1338 if resp
.get(catalog
):
1339 resp
= resp
.pop(catalog
)[pkgtype
][0]
1340 elif resp
.get(full_catalog
):
1341 resp
= resp
.pop(full_catalog
)[pkgtype
][0]
1343 table
= PrettyTable(["field", "value"])
1344 for k
, v
in list(resp
.items()):
1345 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1350 @cli_osm.command(name
="vnfd-show", short_help
="shows the details of a NF package")
1351 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1352 @click.argument("name")
1354 def vnfd_show1(ctx
, name
, literal
):
1355 """shows the content of a VNFD
1357 NAME: name or ID of the VNFD/VNFpkg
1360 vnfd_show(ctx
, name
, literal
)
1363 @cli_osm.command(name
="vnfpkg-show", short_help
="shows the details of a NF package")
1364 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1365 @click.argument("name")
1367 def vnfd_show2(ctx
, name
, literal
):
1368 """shows the content of a VNFD
1370 NAME: name or ID of the VNFD/VNFpkg
1373 vnfd_show(ctx
, name
, literal
)
1377 name
="vnfpkg-repo-show",
1378 short_help
="shows the details of a NF package in an OSM repository",
1380 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1381 @click.option("--repo", required
=True, help="Repository name")
1382 @click.argument("name")
1383 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1384 @click.option("--version", default
="latest", help="package version")
1386 def vnfd_show3(ctx
, name
, repo
, version
, literal
=None, filter=None):
1387 """shows the content of a VNFD in a repository
1389 NAME: name or ID of the VNFD/VNFpkg
1392 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1396 name
="nsd-repo-show",
1397 short_help
="shows the details of a NS package in an OSM repository",
1399 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1400 @click.option("--repo", required
=True, help="Repository name")
1401 @click.argument("name")
1402 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1403 @click.option("--version", default
="latest", help="package version")
1405 def nsd_repo_show(ctx
, name
, repo
, version
, literal
=None, filter=None):
1406 """shows the content of a VNFD in a repository
1408 NAME: name or ID of the VNFD/VNFpkg
1411 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1415 name
="nspkg-repo-show",
1416 short_help
="shows the details of a NS package in an OSM repository",
1418 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1419 @click.option("--repo", required
=True, help="Repository name")
1420 @click.argument("name")
1421 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1422 @click.option("--version", default
="latest", help="package version")
1424 def nsd_repo_show2(ctx
, name
, repo
, version
, literal
=None, filter=None):
1425 """shows the content of a VNFD in a repository
1427 NAME: name or ID of the VNFD/VNFpkg
1430 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1433 @cli_osm.command(name
="nfpkg-show", short_help
="shows the details of a NF package")
1434 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1435 @click.argument("name")
1437 def nfpkg_show(ctx
, name
, literal
):
1438 """shows the content of a NF Descriptor
1440 NAME: name or ID of the NFpkg
1443 vnfd_show(ctx
, name
, literal
)
1447 name
="nfpkg-repo-show",
1448 short_help
="shows the details of a NF package in an OSM repository",
1450 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1451 @click.option("--repo", required
=True, help="Repository name")
1452 @click.argument("name")
1453 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1454 @click.option("--version", default
="latest", help="package version")
1456 def vnfd_show4(ctx
, name
, repo
, version
, literal
=None, filter=None):
1457 """shows the content of a VNFD in a repository
1459 NAME: name or ID of the VNFD/VNFpkg
1462 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1465 @cli_osm.command(name
="ns-show", short_help
="shows the info of a NS instance")
1466 @click.argument("name")
1467 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1471 help="restricts the information to the fields in the filter",
1474 def ns_show(ctx
, name
, literal
, filter):
1475 """shows the info of a NS instance
1477 NAME: name or ID of the NS instance
1481 ns
= ctx
.obj
.ns
.get(name
)
1482 # except ClientException as e:
1487 print(yaml
.safe_dump(ns
, indent
=4, default_flow_style
=False))
1490 table
= PrettyTable(["field", "value"])
1492 for k
, v
in list(ns
.items()):
1493 if not filter or k
in filter:
1494 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1496 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
1497 if fullclassname
!= "osmclient.sol005.client.Client":
1498 nsopdata
= ctx
.obj
.ns
.get_opdata(ns
["id"])
1499 nsr_optdata
= nsopdata
["nsr:nsr"]
1500 for k
, v
in list(nsr_optdata
.items()):
1501 if not filter or k
in filter:
1502 table
.add_row([k
, wrap_text(json
.dumps(v
, indent
=2), width
=100)])
1507 @cli_osm.command(name
="vnf-show", short_help
="shows the info of a VNF 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",
1515 @click.option("--kdu", default
=None, help="KDU name (whose status will be shown)")
1517 def vnf_show(ctx
, name
, literal
, filter, kdu
):
1518 """shows the info of a VNF instance
1520 NAME: name or ID of the VNF instance
1523 def print_kdu_status(op_info_status
):
1524 """print KDU status properly formatted"""
1526 op_status
= yaml
.safe_load(op_info_status
)
1528 "namespace" in op_status
1529 and "info" in op_status
1530 and "last_deployed" in op_status
["info"]
1531 and "status" in op_status
["info"]
1532 and "code" in op_status
["info"]["status"]
1533 and "resources" in op_status
["info"]["status"]
1534 and "seconds" in op_status
["info"]["last_deployed"]
1536 last_deployed_time
= datetime
.fromtimestamp(
1537 op_status
["info"]["last_deployed"]["seconds"]
1538 ).strftime("%a %b %d %I:%M:%S %Y")
1539 print("LAST DEPLOYED: {}".format(last_deployed_time
))
1540 print("NAMESPACE: {}".format(op_status
["namespace"]))
1541 status_code
= "UNKNOWN"
1542 if op_status
["info"]["status"]["code"] == 1:
1543 status_code
= "DEPLOYED"
1544 print("STATUS: {}".format(status_code
))
1547 print(op_status
["info"]["status"]["resources"])
1548 if "notes" in op_status
["info"]["status"]:
1550 print(op_status
["info"]["status"]["notes"])
1552 print(op_info_status
)
1554 print(op_info_status
)
1559 raise ClientException(
1560 '"--literal" option is incompatible with "--kdu" option'
1563 raise ClientException(
1564 '"--filter" option is incompatible with "--kdu" option'
1568 check_client_version(ctx
.obj
, ctx
.command
.name
)
1569 resp
= ctx
.obj
.vnf
.get(name
)
1572 ns_id
= resp
["nsr-id-ref"]
1574 op_data
["member_vnf_index"] = resp
["member-vnf-index-ref"]
1575 op_data
["kdu_name"] = kdu
1576 op_data
["primitive"] = "status"
1577 op_data
["primitive_params"] = {}
1578 op_id
= ctx
.obj
.ns
.exec_op(ns_id
, op_name
="action", op_data
=op_data
, wait
=False)
1581 op_info
= ctx
.obj
.ns
.get_op(op_id
)
1582 if op_info
["operationState"] == "COMPLETED":
1583 print_kdu_status(op_info
["detailed-status"])
1587 print("Could not determine KDU status")
1591 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1594 table
= PrettyTable(["field", "value"])
1595 for k
, v
in list(resp
.items()):
1596 if not filter or k
in filter:
1597 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1600 # except ClientException as e:
1605 # @cli_osm.command(name='vnf-monitoring-show')
1606 # @click.argument('vnf_name')
1607 # @click.pass_context
1608 # def vnf_monitoring_show(ctx, vnf_name):
1610 # check_client_version(ctx.obj, ctx.command.name, 'v1')
1611 # resp = ctx.obj.vnf.get_monitoring(vnf_name)
1612 # except ClientException as e:
1616 # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
1617 # if resp is not None:
1618 # for monitor in resp:
1622 # monitor['value-integer'],
1623 # monitor['units']])
1628 # @cli_osm.command(name='ns-monitoring-show')
1629 # @click.argument('ns_name')
1630 # @click.pass_context
1631 # def ns_monitoring_show(ctx, ns_name):
1633 # check_client_version(ctx.obj, ctx.command.name, 'v1')
1634 # resp = ctx.obj.ns.get_monitoring(ns_name)
1635 # except ClientException as e:
1639 # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
1640 # for key, val in list(resp.items()):
1641 # for monitor in val:
1645 # monitor['value-integer'],
1646 # monitor['units']])
1651 @cli_osm.command(name
="ns-op-show", short_help
="shows the info of a NS operation")
1652 @click.argument("id")
1656 help="restricts the information to the fields in the filter",
1658 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1660 def ns_op_show(ctx
, id, filter, literal
):
1661 """shows the detailed info of a NS operation
1663 ID: operation identifier
1667 check_client_version(ctx
.obj
, ctx
.command
.name
)
1668 op_info
= ctx
.obj
.ns
.get_op(id)
1669 # except ClientException as e:
1674 print(yaml
.safe_dump(op_info
, indent
=4, default_flow_style
=False))
1677 table
= PrettyTable(["field", "value"])
1678 for k
, v
in list(op_info
.items()):
1679 if not filter or k
in filter:
1680 table
.add_row([k
, wrap_text(json
.dumps(v
, indent
=2), 100)])
1685 def nst_show(ctx
, name
, literal
):
1688 check_client_version(ctx
.obj
, ctx
.command
.name
)
1689 resp
= ctx
.obj
.nst
.get(name
)
1690 # resp = ctx.obj.nst.get_individual(name)
1691 # except ClientException as e:
1696 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1699 table
= PrettyTable(["field", "value"])
1700 for k
, v
in list(resp
.items()):
1701 table
.add_row([k
, wrap_text(json
.dumps(v
, indent
=2), 100)])
1707 name
="nst-show", short_help
="shows the content of a Network Slice Template (NST)"
1709 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1710 @click.argument("name")
1712 def nst_show1(ctx
, name
, literal
):
1713 """shows the content of a Network Slice Template (NST)
1715 NAME: name or ID of the NST
1718 nst_show(ctx
, name
, literal
)
1722 name
="netslice-template-show",
1723 short_help
="shows the content of a Network Slice Template (NST)",
1725 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1726 @click.argument("name")
1728 def nst_show2(ctx
, name
, literal
):
1729 """shows the content of a Network Slice Template (NST)
1731 NAME: name or ID of the NST
1734 nst_show(ctx
, name
, literal
)
1737 def nsi_show(ctx
, name
, literal
, filter):
1740 check_client_version(ctx
.obj
, ctx
.command
.name
)
1741 nsi
= ctx
.obj
.nsi
.get(name
)
1742 # except ClientException as e:
1747 print(yaml
.safe_dump(nsi
, indent
=4, default_flow_style
=False))
1750 table
= PrettyTable(["field", "value"])
1752 for k
, v
in list(nsi
.items()):
1753 if not filter or k
in filter:
1754 table
.add_row([k
, json
.dumps(v
, indent
=2)])
1761 name
="nsi-show", short_help
="shows the content of a Network Slice Instance (NSI)"
1763 @click.argument("name")
1764 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1768 help="restricts the information to the fields in the filter",
1771 def nsi_show1(ctx
, name
, literal
, filter):
1772 """shows the content of a Network Slice Instance (NSI)
1774 NAME: name or ID of the Network Slice Instance
1777 nsi_show(ctx
, name
, literal
, filter)
1781 name
="netslice-instance-show",
1782 short_help
="shows the content of a Network Slice Instance (NSI)",
1784 @click.argument("name")
1785 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1789 help="restricts the information to the fields in the filter",
1792 def nsi_show2(ctx
, name
, literal
, filter):
1793 """shows the content of a Network Slice Instance (NSI)
1795 NAME: name or ID of the Network Slice Instance
1798 nsi_show(ctx
, name
, literal
, filter)
1801 def nsi_op_show(ctx
, id, filter):
1804 check_client_version(ctx
.obj
, ctx
.command
.name
)
1805 op_info
= ctx
.obj
.nsi
.get_op(id)
1806 # except ClientException as e:
1810 table
= PrettyTable(["field", "value"])
1811 for k
, v
in list(op_info
.items()):
1812 if not filter or k
in filter:
1813 table
.add_row([k
, json
.dumps(v
, indent
=2)])
1820 short_help
="shows the info of an operation over a Network Slice Instance(NSI)",
1822 @click.argument("id")
1826 help="restricts the information to the fields in the filter",
1829 def nsi_op_show1(ctx
, id, filter):
1830 """shows the info of an operation over a Network Slice Instance(NSI)
1832 ID: operation identifier
1835 nsi_op_show(ctx
, id, filter)
1839 name
="netslice-instance-op-show",
1840 short_help
="shows the info of an operation over a Network Slice Instance(NSI)",
1842 @click.argument("id")
1846 help="restricts the information to the fields in the filter",
1849 def nsi_op_show2(ctx
, id, filter):
1850 """shows the info of an operation over a Network Slice Instance(NSI)
1852 ID: operation identifier
1855 nsi_op_show(ctx
, id, filter)
1859 name
="pdu-show", short_help
="shows the content of a Physical Deployment Unit (PDU)"
1861 @click.argument("name")
1862 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1866 help="restricts the information to the fields in the filter",
1869 def pdu_show(ctx
, name
, literal
, filter):
1870 """shows the content of a Physical Deployment Unit (PDU)
1872 NAME: name or ID of the PDU
1876 check_client_version(ctx
.obj
, ctx
.command
.name
)
1877 pdu
= ctx
.obj
.pdu
.get(name
)
1878 # except ClientException as e:
1883 print(yaml
.safe_dump(pdu
, indent
=4, default_flow_style
=False))
1886 table
= PrettyTable(["field", "value"])
1888 for k
, v
in list(pdu
.items()):
1889 if not filter or k
in filter:
1890 table
.add_row([k
, json
.dumps(v
, indent
=2)])
1896 ####################
1898 ####################
1901 def nsd_create(ctx
, filename
, overwrite
, skip_charm_build
, repo
, vendor
, version
):
1904 check_client_version(ctx
.obj
, ctx
.command
.name
)
1906 filename
= ctx
.obj
.osmrepo
.get_pkg("ns", filename
, repo
, vendor
, version
)
1907 ctx
.obj
.nsd
.create(filename
, overwrite
=overwrite
, skip_charm_build
=skip_charm_build
)
1908 # except ClientException as e:
1913 @cli_osm.command(name
="nsd-create", short_help
="creates a new NSD/NSpkg")
1914 @click.argument("filename")
1918 default
=None, # hidden=True,
1919 help="Deprecated. Use override",
1925 help="overrides fields in descriptor, format: "
1926 '"key1.key2...=value[;key3...=value;...]"',
1929 "--skip-charm-build",
1932 help="The charm will not be compiled, it is assumed to already exist",
1934 @click.option("--repo", default
=None, help="[repository]: Repository name")
1935 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
1939 help="[repository]: filter by version. Default: latest",
1942 def nsd_create1(ctx
, filename
, overwrite
, skip_charm_build
, repo
, vendor
, version
):
1943 """onboards a new NSpkg (alias of nspkg-create) (TO BE DEPRECATED)
1946 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
1947 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
1948 If FILENAME is an NF Package folder, it is built and then onboarded.
1954 overwrite
=overwrite
,
1955 skip_charm_build
=skip_charm_build
,
1962 @cli_osm.command(name
="nspkg-create", short_help
="creates a new NSD/NSpkg")
1963 @click.argument("filename")
1967 default
=None, # hidden=True,
1968 help="Deprecated. Use override",
1974 help="overrides fields in descriptor, format: "
1975 '"key1.key2...=value[;key3...=value;...]"',
1978 "--skip-charm-build",
1981 help="The charm will not be compiled, it is assumed to already exist",
1983 @click.option("--repo", default
=None, help="[repository]: Repository name")
1984 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
1988 help="[repository]: filter by version. Default: latest",
1991 def nsd_pkg_create(ctx
, filename
, overwrite
, skip_charm_build
, repo
, vendor
, version
):
1992 """onboards a new NSpkg
1994 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
1995 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
1996 If FILENAME is an NF Package folder, it is built and then onboarded.
2002 overwrite
=overwrite
,
2003 skip_charm_build
=skip_charm_build
,
2024 check_client_version(ctx
.obj
, ctx
.command
.name
)
2026 filename
= ctx
.obj
.osmrepo
.get_pkg("vnf", filename
, repo
, vendor
, version
)
2027 ctx
.obj
.vnfd
.create(
2029 overwrite
=overwrite
,
2030 skip_charm_build
=skip_charm_build
,
2031 override_epa
=override_epa
,
2032 override_nonepa
=override_nonepa
,
2033 override_paravirt
=override_paravirt
,
2035 # except ClientException as e:
2040 @cli_osm.command(name
="vnfd-create", short_help
="creates a new VNFD/VNFpkg")
2041 @click.argument("filename")
2043 "--overwrite", "overwrite", default
=None, help="overwrite deprecated, use override"
2049 help="overrides fields in descriptor, format: "
2050 '"key1.key2...=value[;key3...=value;...]"',
2053 "--skip-charm-build",
2056 help="The charm will not be compiled, it is assumed to already exist",
2063 help="adds guest-epa parameters to all VDU",
2066 "--override-nonepa",
2070 help="removes all guest-epa parameters from all VDU",
2073 "--override-paravirt",
2077 help="overrides all VDU interfaces to PARAVIRT",
2079 @click.option("--repo", default
=None, help="[repository]: Repository name")
2080 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2084 help="[repository]: filter by version. Default: latest",
2099 """creates a new VNFD/VNFpkg
2101 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2102 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2103 If FILENAME is an NF Package folder, it is built and then onboarded.
2109 overwrite
=overwrite
,
2110 skip_charm_build
=skip_charm_build
,
2111 override_epa
=override_epa
,
2112 override_nonepa
=override_nonepa
,
2113 override_paravirt
=override_paravirt
,
2120 @cli_osm.command(name
="vnfpkg-create", short_help
="creates a new VNFD/VNFpkg")
2121 @click.argument("filename")
2125 default
=None, # hidden=True,
2126 help="Deprecated. Use override",
2132 help="overrides fields in descriptor, format: "
2133 '"key1.key2...=value[;key3...=value;...]"',
2136 "--skip-charm-build",
2139 help="The charm will not be compiled, it is assumed to already exist",
2146 help="adds guest-epa parameters to all VDU",
2149 "--override-nonepa",
2153 help="removes all guest-epa parameters from all VDU",
2156 "--override-paravirt",
2160 help="overrides all VDU interfaces to PARAVIRT",
2162 @click.option("--repo", default
=None, help="[repository]: Repository name")
2163 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2167 help="[repository]: filter by version. Default: latest",
2182 """creates a new VNFD/VNFpkg
2184 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2185 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2186 If FILENAME is an NF Package folder, it is built and then onboarded.
2192 overwrite
=overwrite
,
2193 skip_charm_build
=skip_charm_build
,
2194 override_epa
=override_epa
,
2195 override_nonepa
=override_nonepa
,
2196 override_paravirt
=override_paravirt
,
2203 @cli_osm.command(name
="nfpkg-create", short_help
="creates a new NFpkg")
2204 @click.argument("filename")
2208 default
=None, # hidden=True,
2209 help="Deprecated. Use override",
2215 help="overrides fields in descriptor, format: "
2216 '"key1.key2...=value[;key3...=value;...]"',
2219 "--skip-charm-build",
2222 help="The charm will not be compiled, it is assumed to already exist",
2229 help="adds guest-epa parameters to all VDU",
2232 "--override-nonepa",
2236 help="removes all guest-epa parameters from all VDU",
2239 "--override-paravirt",
2243 help="overrides all VDU interfaces to PARAVIRT",
2245 @click.option("--repo", default
=None, help="[repository]: Repository name")
2246 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2250 help="[repository]: filter by version. Default: latest",
2265 """creates a new NFpkg
2268 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2269 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2270 If FILENAME is an NF Package folder, it is built and then onboarded.
2276 overwrite
=overwrite
,
2277 skip_charm_build
=skip_charm_build
,
2278 override_epa
=override_epa
,
2279 override_nonepa
=override_nonepa
,
2280 override_paravirt
=override_paravirt
,
2287 @cli_osm.command(name
="ns-create", short_help
="creates a new Network Service instance")
2288 @click.option("--ns_name", prompt
=True, help="name of the NS instance")
2289 @click.option("--nsd_name", prompt
=True, help="name of the NS descriptor")
2293 help="default VIM account id or name for the deployment",
2295 @click.option("--admin_status", default
="ENABLED", help="administration status")
2299 help="comma separated list of public key files to inject to vnfs",
2301 @click.option("--config", default
=None, help="ns specific yaml configuration")
2302 @click.option("--config_file", default
=None, help="ns specific yaml configuration file")
2308 help="do not return the control immediately, but keep it "
2309 "until the operation is completed, or timeout",
2311 @click.option("--timeout", default
=None, help="ns deployment timeout")
2325 """creates a new NS instance"""
2329 check_client_version(ctx
.obj
, "--config_file")
2331 raise ClientException(
2332 '"--config" option is incompatible with "--config_file" option'
2334 with
open(config_file
, "r") as cf
:
2341 account
=vim_account
,
2345 # except ClientException as e:
2350 def nst_create(ctx
, filename
, overwrite
):
2353 check_client_version(ctx
.obj
, ctx
.command
.name
)
2354 ctx
.obj
.nst
.create(filename
, overwrite
)
2355 # except ClientException as e:
2361 name
="nst-create", short_help
="creates a new Network Slice Template (NST)"
2363 @click.argument("filename")
2367 default
=None, # hidden=True,
2368 help="Deprecated. Use override",
2374 help="overrides fields in descriptor, format: "
2375 '"key1.key2...=value[;key3...=value;...]"',
2378 def nst_create1(ctx
, filename
, overwrite
):
2379 """creates a new Network Slice Template (NST)
2381 FILENAME: NST package folder, NST yaml file or NSTpkg tar.gz file
2384 nst_create(ctx
, filename
, overwrite
)
2388 name
="netslice-template-create",
2389 short_help
="creates a new Network Slice Template (NST)",
2391 @click.argument("filename")
2395 default
=None, # hidden=True,
2396 help="Deprecated. Use override",
2402 help="overrides fields in descriptor, format: "
2403 '"key1.key2...=value[;key3...=value;...]"',
2406 def nst_create2(ctx
, filename
, overwrite
):
2407 """creates a new Network Slice Template (NST)
2409 FILENAME: NST yaml file or NSTpkg tar.gz file
2412 nst_create(ctx
, filename
, overwrite
)
2416 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
2418 """creates a new Network Slice Instance (NSI)"""
2421 check_client_version(ctx
.obj
, ctx
.command
.name
)
2424 raise ClientException(
2425 '"--config" option is incompatible with "--config_file" option'
2427 with
open(config_file
, "r") as cf
:
2434 account
=vim_account
,
2437 # except ClientException as e:
2442 @cli_osm.command(name
="nsi-create", short_help
="creates a new Network Slice Instance")
2443 @click.option("--nsi_name", prompt
=True, help="name of the Network Slice Instance")
2444 @click.option("--nst_name", prompt
=True, help="name of the Network Slice Template")
2448 help="default VIM account id or name for the deployment",
2451 "--ssh_keys", default
=None, help="comma separated list of keys to inject to vnfs"
2456 help="Netslice specific yaml configuration:\n"
2457 "netslice_subnet: [\n"
2458 "id: TEXT, vim_account: TEXT,\n"
2459 "vnf: [member-vnf-index: TEXT, vim_account: TEXT]\n"
2460 "vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]\n"
2461 "additionalParamsForNsi: {param: value, ...}\n"
2462 "additionalParamsForsubnet: [{id: SUBNET_ID, additionalParamsForNs: {}, additionalParamsForVnf: {}}]\n"
2464 "netslice-vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]",
2467 "--config_file", default
=None, help="nsi specific yaml configuration file"
2474 help="do not return the control immediately, but keep it "
2475 "until the operation is completed, or timeout",
2479 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
2481 """creates a new Network Slice Instance (NSI)"""
2484 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
=wait
2489 name
="netslice-instance-create", short_help
="creates a new Network Slice Instance"
2491 @click.option("--nsi_name", prompt
=True, help="name of the Network Slice Instance")
2492 @click.option("--nst_name", prompt
=True, help="name of the Network Slice Template")
2496 help="default VIM account id or name for the deployment",
2499 "--ssh_keys", default
=None, help="comma separated list of keys to inject to vnfs"
2504 help="Netslice specific yaml configuration:\n"
2505 "netslice_subnet: [\n"
2506 "id: TEXT, vim_account: TEXT,\n"
2507 "vnf: [member-vnf-index: TEXT, vim_account: TEXT]\n"
2508 "vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]"
2510 "netslice-vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]",
2513 "--config_file", default
=None, help="nsi specific yaml configuration file"
2520 help="do not return the control immediately, but keep it "
2521 "until the operation is completed, or timeout",
2525 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
2527 """creates a new Network Slice Instance (NSI)"""
2530 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
=wait
2535 name
="pdu-create", short_help
="adds a new Physical Deployment Unit to the catalog"
2537 @click.option("--name", help="name of the Physical Deployment Unit")
2538 @click.option("--pdu_type", help="type of PDU (e.g. router, firewall, FW001)")
2541 help="interface(s) of the PDU: name=<NAME>,mgmt=<true|false>,ip-address=<IP_ADDRESS>"
2542 + "[,type=<overlay|underlay>][,mac-address=<MAC_ADDRESS>][,vim-network-name=<VIM_NET_NAME>]",
2545 @click.option("--description", help="human readable description")
2548 help="list of VIM accounts (in the same VIM) that can reach this PDU\n"
2549 + "The format for multiple VIMs is --vim_account <vim_account_id_1> "
2550 + "--vim_account <vim_account_id_2> ... --vim_account <vim_account_id_N>",
2554 "--descriptor_file",
2556 help="PDU descriptor file (as an alternative to using the other arguments)",
2560 ctx
, name
, pdu_type
, interface
, description
, vim_account
, descriptor_file
2562 """creates a new Physical Deployment Unit (PDU)"""
2565 check_client_version(ctx
.obj
, ctx
.command
.name
)
2567 pdu
= create_pdu_dictionary(
2568 name
, pdu_type
, interface
, description
, vim_account
, descriptor_file
2570 ctx
.obj
.pdu
.create(pdu
)
2573 ########################
2574 # UPDATE PDU operation #
2575 ########################
2579 name
="pdu-update", short_help
="updates a Physical Deployment Unit to the catalog"
2581 @click.argument("name")
2582 @click.option("--newname", help="New name for the Physical Deployment Unit")
2583 @click.option("--pdu_type", help="type of PDU (e.g. router, firewall, FW001)")
2586 help="interface(s) of the PDU: name=<NAME>,mgmt=<true|false>,ip-address=<IP_ADDRESS>"
2587 + "[,type=<overlay|underlay>][,mac-address=<MAC_ADDRESS>][,vim-network-name=<VIM_NET_NAME>]",
2590 @click.option("--description", help="human readable description")
2593 help="list of VIM accounts (in the same VIM) that can reach this PDU\n"
2594 + "The format for multiple VIMs is --vim_account <vim_account_id_1> "
2595 + "--vim_account <vim_account_id_2> ... --vim_account <vim_account_id_N>",
2599 "--descriptor_file",
2601 help="PDU descriptor file (as an alternative to using the other arguments)",
2605 ctx
, name
, newname
, pdu_type
, interface
, description
, vim_account
, descriptor_file
2607 """Updates a new Physical Deployment Unit (PDU)"""
2610 check_client_version(ctx
.obj
, ctx
.command
.name
)
2617 pdu
= create_pdu_dictionary(
2618 newname
, pdu_type
, interface
, description
, vim_account
, descriptor_file
, update
2620 ctx
.obj
.pdu
.update(name
, pdu
)
2623 def create_pdu_dictionary(
2624 name
, pdu_type
, interface
, description
, vim_account
, descriptor_file
, update
=False
2629 if not descriptor_file
:
2632 raise ClientException(
2633 'in absence of descriptor file, option "--name" is mandatory'
2636 raise ClientException(
2637 'in absence of descriptor file, option "--pdu_type" is mandatory'
2640 raise ClientException(
2641 'in absence of descriptor file, option "--interface" is mandatory (at least once)'
2644 raise ClientException(
2645 'in absence of descriptor file, option "--vim_account" is mandatory (at least once)'
2648 with
open(descriptor_file
, "r") as df
:
2649 pdu
= yaml
.safe_load(df
.read())
2653 pdu
["type"] = pdu_type
2655 pdu
["description"] = description
2657 pdu
["vim_accounts"] = vim_account
2660 for iface
in interface
:
2661 new_iface
= {k
: v
for k
, v
in [i
.split("=") for i
in iface
.split(",")]}
2662 new_iface
["mgmt"] = new_iface
.get("mgmt", "false").lower() == "true"
2663 ifaces_list
.append(new_iface
)
2664 pdu
["interfaces"] = ifaces_list
2668 ####################
2670 ####################
2673 def nsd_update(ctx
, name
, content
):
2676 check_client_version(ctx
.obj
, ctx
.command
.name
)
2677 ctx
.obj
.nsd
.update(name
, content
)
2678 # except ClientException as e:
2683 @cli_osm.command(name
="nsd-update", short_help
="updates a NSD/NSpkg")
2684 @click.argument("name")
2688 help="filename with the NSD/NSpkg replacing the current one",
2691 def nsd_update1(ctx
, name
, content
):
2692 """updates a NSD/NSpkg
2694 NAME: name or ID of the NSD/NSpkg
2697 nsd_update(ctx
, name
, content
)
2700 @cli_osm.command(name
="nspkg-update", short_help
="updates a NSD/NSpkg")
2701 @click.argument("name")
2705 help="filename with the NSD/NSpkg replacing the current one",
2708 def nsd_update2(ctx
, name
, content
):
2709 """updates a NSD/NSpkg
2711 NAME: name or ID of the NSD/NSpkg
2714 nsd_update(ctx
, name
, content
)
2717 def vnfd_update(ctx
, name
, content
):
2720 check_client_version(ctx
.obj
, ctx
.command
.name
)
2721 ctx
.obj
.vnfd
.update(name
, content
)
2722 # except ClientException as e:
2727 @cli_osm.command(name
="vnfd-update", short_help
="updates a new VNFD/VNFpkg")
2728 @click.argument("name")
2732 help="filename with the VNFD/VNFpkg replacing the current one",
2735 def vnfd_update1(ctx
, name
, content
):
2736 """updates a VNFD/VNFpkg
2738 NAME: name or ID of the VNFD/VNFpkg
2741 vnfd_update(ctx
, name
, content
)
2744 @cli_osm.command(name
="vnfpkg-update", short_help
="updates a VNFD/VNFpkg")
2745 @click.argument("name")
2749 help="filename with the VNFD/VNFpkg replacing the current one",
2752 def vnfd_update2(ctx
, name
, content
):
2753 """updates a VNFD/VNFpkg
2755 NAME: VNFD yaml file or VNFpkg tar.gz file
2758 vnfd_update(ctx
, name
, content
)
2761 @cli_osm.command(name
="nfpkg-update", short_help
="updates a NFpkg")
2762 @click.argument("name")
2764 "--content", default
=None, help="filename with the NFpkg replacing the current one"
2767 def nfpkg_update(ctx
, name
, content
):
2770 NAME: NF Descriptor yaml file or NFpkg tar.gz file
2773 vnfd_update(ctx
, name
, content
)
2776 def nst_update(ctx
, name
, content
):
2779 check_client_version(ctx
.obj
, ctx
.command
.name
)
2780 ctx
.obj
.nst
.update(name
, content
)
2781 # except ClientException as e:
2786 @cli_osm.command(name
="nst-update", short_help
="updates a Network Slice Template (NST)")
2787 @click.argument("name")
2791 help="filename with the NST/NSTpkg replacing the current one",
2794 def nst_update1(ctx
, name
, content
):
2795 """updates a Network Slice Template (NST)
2797 NAME: name or ID of the NSD/NSpkg
2800 nst_update(ctx
, name
, content
)
2804 name
="netslice-template-update", short_help
="updates a Network Slice Template (NST)"
2806 @click.argument("name")
2810 help="filename with the NST/NSTpkg replacing the current one",
2813 def nst_update2(ctx
, name
, content
):
2814 """updates a Network Slice Template (NST)
2816 NAME: name or ID of the NSD/NSpkg
2819 nst_update(ctx
, name
, content
)
2822 ####################
2824 ####################
2827 def nsd_delete(ctx
, name
, force
):
2831 ctx
.obj
.nsd
.delete(name
)
2833 check_client_version(ctx
.obj
, "--force")
2834 ctx
.obj
.nsd
.delete(name
, force
)
2835 # except ClientException as e:
2840 @cli_osm.command(name
="nsd-delete", short_help
="deletes a NSD/NSpkg")
2841 @click.argument("name")
2843 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2846 def nsd_delete1(ctx
, name
, force
):
2847 """deletes a NSD/NSpkg
2849 NAME: name or ID of the NSD/NSpkg to be deleted
2852 nsd_delete(ctx
, name
, force
)
2855 @cli_osm.command(name
="nspkg-delete", short_help
="deletes a NSD/NSpkg")
2856 @click.argument("name")
2858 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2861 def nsd_delete2(ctx
, name
, force
):
2862 """deletes a NSD/NSpkg
2864 NAME: name or ID of the NSD/NSpkg to be deleted
2867 nsd_delete(ctx
, name
, force
)
2870 def vnfd_delete(ctx
, name
, force
):
2874 ctx
.obj
.vnfd
.delete(name
)
2876 check_client_version(ctx
.obj
, "--force")
2877 ctx
.obj
.vnfd
.delete(name
, force
)
2878 # except ClientException as e:
2883 @cli_osm.command(name
="vnfd-delete", short_help
="deletes a VNFD/VNFpkg")
2884 @click.argument("name")
2886 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2889 def vnfd_delete1(ctx
, name
, force
):
2890 """deletes a VNFD/VNFpkg
2892 NAME: name or ID of the VNFD/VNFpkg to be deleted
2895 vnfd_delete(ctx
, name
, force
)
2898 @cli_osm.command(name
="vnfpkg-delete", short_help
="deletes a VNFD/VNFpkg")
2899 @click.argument("name")
2901 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2904 def vnfd_delete2(ctx
, name
, force
):
2905 """deletes a VNFD/VNFpkg
2907 NAME: name or ID of the VNFD/VNFpkg to be deleted
2910 vnfd_delete(ctx
, name
, force
)
2913 @cli_osm.command(name
="nfpkg-delete", short_help
="deletes a NFpkg")
2914 @click.argument("name")
2916 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2919 def nfpkg_delete(ctx
, name
, force
):
2922 NAME: name or ID of the NFpkg to be deleted
2925 vnfd_delete(ctx
, name
, force
)
2928 @cli_osm.command(name
="ns-delete", short_help
="deletes a NS instance")
2929 @click.argument("name")
2931 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2936 help="specific yaml configuration for the termination, e.g. '{autoremove: False, timeout_ns_terminate: "
2937 "600, skip_terminate_primitives: True}'",
2944 help="do not return the control immediately, but keep it "
2945 "until the operation is completed, or timeout",
2948 def ns_delete(ctx
, name
, force
, config
, wait
):
2949 """deletes a NS instance
2951 NAME: name or ID of the NS instance to be deleted
2956 ctx
.obj
.ns
.delete(name
, config
=config
, wait
=wait
)
2958 check_client_version(ctx
.obj
, "--force")
2959 ctx
.obj
.ns
.delete(name
, force
, config
=config
, wait
=wait
)
2960 # except ClientException as e:
2965 def nst_delete(ctx
, name
, force
):
2968 check_client_version(ctx
.obj
, ctx
.command
.name
)
2969 ctx
.obj
.nst
.delete(name
, force
)
2970 # except ClientException as e:
2975 @cli_osm.command(name
="nst-delete", short_help
="deletes a Network Slice Template (NST)")
2976 @click.argument("name")
2978 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2981 def nst_delete1(ctx
, name
, force
):
2982 """deletes a Network Slice Template (NST)
2984 NAME: name or ID of the NST/NSTpkg to be deleted
2987 nst_delete(ctx
, name
, force
)
2991 name
="netslice-template-delete", short_help
="deletes a Network Slice Template (NST)"
2993 @click.argument("name")
2995 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2998 def nst_delete2(ctx
, name
, force
):
2999 """deletes a Network Slice Template (NST)
3001 NAME: name or ID of the NST/NSTpkg to be deleted
3004 nst_delete(ctx
, name
, force
)
3007 def nsi_delete(ctx
, name
, force
, wait
):
3010 check_client_version(ctx
.obj
, ctx
.command
.name
)
3011 ctx
.obj
.nsi
.delete(name
, force
, wait
=wait
)
3012 # except ClientException as e:
3017 @cli_osm.command(name
="nsi-delete", short_help
="deletes a Network Slice Instance (NSI)")
3018 @click.argument("name")
3020 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3027 help="do not return the control immediately, but keep it "
3028 "until the operation is completed, or timeout",
3031 def nsi_delete1(ctx
, name
, force
, wait
):
3032 """deletes a Network Slice Instance (NSI)
3034 NAME: name or ID of the Network Slice instance to be deleted
3037 nsi_delete(ctx
, name
, force
, wait
=wait
)
3041 name
="netslice-instance-delete", short_help
="deletes a Network Slice Instance (NSI)"
3043 @click.argument("name")
3045 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3048 def nsi_delete2(ctx
, name
, force
, wait
):
3049 """deletes a Network Slice Instance (NSI)
3051 NAME: name or ID of the Network Slice instance to be deleted
3054 nsi_delete(ctx
, name
, force
, wait
=wait
)
3058 name
="pdu-delete", short_help
="deletes a Physical Deployment Unit (PDU)"
3060 @click.argument("name")
3062 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3065 def pdu_delete(ctx
, name
, force
):
3066 """deletes a Physical Deployment Unit (PDU)
3068 NAME: name or ID of the PDU to be deleted
3072 check_client_version(ctx
.obj
, ctx
.command
.name
)
3073 ctx
.obj
.pdu
.delete(name
, force
)
3074 # except ClientException as e:
3084 @cli_osm.command(name
="vim-create", short_help
="creates a new VIM account")
3085 @click.option("--name", required
=True, help="Name to create datacenter")
3086 @click.option("--user", default
=None, help="VIM username")
3087 @click.option("--password", default
=None, help="VIM password")
3088 @click.option("--auth_url", default
=None, help="VIM url")
3090 "--tenant", "--project", "tenant", default
=None, help="VIM tenant/project name"
3092 @click.option("--config", default
=None, help="VIM specific config parameters")
3096 help="VIM specific config parameters in YAML or JSON file",
3098 @click.option("--account_type", default
="openstack", help="VIM type")
3099 @click.option("--description", default
=None, help="human readable description")
3103 help="Name or id of the SDN controller associated to this VIM account",
3106 "--sdn_port_mapping",
3108 help="File describing the port mapping between compute nodes' ports and switch ports",
3115 help="do not return the control immediately, but keep it "
3116 "until the operation is completed, or timeout",
3118 @click.option("--vca", default
=None, help="VCA to be used in this VIM account")
3120 "--creds", default
=None, help="credentials file (only applycable for GCP VIM type)"
3123 "--prometheus_config_file",
3125 help="Prometheus configuration to get VIM data",
3144 prometheus_config_file
,
3146 """creates a new VIM account"""
3150 check_client_version(ctx
.obj
, "--sdn_controller")
3151 if sdn_port_mapping
:
3152 check_client_version(ctx
.obj
, "--sdn_port_mapping")
3154 if prometheus_config_file
:
3155 with
open(prometheus_config_file
) as prometheus_file
:
3156 prometheus_config_dict
= json
.load(prometheus_file
)
3157 vim
["prometheus-config"] = prometheus_config_dict
3159 vim
["vim-username"] = user
3160 vim
["vim-password"] = password
3161 vim
["vim-url"] = auth_url
3162 vim
["vim-tenant-name"] = tenant
3163 vim
["vim-type"] = account_type
3164 vim
["description"] = description
3167 vim_config
= create_config(config_file
, config
)
3169 with
open(creds
, "r") as cf
:
3170 vim_config
["credentials"] = yaml
.safe_load(cf
.read())
3172 name
, vim
, vim_config
, sdn_controller
, sdn_port_mapping
, wait
=wait
3174 # except ClientException as e:
3179 @cli_osm.command(name
="vim-update", short_help
="updates a VIM account")
3180 @click.argument("name")
3181 @click.option("--newname", help="New name for the VIM account")
3182 @click.option("--user", help="VIM username")
3183 @click.option("--password", help="VIM password")
3184 @click.option("--auth_url", help="VIM url")
3185 @click.option("--tenant", help="VIM tenant name")
3186 @click.option("--config", help="VIM specific config parameters")
3190 help="VIM specific config parameters in YAML or JSON file",
3192 @click.option("--account_type", help="VIM type")
3193 @click.option("--description", help="human readable description")
3197 help="Name or id of the SDN controller to be associated with this VIM"
3198 "account. Use empty string to disassociate",
3201 "--sdn_port_mapping",
3203 help="File describing the port mapping between compute nodes' ports and switch ports",
3210 help="do not return the control immediately, but keep it "
3211 "until the operation is completed, or timeout",
3214 "--creds", default
=None, help="credentials file (only applycable for GCP VIM type)"
3217 "--prometheus_config_file",
3219 help="Prometheus configuration to get VIM data",
3238 prometheus_config_file
,
3240 """updates a VIM account
3242 NAME: name or ID of the VIM account
3246 check_client_version(ctx
.obj
, ctx
.command
.name
)
3249 vim
["name"] = newname
3251 vim
["vim_user"] = user
3253 vim
["vim_password"] = password
3255 vim
["vim_url"] = auth_url
3257 vim
["vim-tenant-name"] = tenant
3259 vim
["vim_type"] = account_type
3261 vim
["description"] = description
3263 if config
or config_file
:
3264 vim_config
= create_config(config_file
, config
)
3266 with
open(creds
, "r") as cf
:
3267 vim_config
["credentials"] = yaml
.safe_load(cf
.read())
3268 if prometheus_config_file
:
3269 with
open(prometheus_config_file
) as prometheus_file
:
3270 prometheus_config_dict
= json
.load(prometheus_file
)
3271 vim
["prometheus-config"] = prometheus_config_dict
3272 logger
.info(f
"VIM: {vim}, VIM config: {vim_config}")
3274 name
, vim
, vim_config
, sdn_controller
, sdn_port_mapping
, wait
=wait
3276 # except ClientException as e:
3281 @cli_osm.command(name
="vim-delete", short_help
="deletes a VIM account")
3282 @click.argument("name")
3284 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3291 help="do not return the control immediately, but keep it "
3292 "until the operation is completed, or timeout",
3295 def vim_delete(ctx
, name
, force
, wait
):
3296 """deletes a VIM account
3298 NAME: name or ID of the VIM account to be deleted
3303 ctx
.obj
.vim
.delete(name
, wait
=wait
)
3305 check_client_version(ctx
.obj
, "--force")
3306 ctx
.obj
.vim
.delete(name
, force
, wait
=wait
)
3307 # except ClientException as e:
3312 @cli_osm.command(name
="vim-list", short_help
="list all VIM accounts")
3313 # @click.option('--ro_update/--no_ro_update',
3315 # help='update list from RO')
3320 help="restricts the list to the VIM accounts matching the filter",
3325 help="get more details of the NS (project, vim, deployment status, configuration status.",
3328 def vim_list(ctx
, filter, long):
3329 """list all VIM accounts"""
3332 filter = "&".join(filter)
3333 check_client_version(ctx
.obj
, "--filter")
3335 # check_client_version(ctx.obj, '--ro_update', 'v1')
3336 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
3337 if fullclassname
== "osmclient.sol005.client.Client":
3338 resp
= ctx
.obj
.vim
.list(filter)
3340 # resp = ctx.obj.vim.list(ro_update)
3342 table
= PrettyTable(
3343 ["vim name", "uuid", "project", "operational state", "error details"]
3345 project_list
= ctx
.obj
.project
.list()
3347 table
= PrettyTable(["vim name", "uuid", "operational state"])
3350 if "vim_password" in vim
:
3351 vim
["vim_password"] = "********"
3352 if "config" in vim
and "credentials" in vim
["config"]:
3353 vim
["config"]["credentials"] = "********"
3354 logger
.debug("VIM details: {}".format(yaml
.safe_dump(vim
)))
3355 vim_state
= vim
["_admin"].get("operationalState", "-")
3356 error_details
= "N/A"
3357 if vim_state
== "ERROR":
3358 error_details
= vim
["_admin"].get("detailed-status", "Not found")
3359 project_id
, project_name
= get_project(project_list
, vim
)
3360 # project_info = '{} ({})'.format(project_name, project_id)
3361 project_info
= project_name
3368 wrap_text(text
=error_details
, width
=80),
3373 [vim
["name"], vim
["uuid"], vim
["_admin"].get("operationalState", "-")]
3379 @cli_osm.command(name
="vim-show", short_help
="shows the details of a VIM account")
3380 @click.argument("name")
3384 help="restricts the information to the fields in the filter",
3386 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
3388 def vim_show(ctx
, name
, filter, literal
):
3389 """shows the details of a VIM account
3391 NAME: name or ID of the VIM account
3395 resp
= ctx
.obj
.vim
.get(name
)
3396 if "vim_password" in resp
:
3397 resp
["vim_password"] = "********"
3398 if "config" in resp
and "credentials" in resp
["config"]:
3399 resp
["config"]["credentials"] = "********"
3400 # except ClientException as e:
3405 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
3407 table
= PrettyTable(["key", "attribute"])
3408 for k
, v
in list(resp
.items()):
3409 if not filter or k
in filter:
3410 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
3415 ####################
3417 ####################
3420 @cli_osm.command(name
="wim-create", short_help
="creates a new WIM account")
3421 @click.option("--name", prompt
=True, help="Name for the WIM account")
3422 @click.option("--user", help="WIM username")
3423 @click.option("--password", help="WIM password")
3424 @click.option("--url", prompt
=True, help="WIM url")
3425 # @click.option('--tenant',
3426 # help='wIM tenant name')
3427 @click.option("--config", default
=None, help="WIM specific config parameters")
3428 @click.option("--wim_type", help="WIM type")
3429 @click.option("--description", default
=None, help="human readable description")
3431 "--wim_port_mapping",
3433 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
3434 "(WAN service endpoint id and info)",
3441 help="do not return the control immediately, but keep it "
3442 "until the operation is completed, or timeout",
3458 """creates a new WIM account"""
3461 check_client_version(ctx
.obj
, ctx
.command
.name
)
3462 # if sdn_controller:
3463 # check_client_version(ctx.obj, '--sdn_controller')
3464 # if sdn_port_mapping:
3465 # check_client_version(ctx.obj, '--sdn_port_mapping')
3470 wim
["password"] = password
3472 wim
["wim_url"] = url
3473 # if tenant: wim['tenant'] = tenant
3474 wim
["wim_type"] = wim_type
3476 wim
["description"] = description
3478 wim
["config"] = config
3479 ctx
.obj
.wim
.create(name
, wim
, wim_port_mapping
, wait
=wait
)
3480 # except ClientException as e:
3485 @cli_osm.command(name
="wim-update", short_help
="updates a WIM account")
3486 @click.argument("name")
3487 @click.option("--newname", help="New name for the WIM account")
3488 @click.option("--user", help="WIM username")
3489 @click.option("--password", help="WIM password")
3490 @click.option("--url", help="WIM url")
3491 @click.option("--config", help="WIM specific config parameters")
3492 @click.option("--wim_type", help="WIM type")
3493 @click.option("--description", help="human readable description")
3495 "--wim_port_mapping",
3497 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
3498 "(WAN service endpoint id and info)",
3505 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3521 """updates a WIM account
3523 NAME: name or ID of the WIM account
3527 check_client_version(ctx
.obj
, ctx
.command
.name
)
3530 wim
["name"] = newname
3534 wim
["password"] = password
3537 # if tenant: wim['tenant'] = tenant
3539 wim
["wim_type"] = wim_type
3541 wim
["description"] = description
3543 wim
["config"] = config
3544 ctx
.obj
.wim
.update(name
, wim
, wim_port_mapping
, wait
=wait
)
3545 # except ClientException as e:
3550 @cli_osm.command(name
="wim-delete", short_help
="deletes a WIM account")
3551 @click.argument("name")
3553 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3560 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3563 def wim_delete(ctx
, name
, force
, wait
):
3564 """deletes a WIM account
3566 NAME: name or ID of the WIM account to be deleted
3570 check_client_version(ctx
.obj
, ctx
.command
.name
)
3571 ctx
.obj
.wim
.delete(name
, force
, wait
=wait
)
3572 # except ClientException as e:
3577 @cli_osm.command(name
="wim-list", short_help
="list all WIM accounts")
3582 help="restricts the list to the WIM accounts matching the filter",
3585 def wim_list(ctx
, filter):
3586 """list all WIM accounts"""
3589 check_client_version(ctx
.obj
, ctx
.command
.name
)
3591 filter = "&".join(filter)
3592 resp
= ctx
.obj
.wim
.list(filter)
3593 table
= PrettyTable(["wim name", "uuid"])
3595 table
.add_row([wim
["name"], wim
["uuid"]])
3598 # except ClientException as e:
3603 @cli_osm.command(name
="wim-show", short_help
="shows the details of a WIM account")
3604 @click.argument("name")
3606 def wim_show(ctx
, name
):
3607 """shows the details of a WIM account
3609 NAME: name or ID of the WIM account
3613 check_client_version(ctx
.obj
, ctx
.command
.name
)
3614 resp
= ctx
.obj
.wim
.get(name
)
3615 if "password" in resp
:
3616 resp
["password"] = "********"
3617 # except ClientException as e:
3621 table
= PrettyTable(["key", "attribute"])
3622 for k
, v
in list(resp
.items()):
3623 table
.add_row([k
, json
.dumps(v
, indent
=2)])
3628 ####################
3629 # SDN controller operations
3630 ####################
3633 @cli_osm.command(name
="sdnc-create", short_help
="creates a new SDN controller")
3634 @click.option("--name", prompt
=True, help="Name to create sdn controller")
3635 @click.option("--type", prompt
=True, help="SDN controller type")
3637 "--sdn_controller_version", # hidden=True,
3638 help="Deprecated. Use --config {version: sdn_controller_version}",
3640 @click.option("--url", help="URL in format http[s]://HOST:IP/")
3641 @click.option("--ip_address", help="Deprecated. Use --url") # hidden=True,
3642 @click.option("--port", help="Deprecated. Use --url") # hidden=True,
3644 "--switch_dpid", help="Deprecated. Use --config {switch_id: DPID}" # hidden=True,
3648 help="Extra information for SDN in yaml format, as {switch_id: identity used for the plugin (e.g. DPID: "
3649 "Openflow Datapath ID), version: version}",
3651 @click.option("--user", help="SDN controller username")
3655 confirmation_prompt
=True,
3656 help="SDN controller password",
3658 @click.option("--description", default
=None, help="human readable description")
3664 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3667 def sdnc_create(ctx
, **kwargs
):
3668 """creates a new SDN controller"""
3673 if kwargs
[x
] and x
not in ("wait", "ip_address", "port", "switch_dpid")
3675 if kwargs
.get("port"):
3676 print("option '--port' is deprecated, use '--url' instead")
3677 sdncontroller
["port"] = int(kwargs
["port"])
3678 if kwargs
.get("ip_address"):
3679 print("option '--ip_address' is deprecated, use '--url' instead")
3680 sdncontroller
["ip"] = kwargs
["ip_address"]
3681 if kwargs
.get("switch_dpid"):
3683 "option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead"
3685 sdncontroller
["dpid"] = kwargs
["switch_dpid"]
3686 if kwargs
.get("sdn_controller_version"):
3688 "option '--sdn_controller_version' is deprecated, use '--config={version: SDN_CONTROLLER_VERSION}'"
3692 check_client_version(ctx
.obj
, ctx
.command
.name
)
3693 ctx
.obj
.sdnc
.create(kwargs
["name"], sdncontroller
, wait
=kwargs
["wait"])
3694 # except ClientException as e:
3699 @cli_osm.command(name
="sdnc-update", short_help
="updates an SDN controller")
3700 @click.argument("name")
3701 @click.option("--newname", help="New name for the SDN controller")
3702 @click.option("--description", default
=None, help="human readable description")
3703 @click.option("--type", help="SDN controller type")
3704 @click.option("--url", help="URL in format http[s]://HOST:IP/")
3707 help="Extra information for SDN in yaml format, as "
3708 "{switch_id: identity used for the plugin (e.g. DPID: "
3709 "Openflow Datapath ID), version: version}",
3711 @click.option("--user", help="SDN controller username")
3712 @click.option("--password", help="SDN controller password")
3713 @click.option("--ip_address", help="Deprecated. Use --url") # hidden=True
3714 @click.option("--port", help="Deprecated. Use --url") # hidden=True
3716 "--switch_dpid", help="Deprecated. Use --config {switch_dpid: DPID}"
3719 "--sdn_controller_version", help="Deprecated. Use --config {version: VERSION}"
3726 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3729 def sdnc_update(ctx
, **kwargs
):
3730 """updates an SDN controller
3732 NAME: name or ID of the SDN controller
3739 and x
not in ("wait", "ip_address", "port", "switch_dpid", "new_name")
3741 if kwargs
.get("newname"):
3742 sdncontroller
["name"] = kwargs
["newname"]
3743 if kwargs
.get("port"):
3744 print("option '--port' is deprecated, use '--url' instead")
3745 sdncontroller
["port"] = int(kwargs
["port"])
3746 if kwargs
.get("ip_address"):
3747 print("option '--ip_address' is deprecated, use '--url' instead")
3748 sdncontroller
["ip"] = kwargs
["ip_address"]
3749 if kwargs
.get("switch_dpid"):
3751 "option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead"
3753 sdncontroller
["dpid"] = kwargs
["switch_dpid"]
3754 if kwargs
.get("sdn_controller_version"):
3756 "option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'"
3761 check_client_version(ctx
.obj
, ctx
.command
.name
)
3762 ctx
.obj
.sdnc
.update(kwargs
["name"], sdncontroller
, wait
=kwargs
["wait"])
3763 # except ClientException as e:
3768 @cli_osm.command(name
="sdnc-delete", short_help
="deletes an SDN controller")
3769 @click.argument("name")
3771 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3778 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3781 def sdnc_delete(ctx
, name
, force
, wait
):
3782 """deletes an SDN controller
3784 NAME: name or ID of the SDN controller to be deleted
3788 check_client_version(ctx
.obj
, ctx
.command
.name
)
3789 ctx
.obj
.sdnc
.delete(name
, force
, wait
=wait
)
3790 # except ClientException as e:
3795 @cli_osm.command(name
="sdnc-list", short_help
="list all SDN controllers")
3800 help="restricts the list to the SDN controllers matching the filter with format: 'k[.k..]=v[&k[.k]=v2]'",
3803 def sdnc_list(ctx
, filter):
3804 """list all SDN controllers"""
3807 check_client_version(ctx
.obj
, ctx
.command
.name
)
3809 filter = "&".join(filter)
3810 resp
= ctx
.obj
.sdnc
.list(filter)
3811 # except ClientException as e:
3814 table
= PrettyTable(["sdnc name", "id"])
3816 table
.add_row([sdnc
["name"], sdnc
["_id"]])
3821 @cli_osm.command(name
="sdnc-show", short_help
="shows the details of an SDN controller")
3822 @click.argument("name")
3824 def sdnc_show(ctx
, name
):
3825 """shows the details of an SDN controller
3827 NAME: name or ID of the SDN controller
3831 check_client_version(ctx
.obj
, ctx
.command
.name
)
3832 resp
= ctx
.obj
.sdnc
.get(name
)
3833 # except ClientException as e:
3837 table
= PrettyTable(["key", "attribute"])
3838 for k
, v
in list(resp
.items()):
3839 table
.add_row([k
, json
.dumps(v
, indent
=2)])
3844 ###########################
3845 # K8s cluster operations
3846 ###########################
3849 @cli_osm.command(name
="k8scluster-add", short_help
="adds a K8s cluster to OSM")
3850 @click.argument("name")
3852 "--creds", prompt
=True, help="credentials file, i.e. a valid `.kube/config` file"
3854 @click.option("--version", prompt
=True, help="Kubernetes version")
3856 "--vim", prompt
=True, help="VIM target, the VIM where the cluster resides"
3861 help='''list of VIM networks, in JSON inline format, where the cluster is
3862 accessible via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"''',
3865 "--init-helm2/--skip-helm2",
3868 help="Initialize helm v2",
3871 "--init-helm3/--skip-helm3",
3874 help="Initialize helm v3",
3877 "--init-jujubundle/--skip-jujubundle",
3880 help="Initialize juju-bundle",
3882 @click.option("--description", default
=None, help="human readable description")
3885 default
="kube-system",
3886 help="namespace to be used for its operation, defaults to `kube-system`",
3893 help="do not return the control immediately, but keep it "
3894 "until the operation is completed, or timeout",
3899 help="list of CNI plugins, in JSON inline format, used in the cluster",
3901 # @click.option('--skip-init',
3903 # help='If set, K8s cluster is assumed to be ready for its use with OSM')
3904 # @click.option('--wait',
3906 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
3923 """adds a K8s cluster to OSM
3925 NAME: name of the K8s cluster
3928 check_client_version(ctx
.obj
, ctx
.command
.name
)
3930 cluster
["name"] = name
3931 with
open(creds
, "r") as cf
:
3932 cluster
["credentials"] = yaml
.safe_load(cf
.read())
3933 cluster
["k8s_version"] = version
3934 cluster
["vim_account"] = vim
3935 cluster
["nets"] = yaml
.safe_load(k8s_nets
)
3936 if not (init_helm2
and init_jujubundle
and init_helm3
):
3937 cluster
["deployment_methods"] = {
3938 "helm-chart": init_helm2
,
3939 "juju-bundle": init_jujubundle
,
3940 "helm-chart-v3": init_helm3
,
3943 cluster
["description"] = description
3945 cluster
["namespace"] = namespace
3947 cluster
["cni"] = yaml
.safe_load(cni
)
3948 ctx
.obj
.k8scluster
.create(name
, cluster
, wait
)
3949 # except ClientException as e:
3954 @cli_osm.command(name
="k8scluster-update", short_help
="updates a K8s cluster")
3955 @click.argument("name")
3956 @click.option("--newname", help="New name for the K8s cluster")
3957 @click.option("--creds", help="credentials file, i.e. a valid `.kube/config` file")
3958 @click.option("--version", help="Kubernetes version")
3959 @click.option("--vim", help="VIM target, the VIM where the cluster resides")
3962 help='''list of VIM networks, in JSON inline format, where the cluster is accessible
3963 via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"''',
3965 @click.option("--description", help="human readable description")
3968 help="namespace to be used for its operation, defaults to `kube-system`",
3975 help="do not return the control immediately, but keep it "
3976 "until the operation is completed, or timeout",
3979 "--cni", help="list of CNI plugins, in JSON inline format, used in the cluster"
3982 def k8scluster_update(
3983 ctx
, name
, newname
, creds
, version
, vim
, k8s_nets
, description
, namespace
, wait
, cni
3985 """updates a K8s cluster
3987 NAME: name or ID of the K8s cluster
3990 check_client_version(ctx
.obj
, ctx
.command
.name
)
3993 cluster
["name"] = newname
3995 with
open(creds
, "r") as cf
:
3996 cluster
["credentials"] = yaml
.safe_load(cf
.read())
3998 cluster
["k8s_version"] = version
4000 cluster
["vim_account"] = vim
4002 cluster
["nets"] = yaml
.safe_load(k8s_nets
)
4004 cluster
["description"] = description
4006 cluster
["namespace"] = namespace
4008 cluster
["cni"] = yaml
.safe_load(cni
)
4009 ctx
.obj
.k8scluster
.update(name
, cluster
, wait
)
4010 # except ClientException as e:
4015 @cli_osm.command(name
="k8scluster-delete", short_help
="deletes a K8s cluster")
4016 @click.argument("name")
4018 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
4025 help="do not return the control immediately, but keep it "
4026 "until the operation is completed, or timeout",
4029 def k8scluster_delete(ctx
, name
, force
, wait
):
4030 """deletes a K8s cluster
4032 NAME: name or ID of the K8s cluster to be deleted
4035 check_client_version(ctx
.obj
, ctx
.command
.name
)
4036 ctx
.obj
.k8scluster
.delete(name
, force
, wait
)
4037 # except ClientException as e:
4042 @cli_osm.command(name
="k8scluster-list")
4047 help="restricts the list to the K8s clusters matching the filter",
4049 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4050 @click.option("--long", is_flag
=True, help="get more details")
4052 def k8scluster_list(ctx
, filter, literal
, long):
4053 """list all K8s clusters"""
4055 check_client_version(ctx
.obj
, ctx
.command
.name
)
4057 filter = "&".join(filter)
4058 resp
= ctx
.obj
.k8scluster
.list(filter)
4060 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4063 table
= PrettyTable(
4071 "Deployment methods",
4072 "Operational State",
4073 "Op. state (details)",
4078 project_list
= ctx
.obj
.project
.list()
4080 table
= PrettyTable(
4081 ["Name", "Id", "VIM", "Operational State", "Op. state details"]
4084 vim_list
= ctx
.obj
.vim
.list()
4087 for cluster
in resp
:
4088 logger
.debug("Cluster details: {}".format(yaml
.safe_dump(cluster
)))
4089 vim_name
= get_vim_name(vim_list
, cluster
["vim_account"])
4090 # vim_info = '{} ({})'.format(vim_name,cluster['vim_account'])
4092 op_state_details
= "Helm: {}\nJuju: {}".format(
4093 cluster
["_admin"].get("helm-chart", {}).get("operationalState", "-"),
4094 cluster
["_admin"].get("juju-bundle", {}).get("operationalState", "-"),
4097 project_id
, project_name
= get_project(project_list
, cluster
)
4098 # project_info = '{} ({})'.format(project_name, project_id)
4099 project_info
= project_name
4100 detailed_status
= cluster
["_admin"].get("detailed-status", "-")
4106 cluster
["k8s_version"],
4108 json
.dumps(cluster
["nets"]),
4109 json
.dumps(cluster
["deployment_methods"]),
4110 cluster
["_admin"]["operationalState"],
4112 trunc_text(cluster
.get("description") or "", 40),
4113 wrap_text(text
=detailed_status
, width
=40),
4122 cluster
["_admin"]["operationalState"],
4128 # except ClientException as e:
4134 name
="k8scluster-show", short_help
="shows the details of a K8s cluster"
4136 @click.argument("name")
4137 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4139 def k8scluster_show(ctx
, name
, literal
):
4140 """shows the details of a K8s cluster
4142 NAME: name or ID of the K8s cluster
4145 resp
= ctx
.obj
.k8scluster
.get(name
)
4147 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4149 table
= PrettyTable(["key", "attribute"])
4150 for k
, v
in list(resp
.items()):
4151 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
4154 # except ClientException as e:
4159 ###########################
4161 ###########################
4164 @cli_osm.command(name
="vca-add", short_help
="adds a VCA (Juju controller) to OSM")
4165 @click.argument("name")
4169 help="Comma-separated list of IP or hostnames of the Juju controller",
4171 @click.option("--user", prompt
=True, help="Username with admin priviledges")
4172 @click.option("--secret", prompt
=True, help="Password of the specified username")
4173 @click.option("--cacert", prompt
=True, help="CA certificate")
4177 help="Name of the cloud that will be used for LXD containers (LXD proxy charms)",
4180 "--lxd-credentials",
4182 help="Name of the cloud credentialsto be used for the LXD cloud",
4187 help="Name of the cloud that will be used for K8s containers (K8s proxy charms)",
4190 "--k8s-credentials",
4192 help="Name of the cloud credentialsto be used for the K8s cloud",
4197 help="Configuration options for the models",
4199 @click.option("--description", default
=None, help="human readable description")
4215 """adds a VCA to OSM
4217 NAME: name of the VCA
4219 check_client_version(ctx
.obj
, ctx
.command
.name
)
4222 vca
["endpoints"] = endpoints
.split(",")
4224 vca
["secret"] = secret
4225 vca
["cacert"] = cacert
4226 vca
["lxd-cloud"] = lxd_cloud
4227 vca
["lxd-credentials"] = lxd_credentials
4228 vca
["k8s-cloud"] = k8s_cloud
4229 vca
["k8s-credentials"] = k8s_credentials
4231 vca
["description"] = description
4233 model_config
= load(model_config
)
4234 vca
["model-config"] = model_config
4235 ctx
.obj
.vca
.create(name
, vca
)
4238 def load(data
: Any
):
4239 if os
.path
.isfile(data
):
4240 return load_file(data
)
4243 return json
.loads(data
)
4244 except ValueError as e
:
4245 raise ClientException(e
)
4248 def load_file(file_path
: str) -> Dict
:
4250 with
open(file_path
, "r") as f
:
4253 return yaml
.safe_load(content
)
4254 except yaml
.scanner
.ScannerError
:
4257 return json
.loads(content
)
4260 raise ClientException(f
"{file_path} must be a valid yaml or json file")
4263 @cli_osm.command(name
="vca-update", short_help
="updates a K8s cluster")
4264 @click.argument("name")
4266 "--endpoints", help="Comma-separated list of IP or hostnames of the Juju controller"
4268 @click.option("--user", help="Username with admin priviledges")
4269 @click.option("--secret", help="Password of the specified username")
4270 @click.option("--cacert", help="CA certificate")
4273 help="Name of the cloud that will be used for LXD containers (LXD proxy charms)",
4276 "--lxd-credentials",
4277 help="Name of the cloud credentialsto be used for the LXD cloud",
4281 help="Name of the cloud that will be used for K8s containers (K8s proxy charms)",
4284 "--k8s-credentials",
4285 help="Name of the cloud credentialsto be used for the K8s cloud",
4289 help="Configuration options for the models",
4291 @click.option("--description", default
=None, help="human readable description")
4307 """updates a K8s cluster
4309 NAME: name or ID of the K8s cluster
4311 check_client_version(ctx
.obj
, ctx
.command
.name
)
4315 vca
["endpoints"] = endpoints
.split(",")
4319 vca
["secret"] = secret
4321 vca
["cacert"] = cacert
4323 vca
["lxd-cloud"] = lxd_cloud
4325 vca
["lxd-credentials"] = lxd_credentials
4327 vca
["k8s-cloud"] = k8s_cloud
4329 vca
["k8s-credentials"] = k8s_credentials
4331 vca
["description"] = description
4333 model_config
= load(model_config
)
4334 vca
["model-config"] = model_config
4335 ctx
.obj
.vca
.update(name
, vca
)
4338 @cli_osm.command(name
="vca-delete", short_help
="deletes a K8s cluster")
4339 @click.argument("name")
4341 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
4344 def vca_delete(ctx
, name
, force
):
4345 """deletes a K8s cluster
4347 NAME: name or ID of the K8s cluster to be deleted
4349 check_client_version(ctx
.obj
, ctx
.command
.name
)
4350 ctx
.obj
.vca
.delete(name
, force
=force
)
4353 @cli_osm.command(name
="vca-list")
4358 help="restricts the list to the VCAs matching the filter",
4360 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4361 @click.option("--long", is_flag
=True, help="get more details")
4363 def vca_list(ctx
, filter, literal
, long):
4365 check_client_version(ctx
.obj
, ctx
.command
.name
)
4367 filter = "&".join(filter)
4368 resp
= ctx
.obj
.vca
.list(filter)
4370 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4373 table
= PrettyTable(
4374 ["Name", "Id", "Project", "Operational State", "Detailed Status"]
4376 project_list
= ctx
.obj
.project
.list()
4378 table
= PrettyTable(["Name", "Id", "Operational State"])
4380 logger
.debug("VCA details: {}".format(yaml
.safe_dump(vca
)))
4382 project_id
, project_name
= get_project(project_list
, vca
)
4383 detailed_status
= vca
.get("_admin", {}).get("detailed-status", "-")
4389 vca
.get("_admin", {}).get("operationalState", "-"),
4390 wrap_text(text
=detailed_status
, width
=40),
4398 vca
.get("_admin", {}).get("operationalState", "-"),
4405 @cli_osm.command(name
="vca-show", short_help
="shows the details of a K8s cluster")
4406 @click.argument("name")
4407 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4409 def vca_show(ctx
, name
, literal
):
4410 """shows the details of a K8s cluster
4412 NAME: name or ID of the K8s cluster
4415 resp
= ctx
.obj
.vca
.get(name
)
4417 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4419 table
= PrettyTable(["key", "attribute"])
4420 for k
, v
in list(resp
.items()):
4421 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
4426 ###########################
4428 ###########################
4431 @cli_osm.command(name
="repo-add", short_help
="adds a repo to OSM")
4432 @click.argument("name")
4433 @click.argument("uri")
4436 type=click
.Choice(["helm-chart", "juju-bundle", "osm"]),
4438 help="type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles, osm for OSM Repositories)",
4440 @click.option("--description", default
=None, help="human readable description")
4442 "--user", default
=None, help="OSM repository: The username of the OSM repository"
4447 help="OSM repository: The password of the OSM repository",
4449 # @click.option('--wait',
4451 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4453 def repo_add(ctx
, **kwargs
):
4454 """adds a repo to OSM
4456 NAME: name of the repo
4457 URI: URI of the repo
4460 kwargs
= {k
: v
for k
, v
in kwargs
.items() if v
is not None}
4462 repo
["url"] = repo
.pop("uri")
4463 if repo
["type"] in ["helm-chart", "juju-bundle"]:
4464 ctx
.obj
.repo
.create(repo
["name"], repo
)
4466 ctx
.obj
.osmrepo
.create(repo
["name"], repo
)
4467 # except ClientException as e:
4472 @cli_osm.command(name
="repo-update", short_help
="updates a repo in OSM")
4473 @click.argument("name")
4474 @click.option("--newname", help="New name for the repo")
4475 @click.option("--uri", help="URI of the repo")
4476 @click.option("--description", help="human readable description")
4477 # @click.option('--wait',
4479 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4481 def repo_update(ctx
, name
, newname
, uri
, description
):
4482 """updates a repo in OSM
4484 NAME: name of the repo
4487 check_client_version(ctx
.obj
, ctx
.command
.name
)
4490 repo
["name"] = newname
4494 repo
["description"] = description
4496 ctx
.obj
.repo
.update(name
, repo
)
4498 ctx
.obj
.osmrepo
.update(name
, repo
)
4500 # except ClientException as e:
4506 name
="repo-index", short_help
="Index a repository from a folder with artifacts"
4509 "--origin", default
=".", help="origin path where the artifacts are located"
4512 "--destination", default
=".", help="destination path where the index is deployed"
4515 def repo_index(ctx
, origin
, destination
):
4516 """Index a repository
4518 NAME: name or ID of the repo to be deleted
4520 check_client_version(ctx
.obj
, ctx
.command
.name
)
4521 ctx
.obj
.osmrepo
.repo_index(origin
, destination
)
4524 @cli_osm.command(name
="repo-delete", short_help
="deletes a repo")
4525 @click.argument("name")
4527 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
4529 # @click.option('--wait',
4531 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4533 def repo_delete(ctx
, name
, force
):
4536 NAME: name or ID of the repo to be deleted
4540 ctx
.obj
.repo
.delete(name
, force
=force
)
4542 ctx
.obj
.osmrepo
.delete(name
, force
=force
)
4543 # except ClientException as e:
4548 @cli_osm.command(name
="repo-list")
4553 help="restricts the list to the repos matching the filter",
4555 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4557 def repo_list(ctx
, filter, literal
):
4558 """list all repos"""
4561 check_client_version(ctx
.obj
, ctx
.command
.name
)
4563 filter = "&".join(filter)
4564 resp
= ctx
.obj
.repo
.list(filter)
4565 resp
+= ctx
.obj
.osmrepo
.list(filter)
4567 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4569 table
= PrettyTable(["Name", "Id", "Type", "URI", "Description"])
4571 # cluster['k8s-nets'] = json.dumps(yaml.safe_load(cluster['k8s-nets']))
4578 trunc_text(repo
.get("description") or "", 40),
4584 # except ClientException as e:
4589 @cli_osm.command(name
="repo-show", short_help
="shows the details of a repo")
4590 @click.argument("name")
4591 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4593 def repo_show(ctx
, name
, literal
):
4594 """shows the details of a repo
4596 NAME: name or ID of the repo
4599 resp
= ctx
.obj
.repo
.get(name
)
4601 resp
= ctx
.obj
.osmrepo
.get(name
)
4605 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4607 table
= PrettyTable(["key", "attribute"])
4609 for k
, v
in list(resp
.items()):
4610 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4614 # except ClientException as e:
4619 ####################
4620 # Project mgmt operations
4621 ####################
4624 @cli_osm.command(name
="project-create", short_help
="creates a new project")
4625 @click.argument("name")
4626 # @click.option('--description',
4627 # default='no description',
4628 # help='human readable description')
4629 @click.option("--domain-name", "domain_name", default
=None, help="assign to a domain")
4635 help="provide quotas. Can be used several times: 'quota1=number[,quota2=number,...]'. Quotas can be one "
4636 "of vnfds, nsds, nsts, pdus, nsrs, nsis, vim_accounts, wim_accounts, sdns, k8sclusters, k8srepos",
4639 def project_create(ctx
, name
, domain_name
, quotas
):
4640 """Creates a new project
4642 NAME: name of the project
4643 DOMAIN_NAME: optional domain name for the project when keystone authentication is used
4644 QUOTAS: set quotas for the project
4647 project
= {"name": name
}
4649 project
["domain_name"] = domain_name
4650 quotas_dict
= _process_project_quotas(quotas
)
4652 project
["quotas"] = quotas_dict
4655 check_client_version(ctx
.obj
, ctx
.command
.name
)
4656 ctx
.obj
.project
.create(name
, project
)
4657 # except ClientException as e:
4662 def _process_project_quotas(quota_list
):
4667 for quota
in quota_list
:
4668 for single_quota
in quota
.split(","):
4669 k
, v
= single_quota
.split("=")
4670 quotas_dict
[k
] = None if v
in ("None", "null", "") else int(v
)
4671 except (ValueError, TypeError):
4672 raise ClientException(
4673 "invalid format for 'quotas'. Use 'k1=v1,v1=v2'. v must be a integer or null"
4678 @cli_osm.command(name
="project-delete", short_help
="deletes a project")
4679 @click.argument("name")
4680 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
4682 def project_delete(ctx
, name
):
4683 """deletes a project
4685 NAME: name or ID of the project to be deleted
4689 check_client_version(ctx
.obj
, ctx
.command
.name
)
4690 ctx
.obj
.project
.delete(name
)
4691 # except ClientException as e:
4696 @cli_osm.command(name
="project-list", short_help
="list all projects")
4701 help="restricts the list to the projects matching the filter",
4704 def project_list(ctx
, filter):
4705 """list all projects"""
4708 check_client_version(ctx
.obj
, ctx
.command
.name
)
4710 filter = "&".join(filter)
4711 resp
= ctx
.obj
.project
.list(filter)
4712 # except ClientException as e:
4715 table
= PrettyTable(["name", "id"])
4717 table
.add_row([proj
["name"], proj
["_id"]])
4722 @cli_osm.command(name
="project-show", short_help
="shows the details of a project")
4723 @click.argument("name")
4725 def project_show(ctx
, name
):
4726 """shows the details of a project
4728 NAME: name or ID of the project
4732 check_client_version(ctx
.obj
, ctx
.command
.name
)
4733 resp
= ctx
.obj
.project
.get(name
)
4734 # except ClientException as e:
4738 table
= PrettyTable(["key", "attribute"])
4739 for k
, v
in resp
.items():
4740 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4746 name
="project-update", short_help
="updates a project (only the name can be updated)"
4748 @click.argument("project")
4749 @click.option("--name", default
=None, help="new name for the project")
4755 help="change quotas. Can be used several times: 'quota1=number|empty[,quota2=...]' "
4756 "(use empty to reset quota to default",
4759 def project_update(ctx
, project
, name
, quotas
):
4761 Update a project name
4764 :param project: id or name of the project to modify
4765 :param name: new name for the project
4766 :param quotas: change quotas of the project
4770 project_changes
= {}
4772 project_changes
["name"] = name
4773 quotas_dict
= _process_project_quotas(quotas
)
4775 project_changes
["quotas"] = quotas_dict
4778 check_client_version(ctx
.obj
, ctx
.command
.name
)
4779 ctx
.obj
.project
.update(project
, project_changes
)
4780 # except ClientException as e:
4784 ####################
4785 # User mgmt operations
4786 ####################
4789 @cli_osm.command(name
="user-create", short_help
="creates a new user")
4790 @click.argument("username")
4795 confirmation_prompt
=True,
4796 help="user password",
4800 # prompt="Comma separate list of projects",
4802 callback
=lambda ctx
, param
, value
: "".join(value
).split(",")
4803 if all(len(x
) == 1 for x
in value
)
4805 help="list of project ids that the user belongs to",
4808 "--project-role-mappings",
4809 "project_role_mappings",
4812 help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4814 @click.option("--domain-name", "domain_name", default
=None, help="assign to a domain")
4816 def user_create(ctx
, username
, password
, projects
, project_role_mappings
, domain_name
):
4817 """Creates a new user
4820 USERNAME: name of the user
4821 PASSWORD: password of the user
4822 PROJECTS: projects assigned to user (internal only)
4823 PROJECT_ROLE_MAPPING: roles in projects assigned to user (keystone)
4824 DOMAIN_NAME: optional domain name for the user when keystone authentication is used
4828 user
["username"] = username
4829 user
["password"] = password
4830 user
["projects"] = projects
4831 user
["project_role_mappings"] = project_role_mappings
4833 user
["domain_name"] = domain_name
4836 check_client_version(ctx
.obj
, ctx
.command
.name
)
4837 ctx
.obj
.user
.create(username
, user
)
4838 # except ClientException as e:
4843 @cli_osm.command(name
="user-update", short_help
="updates user information")
4844 @click.argument("username")
4849 # confirmation_prompt=True,
4850 help="user password",
4852 @click.option("--set-username", "set_username", default
=None, help="change username")
4858 help="create/replace the roles for this project: 'project,role1[,role2,...]'",
4865 help="removes project from user: 'project'",
4868 "--add-project-role",
4872 help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4875 "--remove-project-role",
4876 "remove_project_role",
4879 help="remove role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4881 @click.option("--change_password", "change_password", help="user's current password")
4885 help="user's new password to update in expiry condition",
4896 remove_project_role
,
4900 """Update a user information
4903 USERNAME: name of the user
4904 PASSWORD: new password
4905 SET_USERNAME: new username
4906 SET_PROJECT: creating mappings for project/role(s)
4907 REMOVE_PROJECT: deleting mappings for project/role(s)
4908 ADD_PROJECT_ROLE: adding mappings for project/role(s)
4909 REMOVE_PROJECT_ROLE: removing mappings for project/role(s)
4910 CHANGE_PASSWORD: user's current password to change
4911 NEW_PASSWORD: user's new password to update in expiry condition
4915 user
["password"] = password
4916 user
["username"] = set_username
4917 user
["set-project"] = set_project
4918 user
["remove-project"] = remove_project
4919 user
["add-project-role"] = add_project_role
4920 user
["remove-project-role"] = remove_project_role
4921 user
["change_password"] = change_password
4922 user
["new_password"] = new_password
4925 check_client_version(ctx
.obj
, ctx
.command
.name
)
4926 if not user
.get("change_password"):
4927 ctx
.obj
.user
.update(username
, user
)
4929 ctx
.obj
.user
.update(username
, user
, pwd_change
=True)
4930 # except ClientException as e:
4935 @cli_osm.command(name
="user-delete", short_help
="deletes a user")
4936 @click.argument("name")
4937 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
4939 def user_delete(ctx
, name
):
4943 NAME: name or ID of the user to be deleted
4947 check_client_version(ctx
.obj
, ctx
.command
.name
)
4948 ctx
.obj
.user
.delete(name
)
4949 # except ClientException as e:
4954 @cli_osm.command(name
="user-list", short_help
="list all users")
4959 help="restricts the list to the users matching the filter",
4962 def user_list(ctx
, filter):
4963 """list all users"""
4965 check_client_version(ctx
.obj
, ctx
.command
.name
)
4967 filter = "&".join(filter)
4968 resp
= ctx
.obj
.user
.list(filter)
4969 # except ClientException as e:
4972 table
= PrettyTable(["name", "id"])
4974 table
.add_row([user
["username"], user
["_id"]])
4979 @cli_osm.command(name
="user-show", short_help
="shows the details of a user")
4980 @click.argument("name")
4982 def user_show(ctx
, name
):
4983 """shows the details of a user
4985 NAME: name or ID of the user
4989 check_client_version(ctx
.obj
, ctx
.command
.name
)
4990 resp
= ctx
.obj
.user
.get(name
)
4991 if "password" in resp
:
4992 resp
["password"] = "********"
4993 # except ClientException as e:
4997 table
= PrettyTable(["key", "attribute"])
4998 for k
, v
in resp
.items():
4999 table
.add_row([k
, json
.dumps(v
, indent
=2)])
5004 ####################
5005 # Fault Management operations
5006 ####################
5009 @cli_osm.command(name
="ns-alarm-create")
5010 @click.argument("name")
5011 @click.option("--ns", prompt
=True, help="NS instance id or name")
5013 "--vnf", prompt
=True, help="VNF name (VNF member index as declared in the NSD)"
5015 @click.option("--vdu", prompt
=True, help="VDU name (VDU name as declared in the VNFD)")
5016 @click.option("--metric", prompt
=True, help="Name of the metric (e.g. cpu_utilization)")
5020 help="severity of the alarm (WARNING, MINOR, MAJOR, CRITICAL, INDETERMINATE)",
5023 "--threshold_value",
5025 help="threshold value that, when crossed, an alarm is triggered",
5028 "--threshold_operator",
5030 help="threshold operator describing the comparison (GE, LE, GT, LT, EQ)",
5035 help="statistic (AVERAGE, MINIMUM, MAXIMUM, COUNT, SUM)",
5038 def ns_alarm_create(
5050 """creates a new alarm for a NS instance"""
5051 # TODO: Check how to validate threshold_value.
5052 # Should it be an integer (1-100), percentage, or decimal (0.01-1.00)?
5055 ns_instance
= ctx
.obj
.ns
.get(ns
)
5057 alarm
["alarm_name"] = name
5058 alarm
["ns_id"] = ns_instance
["_id"]
5059 alarm
["correlation_id"] = ns_instance
["_id"]
5060 alarm
["vnf_member_index"] = vnf
5061 alarm
["vdu_name"] = vdu
5062 alarm
["metric_name"] = metric
5063 alarm
["severity"] = severity
5064 alarm
["threshold_value"] = int(threshold_value
)
5065 alarm
["operation"] = threshold_operator
5066 alarm
["statistic"] = statistic
5067 check_client_version(ctx
.obj
, ctx
.command
.name
)
5068 ctx
.obj
.ns
.create_alarm(alarm
)
5069 # except ClientException as e:
5074 # @cli_osm.command(name='ns-alarm-delete')
5075 # @click.argument('name')
5076 # @click.pass_context
5077 # def ns_alarm_delete(ctx, name):
5078 # """deletes an alarm
5080 # NAME: name of the alarm to be deleted
5083 # check_client_version(ctx.obj, ctx.command.name)
5084 # ctx.obj.ns.delete_alarm(name)
5085 # except ClientException as e:
5090 ####################
5091 # Performance Management operations
5092 ####################
5096 name
="ns-metric-export",
5097 short_help
="exports a metric to the internal OSM bus, which can be read by other apps",
5099 @click.option("--ns", prompt
=True, help="NS instance id or name")
5101 "--vnf", prompt
=True, help="VNF name (VNF member index as declared in the NSD)"
5103 @click.option("--vdu", prompt
=True, help="VDU name (VDU name as declared in the VNFD)")
5104 @click.option("--metric", prompt
=True, help="name of the metric (e.g. cpu_utilization)")
5105 # @click.option('--period', default='1w',
5106 # help='metric collection period (e.g. 20s, 30m, 2h, 3d, 1w)')
5108 "--interval", help="periodic interval (seconds) to export metrics continuously"
5111 def ns_metric_export(ctx
, ns
, vnf
, vdu
, metric
, interval
):
5112 """exports a metric to the internal OSM bus, which can be read by other apps"""
5113 # TODO: Check how to validate interval.
5114 # Should it be an integer (seconds), or should a suffix (s,m,h,d,w) also be permitted?
5117 ns_instance
= ctx
.obj
.ns
.get(ns
)
5119 metric_data
["ns_id"] = ns_instance
["_id"]
5120 metric_data
["correlation_id"] = ns_instance
["_id"]
5121 metric_data
["vnf_member_index"] = vnf
5122 metric_data
["vdu_name"] = vdu
5123 metric_data
["metric_name"] = metric
5124 metric_data
["collection_unit"] = "WEEK"
5125 metric_data
["collection_period"] = 1
5126 check_client_version(ctx
.obj
, ctx
.command
.name
)
5128 print("{}".format(ctx
.obj
.ns
.export_metric(metric_data
)))
5132 print("{} {}".format(ctx
.obj
.ns
.export_metric(metric_data
), i
))
5133 time
.sleep(int(interval
))
5135 # except ClientException as e:
5141 # Subscription operations
5146 name
="subscription-create",
5147 short_help
="creates a new subscription to a specific event",
5151 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5152 type=click
.Choice(["ns"], case_sensitive
=False),
5153 help="event type to be subscribed (for the moment, only ns is supported)",
5155 @click.option("--event", default
=None, help="specific yaml configuration for the event")
5157 "--event_file", default
=None, help="specific yaml configuration file for the event"
5160 def subscription_create(ctx
, event_type
, event
, event_file
):
5161 """creates a new subscription to a specific event"""
5163 check_client_version(ctx
.obj
, ctx
.command
.name
)
5166 raise ClientException(
5167 '"--event" option is incompatible with "--event_file" option'
5169 with
open(event_file
, "r") as cf
:
5171 ctx
.obj
.subscription
.create(event_type
, event
)
5174 @cli_osm.command(name
="subscription-delete", short_help
="deletes a subscription")
5177 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5178 type=click
.Choice(["ns"], case_sensitive
=False),
5179 help="event type to be subscribed (for the moment, only ns is supported)",
5181 @click.argument("subscription_id")
5183 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
5186 def subscription_delete(ctx
, event_type
, subscription_id
, force
):
5187 """deletes a subscription
5189 SUBSCRIPTION_ID: ID of the subscription to be deleted
5192 check_client_version(ctx
.obj
, ctx
.command
.name
)
5193 ctx
.obj
.subscription
.delete(event_type
, subscription_id
, force
)
5196 @cli_osm.command(name
="subscription-list", short_help
="list all subscriptions")
5199 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5200 type=click
.Choice(["ns"], case_sensitive
=False),
5201 help="event type to be subscribed (for the moment, only ns is supported)",
5207 help="restricts the list to the subscriptions matching the filter",
5210 def subscription_list(ctx
, event_type
, filter):
5211 """list all subscriptions"""
5213 check_client_version(ctx
.obj
, ctx
.command
.name
)
5215 filter = "&".join(filter)
5216 resp
= ctx
.obj
.subscription
.list(event_type
, filter)
5217 table
= PrettyTable(["id", "filter", "CallbackUri"])
5222 wrap_text(text
=json
.dumps(sub
["filter"], indent
=2), width
=70),
5231 name
="subscription-show", short_help
="shows the details of a subscription"
5233 @click.argument("subscription_id")
5236 # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
5237 type=click
.Choice(["ns"], case_sensitive
=False),
5238 help="event type to be subscribed (for the moment, only ns is supported)",
5243 help="restricts the information to the fields in the filter",
5246 def subscription_show(ctx
, event_type
, subscription_id
, filter):
5247 """shows the details of a subscription
5249 SUBSCRIPTION_ID: ID of the subscription
5253 resp
= ctx
.obj
.subscription
.get(subscription_id
)
5254 table
= PrettyTable(["key", "attribute"])
5255 for k
, v
in list(resp
.items()):
5256 if not filter or k
in filter:
5257 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
5262 ####################
5264 ####################
5267 @cli_osm.command(name
="version", short_help
="shows client and server versions")
5269 def get_version(ctx
):
5270 """shows client and server versions"""
5272 check_client_version(ctx
.obj
, "version")
5273 print("Server version: {}".format(ctx
.obj
.get_version()))
5275 "Client version: {}".format(pkg_resources
.get_distribution("osmclient").version
)
5277 # except ClientException as e:
5283 name
="upload-package", short_help
="uploads a VNF package or NS package"
5285 @click.argument("filename")
5287 "--skip-charm-build",
5290 help="the charm will not be compiled, it is assumed to already exist",
5293 def upload_package(ctx
, filename
, skip_charm_build
):
5294 """uploads a vnf package or ns package
5296 filename: vnf or ns package folder, or vnf or ns package file (tar.gz)
5300 ctx
.obj
.package
.upload(filename
, skip_charm_build
=skip_charm_build
)
5301 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
5302 if fullclassname
!= "osmclient.sol005.client.Client":
5303 ctx
.obj
.package
.wait_for_upload(filename
)
5304 # except ClientException as e:
5309 # @cli_osm.command(name='ns-scaling-show')
5310 # @click.argument('ns_name')
5311 # @click.pass_context
5312 # def show_ns_scaling(ctx, ns_name):
5313 # """shows the status of a NS scaling operation
5315 # NS_NAME: name of the NS instance being scaled
5318 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5319 # resp = ctx.obj.ns.list()
5320 # except ClientException as e:
5324 # table = PrettyTable(
5327 # 'operational status',
5332 # if ns_name == ns['name']:
5333 # nsopdata = ctx.obj.ns.get_opdata(ns['id'])
5334 # scaling_records = nsopdata['nsr:nsr']['scaling-group-record']
5335 # for record in scaling_records:
5336 # if 'instance' in record:
5337 # instances = record['instance']
5338 # for inst in instances:
5340 # [record['scaling-group-name-ref'],
5341 # inst['instance-id'],
5342 # inst['op-status'],
5343 # time.strftime('%Y-%m-%d %H:%M:%S',
5345 # inst['create-time'])),
5351 # @cli_osm.command(name='ns-scale')
5352 # @click.argument('ns_name')
5353 # @click.option('--ns_scale_group', prompt=True)
5354 # @click.option('--index', prompt=True)
5355 # @click.option('--wait',
5359 # help='do not return the control immediately, but keep it \
5360 # until the operation is completed, or timeout')
5361 # @click.pass_context
5362 # def ns_scale(ctx, ns_name, ns_scale_group, index, wait):
5365 # NS_NAME: name of the NS instance to be scaled
5368 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5369 # ctx.obj.ns.scale(ns_name, ns_scale_group, index, wait=wait)
5370 # except ClientException as e:
5375 # @cli_osm.command(name='config-agent-list')
5376 # @click.pass_context
5377 # def config_agent_list(ctx):
5378 # """list config agents"""
5380 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5381 # except ClientException as e:
5384 # table = PrettyTable(['name', 'account-type', 'details'])
5385 # for account in ctx.obj.vca.list():
5388 # account['account-type'],
5394 # @cli_osm.command(name='config-agent-delete')
5395 # @click.argument('name')
5396 # @click.pass_context
5397 # def config_agent_delete(ctx, name):
5398 # """deletes a config agent
5400 # NAME: name of the config agent to be deleted
5403 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5404 # ctx.obj.vca.delete(name)
5405 # except ClientException as e:
5410 # @cli_osm.command(name='config-agent-add')
5411 # @click.option('--name',
5413 # @click.option('--account_type',
5415 # @click.option('--server',
5417 # @click.option('--user',
5419 # @click.option('--secret',
5422 # confirmation_prompt=True)
5423 # @click.pass_context
5424 # def config_agent_add(ctx, name, account_type, server, user, secret):
5425 # """adds a config agent"""
5427 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5428 # ctx.obj.vca.create(name, account_type, server, user, secret)
5429 # except ClientException as e:
5434 # @cli_osm.command(name='ro-dump')
5435 # @click.pass_context
5437 # """shows RO agent information"""
5438 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5439 # resp = ctx.obj.vim.get_resource_orchestrator()
5440 # table = PrettyTable(['key', 'attribute'])
5441 # for k, v in list(resp.items()):
5442 # table.add_row([k, json.dumps(v, indent=2)])
5447 # @cli_osm.command(name='vcs-list')
5448 # @click.pass_context
5449 # def vcs_list(ctx):
5450 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5451 # resp = ctx.obj.utils.get_vcs_info()
5452 # table = PrettyTable(['component name', 'state'])
5453 # for component in resp:
5454 # table.add_row([component['component_name'], component['state']])
5460 name
="ns-action", short_help
="executes an action/primitive over a NS instance"
5462 @click.argument("ns_name")
5466 help="member-vnf-index if the target is a vnf instead of a ns)",
5468 @click.option("--kdu_name", default
=None, help="kdu-name if the target is a kdu)")
5469 @click.option("--vdu_id", default
=None, help="vdu-id if the target is a vdu")
5471 "--vdu_count", default
=None, type=int, help="number of vdu instance of this vdu_id"
5473 @click.option("--action_name", prompt
=True, help="action name")
5474 @click.option("--params", default
=None, help="action params in YAML/JSON inline string")
5475 @click.option("--params_file", default
=None, help="YAML/JSON file with action params")
5477 "--timeout", required
=False, default
=None, type=int, help="timeout in seconds"
5484 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5500 """executes an action/primitive over a NS instance
5502 NS_NAME: name or ID of the NS instance
5506 check_client_version(ctx
.obj
, ctx
.command
.name
)
5509 op_data
["member_vnf_index"] = vnf_name
5511 op_data
["kdu_name"] = kdu_name
5513 op_data
["vdu_id"] = vdu_id
5514 if vdu_count
is not None:
5515 op_data
["vdu_count_index"] = vdu_count
5517 op_data
["timeout_ns_action"] = timeout
5518 op_data
["primitive"] = action_name
5520 with
open(params_file
, "r") as pf
:
5523 op_data
["primitive_params"] = yaml
.safe_load(params
)
5525 op_data
["primitive_params"] = {}
5526 print(ctx
.obj
.ns
.exec_op(ns_name
, op_name
="action", op_data
=op_data
, wait
=wait
))
5528 # except ClientException as e:
5534 name
="vnf-scale", short_help
="executes a VNF scale (adding/removing VDUs)"
5536 @click.argument("ns_name")
5537 @click.argument("vnf_name")
5539 "--scaling-group", prompt
=True, help="scaling-group-descriptor name to use"
5542 "--scale-in", default
=False, is_flag
=True, help="performs a scale in operation"
5548 help="performs a scale out operation (by default)",
5551 "--timeout", required
=False, default
=None, type=int, help="timeout in seconds"
5558 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5562 ctx
, ns_name
, vnf_name
, scaling_group
, scale_in
, scale_out
, timeout
, wait
5565 Executes a VNF scale (adding/removing VDUs)
5568 NS_NAME: name or ID of the NS instance.
5569 VNF_NAME: member-vnf-index in the NS to be scaled.
5573 check_client_version(ctx
.obj
, ctx
.command
.name
)
5574 if not scale_in
and not scale_out
:
5576 ctx
.obj
.ns
.scale_vnf(
5577 ns_name
, vnf_name
, scaling_group
, scale_in
, scale_out
, wait
, timeout
5579 # except ClientException as e:
5585 name
="ns-update", short_help
="executes an update of a Network Service."
5587 @click.argument("ns_name")
5589 "--updatetype", required
=True, type=str, help="available types: CHANGE_VNFPKG"
5595 help="extra information for update operation as YAML/JSON inline string as --config"
5596 " '{changeVnfPackageData:[{vnfInstanceId: xxx, vnfdId: yyy}]}'",
5599 "--timeout", required
=False, default
=None, type=int, help="timeout in seconds"
5606 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5609 def update(ctx
, ns_name
, updatetype
, config
, timeout
, wait
):
5610 """Executes an update of a Network Service.
5612 The update will check new revisions of the Network Functions that are part of the
5613 Network Service, and it will update them if needed.
5614 Sample update command: osm ns-update ns_instance_id --updatetype CHANGE_VNFPKG
5615 --config '{changeVnfPackageData: [{vnfInstanceId: id_x,vnfdId: id_y}]}' --timeout 300 --wait
5617 NS_NAME: Network service instance name or ID.
5622 "updateType": updatetype
,
5625 op_data
["config"] = yaml
.safe_load(config
)
5627 check_client_version(ctx
.obj
, ctx
.command
.name
)
5628 ctx
.obj
.ns
.update(ns_name
, op_data
, wait
=wait
)
5631 def iterator_split(iterator
, separators
):
5633 Splits a tuple or list into several lists whenever a separator is found
5634 For instance, the following tuple will be separated with the separator "--vnf" as follows.
5636 ("--vnf", "A", "--cause", "cause_A", "--vdu", "vdu_A1", "--vnf", "B", "--cause", "cause_B", ...
5637 "--vdu", "vdu_B1", "--count_index", "1", "--run-day1", "--vdu", "vdu_B1", "--count_index", "2")
5640 ("--vnf", "A", "--cause", "cause_A", "--vdu", "vdu_A1"),
5641 ("--vnf", "B", "--cause", "cause_B", "--vdu", "vdu_B1", "--count_index", "1", "--run-day1", ...
5642 "--vdu", "vdu_B1", "--count_index", "2")
5645 Returns as many lists as separators are found
5648 if iterator
[0] not in separators
:
5649 raise ClientException(f
"Expected one of {separators}. Received: {iterator[0]}.")
5652 for i
in range(len(iterator
)):
5653 if iterator
[i
] in separators
:
5657 raise ClientException(
5658 f
"Expected at least one argument after separator (possible separators: {separators})."
5660 list_of_lists
.append(list(iterator
[first
:i
]))
5662 if (len(iterator
) - first
) < 2:
5663 raise ClientException(
5664 f
"Expected at least one argument after separator (possible separators: {separators})."
5667 list_of_lists
.append(list(iterator
[first
: len(iterator
)]))
5668 # logger.debug(f"List of lists: {list_of_lists}")
5669 return list_of_lists
5672 def process_common_heal_params(heal_vnf_dict
, args
):
5674 current_item
= "vnf"
5676 while i
< len(args
):
5677 if args
[i
] == "--cause":
5678 if (i
+ 1 >= len(args
)) or args
[i
+ 1].startswith("--"):
5679 raise ClientException("No cause was provided after --cause")
5680 heal_vnf_dict
["cause"] = args
[i
+ 1]
5683 if args
[i
] == "--run-day1":
5684 if current_item
== "vnf":
5685 if "additionalParams" not in heal_vnf_dict
:
5686 heal_vnf_dict
["additionalParams"] = {}
5687 heal_vnf_dict
["additionalParams"]["run-day1"] = True
5689 # if current_item == "vdu"
5690 heal_vnf_dict
["additionalParams"]["vdu"][-1]["run-day1"] = True
5693 if args
[i
] == "--vdu":
5694 if "additionalParams" not in heal_vnf_dict
:
5695 heal_vnf_dict
["additionalParams"] = {}
5696 heal_vnf_dict
["additionalParams"]["vdu"] = []
5697 if (i
+ 1 >= len(args
)) or args
[i
+ 1].startswith("--"):
5698 raise ClientException("No VDU ID was provided after --vdu")
5699 heal_vnf_dict
["additionalParams"]["vdu"].append({"vdu-id": args
[i
+ 1]})
5700 current_item
= "vdu"
5703 if args
[i
] == "--count-index":
5704 if current_item
== "vnf":
5705 raise ClientException(
5706 "Option --count-index only applies to VDU, not to VNF"
5708 if (i
+ 1 >= len(args
)) or args
[i
+ 1].startswith("--"):
5709 raise ClientException("No count index was provided after --count-index")
5710 heal_vnf_dict
["additionalParams"]["vdu"][-1]["count-index"] = int(
5719 def process_ns_heal_params(ctx
, param
, value
):
5721 Processes the params in the command ns-heal
5722 Click does not allow advanced patterns for positional options like this:
5723 --vnf volumes_vnf --cause "Heal several_volumes-VM of several_volumes_vnf"
5724 --vdu several_volumes-VM
5725 --vnf charm_vnf --cause "Heal two VMs of native_manual_scale_charm_vnf"
5726 --vdu mgmtVM --count-index 1 --run-day1
5727 --vdu mgmtVM --count-index 2
5729 It returns the dictionary with all the params stored in ctx.params["heal_params"]
5732 # logger.debug(f"Args: {value}")
5733 if param
.name
!= "args":
5734 raise ClientException(f
"Unexpected param: {param.name}")
5735 # Split the tuple "value" by "--vnf"
5736 vnfs
= iterator_split(value
, ["--vnf"])
5737 logger
.debug(f
"VNFs: {vnfs}")
5739 heal_dict
["healVnfData"] = []
5741 # logger.debug(f"VNF: {vnf}")
5743 if vnf
[1].startswith("--"):
5744 raise ClientException("Expected a VNF_ID after --vnf")
5745 heal_vnf
["vnfInstanceId"] = vnf
[1]
5746 process_common_heal_params(heal_vnf
, vnf
[2:])
5747 heal_dict
["healVnfData"].append(heal_vnf
)
5748 ctx
.params
["heal_params"] = heal_dict
5754 short_help
="heals (recreates) VNFs or VDUs of a NS instance",
5755 context_settings
=dict(
5756 ignore_unknown_options
=True,
5759 @click.argument("ns_name")
5763 type=click
.UNPROCESSED
,
5764 callback
=process_ns_heal_params
,
5766 @click.option("--timeout", type=int, default
=None, help="timeout in seconds")
5771 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5774 def ns_heal(ctx
, ns_name
, args
, heal_params
, timeout
, wait
):
5775 """heals (recreates) VNFs or VDUs of a NS instance
5777 NS_NAME: name or ID of the NS instance
5781 --vnf TEXT VNF instance ID or VNF id in the NS [required]
5782 --cause TEXT human readable cause of the healing
5783 --run-day1 indicates whether or not to run day1 primitives for the VNF/VDU
5785 --count-index INTEGER count-index
5789 osm ns-heal NS_NAME|NS_ID --vnf volumes_vnf --cause "Heal several_volumes-VM of several_volumes_vnf"
5790 --vdu several_volumes-VM
5791 --vnf charm_vnf --cause "Heal two VMs of native_manual_scale_charm_vnf"
5792 --vdu mgmtVM --count-index 1 --run-day1
5793 --vdu mgmtVM --count-index 2
5796 heal_dict
= ctx
.params
["heal_params"]
5797 logger
.debug(f
"Heal dict:\n{yaml.safe_dump(heal_dict)}")
5798 # replace VNF id in the NS by the VNF instance ID
5799 for vnf
in heal_dict
["healVnfData"]:
5800 vnf_id
= vnf
["vnfInstanceId"]
5801 if not validate_uuid4(vnf_id
):
5802 vnf_filter
= f
"member-vnf-index-ref={vnf_id}"
5803 vnf_list
= ctx
.obj
.vnf
.list(ns
=ns_name
, filter=vnf_filter
)
5804 if len(vnf_list
) == 0:
5805 raise ClientException(
5806 f
"No VNF found in NS {ns_name} with filter {vnf_filter}"
5808 elif len(vnf_list
) == 1:
5809 vnf
["vnfInstanceId"] = vnf_list
[0]["_id"]
5811 raise ClientException(
5812 f
"More than 1 VNF found in NS {ns_name} with filter {vnf_filter}"
5814 logger
.debug(f
"Heal dict:\n{yaml.safe_dump(heal_dict)}")
5815 check_client_version(ctx
.obj
, ctx
.command
.name
)
5816 ctx
.obj
.ns
.heal(ns_name
, heal_dict
, wait
, timeout
)
5820 def process_vnf_heal_params(ctx
, param
, value
):
5822 Processes the params in the command vnf-heal
5823 Click does not allow advanced patterns for positional options like this:
5824 --vdu mgmtVM --count-index 1 --run-day1 --vdu mgmtVM --count-index 2
5826 It returns the dictionary with all the params stored in ctx.params["heal_params"]
5829 # logger.debug(f"Args: {value}")
5830 if param
.name
!= "args":
5831 raise ClientException(f
"Unexpected param: {param.name}")
5832 # Split the tuple "value" by "--vnf"
5835 heal_dict
["healVnfData"] = []
5836 logger
.debug(f
"VNF: {vnf}")
5837 heal_vnf
= {"vnfInstanceId": "id_to_be_substituted"}
5838 process_common_heal_params(heal_vnf
, vnf
)
5839 heal_dict
["healVnfData"].append(heal_vnf
)
5840 ctx
.params
["heal_params"] = heal_dict
5846 short_help
="heals (recreates) a VNF instance or the VDUs of a VNF instance",
5847 context_settings
=dict(
5848 ignore_unknown_options
=True,
5851 @click.argument("vnf_name")
5855 type=click
.UNPROCESSED
,
5856 callback
=process_vnf_heal_params
,
5858 @click.option("--timeout", type=int, default
=None, help="timeout in seconds")
5863 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5874 """heals (recreates) a VNF instance or the VDUs of a VNF instance
5876 VNF_NAME: name or ID of the VNF instance
5880 --cause TEXT human readable cause of the healing of the VNF
5881 --run-day1 indicates whether or not to run day1 primitives for the VNF/VDU
5883 --count-index INTEGER count-index
5887 osm vnf-heal VNF_INSTANCE_ID --vdu mgmtVM --count-index 1 --run-day1
5888 --vdu mgmtVM --count-index 2
5891 heal_dict
= ctx
.params
["heal_params"]
5892 heal_dict
["healVnfData"][-1]["vnfInstanceId"] = vnf_name
5893 logger
.debug(f
"Heal dict:\n{yaml.safe_dump(heal_dict)}")
5894 check_client_version(ctx
.obj
, ctx
.command
.name
)
5895 vnfr
= ctx
.obj
.vnf
.get(vnf_name
)
5896 ns_id
= vnfr
["nsr-id-ref"]
5897 ctx
.obj
.ns
.heal(ns_id
, heal_dict
, wait
, timeout
)
5901 @cli_osm.command(name
="alarm-show", short_help
="show alarm details")
5902 @click.argument("uuid")
5904 def alarm_show(ctx
, uuid
):
5905 """Show alarm's detail information"""
5907 check_client_version(ctx
.obj
, ctx
.command
.name
)
5908 resp
= ctx
.obj
.ns
.get_alarm(uuid
=uuid
)
5922 table
= PrettyTable(["key", "attribute"])
5924 # Arrange and return the response data
5925 alarm
= resp
.replace("ObjectId", "")
5926 for key
in alarm_filter
:
5928 value
= alarm
.get(key
)
5931 value
= alarm
.get(key
)
5933 elif key
== "ns-id":
5934 value
= alarm
["tags"].get("ns_id")
5935 elif key
== "vdu_name":
5936 value
= alarm
["tags"].get("vdu_name")
5937 elif key
== "status":
5938 value
= alarm
["alarm_status"]
5941 table
.add_row([key
, wrap_text(text
=json
.dumps(value
, indent
=2), width
=100)])
5949 @cli_osm.command(name
="alarm-list", short_help
="list all alarms")
5951 "--ns_id", default
=None, required
=False, help="List out alarm for given ns id"
5954 def alarm_list(ctx
, ns_id
):
5955 """list all alarm"""
5957 check_client_version(ctx
.obj
, ctx
.command
.name
)
5958 project_name
= os
.getenv("OSM_PROJECT", "admin")
5959 resp
= ctx
.obj
.ns
.get_alarm(project_name
=project_name
, ns_id
=ns_id
)
5961 table
= PrettyTable(
5962 ["alarm-id", "metric", "threshold", "operation", "action", "status"]
5965 # return the response data in a table
5966 resp
= resp
.replace("ObjectId", "")
5970 wrap_text(text
=str(alarm
["uuid"]), width
=38),
5974 wrap_text(text
=alarm
["action"], width
=25),
5975 alarm
["alarm_status"],
5983 @cli_osm.command(name
="alarm-update", short_help
="Update a alarm")
5984 @click.argument("uuid")
5985 @click.option("--threshold", default
=None, help="Alarm threshold")
5986 @click.option("--is_enable", default
=None, type=bool, help="enable or disable alarm")
5988 def alarm_update(ctx
, uuid
, threshold
, is_enable
):
5993 if not threshold
and is_enable
is None:
5994 raise ClientException(
5995 "Please provide option to update i.e threshold or is_enable"
5997 ctx
.obj
.ns
.update_alarm(uuid
, threshold
, is_enable
)
6000 ##############################
6001 # Role Management Operations #
6002 ##############################
6005 @cli_osm.command(name
="role-create", short_help
="creates a new role")
6006 @click.argument("name")
6007 @click.option("--permissions", default
=None, help="role permissions using a dictionary")
6009 def role_create(ctx
, name
, permissions
):
6014 NAME: Name or ID of the role.
6015 DEFINITION: Definition of grant/denial of access to resources.
6019 check_client_version(ctx
.obj
, ctx
.command
.name
)
6020 ctx
.obj
.role
.create(name
, permissions
)
6021 # except ClientException as e:
6026 @cli_osm.command(name
="role-update", short_help
="updates a role")
6027 @click.argument("name")
6028 @click.option("--set-name", default
=None, help="change name of rle")
6029 # @click.option('--permissions',
6031 # help='provide a yaml format dictionary with incremental changes. Values can be bool or None to delete')
6035 help="yaml format dictionary with permission: True/False to access grant/denial",
6037 @click.option("--remove", default
=None, help="yaml format list to remove a permission")
6039 def role_update(ctx
, name
, set_name
, add
, remove
):
6044 NAME: Name or ID of the role.
6045 DEFINITION: Definition overwrites the old definition.
6046 ADD: Grant/denial of access to resource to add.
6047 REMOVE: Grant/denial of access to resource to remove.
6051 check_client_version(ctx
.obj
, ctx
.command
.name
)
6052 ctx
.obj
.role
.update(name
, set_name
, None, add
, remove
)
6053 # except ClientException as e:
6058 @cli_osm.command(name
="role-delete", short_help
="deletes a role")
6059 @click.argument("name")
6060 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
6062 def role_delete(ctx
, name
):
6067 NAME: Name or ID of the role.
6071 check_client_version(ctx
.obj
, ctx
.command
.name
)
6072 ctx
.obj
.role
.delete(name
)
6073 # except ClientException as e:
6078 @cli_osm.command(name
="role-list", short_help
="list all roles")
6083 help="restricts the list to the projects matching the filter",
6086 def role_list(ctx
, filter):
6092 check_client_version(ctx
.obj
, ctx
.command
.name
)
6094 filter = "&".join(filter)
6095 resp
= ctx
.obj
.role
.list(filter)
6096 # except ClientException as e:
6099 table
= PrettyTable(["name", "id"])
6101 table
.add_row([role
["name"], role
["_id"]])
6106 @cli_osm.command(name
="role-show", short_help
="show specific role")
6107 @click.argument("name")
6109 def role_show(ctx
, name
):
6111 Shows the details of a role.
6114 NAME: Name or ID of the role.
6118 check_client_version(ctx
.obj
, ctx
.command
.name
)
6119 resp
= ctx
.obj
.role
.get(name
)
6120 # except ClientException as e:
6124 table
= PrettyTable(["key", "attribute"])
6125 for k
, v
in resp
.items():
6126 table
.add_row([k
, json
.dumps(v
, indent
=2)])
6131 @cli_osm.command(name
="package-create", short_help
="Create empty NS package structure")
6132 @click.argument("package-type")
6133 @click.argument("package-name")
6137 help=('(NS/VNF/NST) Set the location for package creation. Default: "."'),
6141 default
="image-name",
6142 help='(VNF) Set the name of the vdu image. Default "image-name"',
6145 "--vdus", default
=1, help="(VNF) Set the number of vdus in a VNF. Default 1"
6148 "--vcpu", default
=1, help="(VNF) Set the number of virtual CPUs in a vdu. Default 1"
6153 help="(VNF) Set the memory size (MB) of the vdu. Default 1024",
6156 "--storage", default
=10, help="(VNF) Set the disk size (GB) of the vdu. Default 10"
6161 help="(VNF) Set the number of additional interfaces apart from the management interface. Default 0",
6164 "--vendor", default
="OSM", help='(NS/VNF) Set the descriptor vendor. Default "OSM"'
6170 help="(NS/VNF/NST) Flag for overriding the package if exists.",
6176 help="(NS/VNF/NST) Flag for generating descriptor .yaml with all possible commented options",
6179 "--netslice-subnets", default
=1, help="(NST) Number of netslice subnets. Default 1"
6182 "--netslice-vlds", default
=1, help="(NST) Number of netslice vlds. Default 1"
6188 help="Flag to create a descriptor using the previous OSM format (pre SOL006, OSM<9)",
6210 Creates an OSM NS, VNF, NST package
6213 PACKAGE_TYPE: Package to be created: NS, VNF or NST.
6214 PACKAGE_NAME: Name of the package to create the folder with the content.
6219 check_client_version(ctx
.obj
, ctx
.command
.name
)
6221 "Creating the {} structure: {}/{}".format(
6222 package_type
.upper(), base_directory
, package_name
6225 resp
= ctx
.obj
.package_tool
.create(
6235 interfaces
=interfaces
,
6238 netslice_subnets
=netslice_subnets
,
6239 netslice_vlds
=netslice_vlds
,
6243 # except ClientException as inst:
6244 # print("ERROR: {}".format(inst))
6249 name
="package-validate", short_help
="Validate descriptors given a base directory"
6251 @click.argument("base-directory", default
=".", required
=False)
6253 "--recursive/--no-recursive",
6255 help="The activated recursive option will validate the yaml files"
6256 " within the indicated directory and in its subdirectories",
6262 help="Validates also the descriptors using the previous OSM format (pre SOL006)",
6265 def package_validate(ctx
, base_directory
, recursive
, old
):
6267 Validate descriptors given a base directory.
6270 BASE_DIRECTORY: Base folder for NS, VNF or NST package.
6274 check_client_version(ctx
.obj
, ctx
.command
.name
)
6275 results
= ctx
.obj
.package_tool
.validate(base_directory
, recursive
, old
)
6276 table
= PrettyTable()
6277 table
.field_names
= ["TYPE", "PATH", "VALID", "ERROR"]
6278 # Print the dictionary generated by the validation function
6279 for result
in results
:
6281 [result
["type"], result
["path"], result
["valid"], result
["error"]]
6283 table
.sortby
= "VALID"
6284 table
.align
["PATH"] = "l"
6285 table
.align
["TYPE"] = "l"
6286 table
.align
["ERROR"] = "l"
6288 # except ClientException as inst:
6289 # print("ERROR: {}".format(inst))
6294 name
="package-translate", short_help
="Translate descriptors given a base directory"
6296 @click.argument("base-directory", default
=".", required
=False)
6298 "--recursive/--no-recursive",
6300 help="The activated recursive option will translate the yaml files"
6301 " within the indicated directory and in its subdirectories",
6307 help="Do not translate yet, only make a dry-run to test translation",
6310 def package_translate(ctx
, base_directory
, recursive
, dryrun
):
6312 Translate descriptors given a base directory.
6315 BASE_DIRECTORY: Stub folder for NS, VNF or NST package.
6318 check_client_version(ctx
.obj
, ctx
.command
.name
)
6319 results
= ctx
.obj
.package_tool
.translate(base_directory
, recursive
, dryrun
)
6320 table
= PrettyTable()
6321 table
.field_names
= [
6329 # Print the dictionary generated by the validation function
6330 for result
in results
:
6333 result
["current type"],
6337 result
["translated"],
6341 table
.sortby
= "TRANSLATED"
6342 table
.align
["PATH"] = "l"
6343 table
.align
["TYPE"] = "l"
6344 table
.align
["ERROR"] = "l"
6346 # except ClientException as inst:
6347 # print("ERROR: {}".format(inst))
6351 @cli_osm.command(name
="package-build", short_help
="Build the tar.gz of the package")
6352 @click.argument("package-folder")
6354 "--skip-validation", default
=False, is_flag
=True, help="skip package validation"
6357 "--skip-charm-build",
6360 help="the charm will not be compiled, it is assumed to already exist",
6363 def package_build(ctx
, package_folder
, skip_validation
, skip_charm_build
):
6365 Build the package NS, VNF given the package_folder.
6368 PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged
6372 check_client_version(ctx
.obj
, ctx
.command
.name
)
6373 results
= ctx
.obj
.package_tool
.build(
6375 skip_validation
=skip_validation
,
6376 skip_charm_build
=skip_charm_build
,
6379 # except ClientException as inst:
6380 # print("ERROR: {}".format(inst))
6385 name
="descriptor-translate",
6386 short_help
="Translate input descriptor file from Rel EIGHT OSM descriptors to SOL006 and prints in standard output",
6388 @click.argument("descriptor-file", required
=True)
6390 def descriptor_translate(ctx
, descriptor_file
):
6392 Translate input descriptor.
6395 DESCRIPTOR_FILE: Descriptor file for NS, VNF or Network Slice.
6398 check_client_version(ctx
.obj
, ctx
.command
.name
)
6399 result
= ctx
.obj
.package_tool
.descriptor_translate(descriptor_file
)
6405 cli_osm() # pylint: disable=no-value-for-parameter
6407 except pycurl
.error
as exc
:
6410 'Maybe "--hostname" option or OSM_HOSTNAME environment variable needs to be specified'
6412 except ClientException
as exc
:
6413 print("ERROR: {}".format(exc
))
6414 except (FileNotFoundError
, PermissionError
) as exc
:
6415 print("Cannot open file: {}".format(exc
))
6416 except yaml
.YAMLError
as exc
:
6417 print("Invalid YAML format: {}".format(exc
))
6419 # TODO capture other controlled exceptions here
6420 # TODO remove the ClientException captures from all places, unless they do something different
6423 if __name__
== "__main__":