0ce20c4e4bc6daebcd809a22f27b1bf1c7d89a24
1 # Copyright 2017-2018 Sandvine
2 # Copyright 2018 Telefonica
6 # Licensed under the Apache License, Version 2.0 (the "License"); you may
7 # not use this file except in compliance with the License. You may obtain
8 # a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 # License for the specific language governing permissions and limitations
22 from osmclient
import client
23 from osmclient
.common
.exceptions
import ClientException
, NotFound
24 from prettytable
import PrettyTable
33 from datetime
import datetime
34 from typing
import Any
, Dict
37 def wrap_text(text
, width
):
38 wrapper
= textwrap
.TextWrapper(width
=width
)
39 lines
= text
.splitlines()
40 return "\n".join(map(wrapper
.fill
, lines
))
43 def trunc_text(text
, length
):
44 if len(text
) > length
:
45 return text
[: (length
- 3)] + "..."
50 def check_client_version(obj
, what
, version
="sol005"):
52 Checks the version of the client object and raises error if it not the expected.
54 :param obj: the client object
55 :what: the function or command under evaluation (used when an error is raised)
57 :raises ClientError: if the specified version does not match the client version
60 fullclassname
= obj
.__module
__ + "." + obj
.__class
__.__name
__
61 message
= 'The following commands or options are only supported with the option "--sol005": {}'.format(
65 message
= 'The following commands or options are not supported when using option "--sol005": {}'.format(
68 if fullclassname
!= "osmclient.{}.client.Client".format(version
):
69 raise ClientException(message
)
73 def get_project(project_list
, item
):
74 # project_list = ctx.obj.project.list()
75 item_project_list
= item
.get("_admin", {}).get("projects_read")
79 for p1
in item_project_list
:
81 for p2
in project_list
:
82 if p2
["_id"] == project_id
:
83 project_name
= p2
["name"]
84 return project_id
, project_name
85 return project_id
, project_name
88 def get_vim_name(vim_list
, vim_id
):
91 if v
["uuid"] == vim_id
:
98 context_settings
=dict(help_option_names
=["-h", "--help"], max_content_width
=160)
103 envvar
="OSM_HOSTNAME",
104 help="hostname of server. " + "Also can set OSM_HOSTNAME in environment",
106 # @click.option('--sol005/--no-sol005',
108 # envvar='OSM_SOL005',
109 # help='Use ETSI NFV SOL005 API (default) or the previous SO API. ' +
110 # 'Also can set OSM_SOL005 in environment')
115 help="user (defaults to admin). " + "Also can set OSM_USER in environment",
120 envvar
="OSM_PASSWORD",
121 help="password (defaults to admin). " + "Also can set OSM_PASSWORD in environment",
126 envvar
="OSM_PROJECT",
127 help="project (defaults to admin). " + "Also can set OSM_PROJECT in environment",
133 help="increase verbosity (-v INFO, -vv VERBOSE, -vvv DEBUG)",
135 @click.option("--all-projects", default
=None, is_flag
=True, help="include all projects")
137 "--public/--no-public",
139 help="flag for public items (packages, instances, VIM accounts, etc.)",
142 "--project-domain-name",
143 "project_domain_name",
145 envvar
="OSM_PROJECT_DOMAIN_NAME",
146 help="project domain name for keystone authentication (default to None). "
147 + "Also can set OSM_PROJECT_DOMAIN_NAME in environment",
150 "--user-domain-name",
153 envvar
="OSM_USER_DOMAIN_NAME",
154 help="user domain name for keystone authentication (default to None). "
155 + "Also can set OSM_USER_DOMAIN_NAME in environment",
157 # @click.option('--so-port',
159 # envvar='OSM_SO_PORT',
160 # help='hostname of server. ' +
161 # 'Also can set OSM_SO_PORT in environment')
162 # @click.option('--so-project',
164 # envvar='OSM_SO_PROJECT',
165 # help='Project Name in SO. ' +
166 # 'Also can set OSM_SO_PROJECT in environment')
167 # @click.option('--ro-hostname',
169 # envvar='OSM_RO_HOSTNAME',
170 # help='hostname of RO server. ' +
171 # 'Also can set OSM_RO_HOSTNAME in environment')
172 # @click.option('--ro-port',
174 # envvar='OSM_RO_PORT',
175 # help='hostname of RO server. ' +
176 # 'Also can set OSM_RO_PORT in environment')
178 def cli_osm(ctx
, **kwargs
):
180 hostname
= kwargs
.pop("hostname", None)
184 "either hostname option or OSM_HOSTNAME "
185 + "environment variable needs to be specified"
190 kwargs
= {k
: v
for k
, v
in kwargs
.items() if v
is not None}
191 # if so_port is not None:
192 # kwargs['so_port']=so_port
193 # if so_project is not None:
194 # kwargs['so_project']=so_project
195 # if ro_hostname is not None:
196 # kwargs['ro_host']=ro_hostname
197 # if ro_port is not None:
198 # kwargs['ro_port']=ro_port
199 sol005
= os
.getenv("OSM_SOL005", True)
200 # if user is not None:
201 # kwargs['user']=user
202 # if password is not None:
203 # kwargs['password']=password
204 # if project is not None:
205 # kwargs['project']=project
207 # kwargs['all_projects']=all_projects
208 # if public is not None:
209 # kwargs['public']=public
210 ctx
.obj
= client
.Client(host
=hostname
, sol005
=sol005
, **kwargs
)
211 logger
= logging
.getLogger("osmclient")
219 @cli_osm.command(name
="ns-list", short_help
="list all NS instances")
224 help="restricts the list to the NS instances matching the filter.",
229 help="get more details of the NS (project, vim, deployment status, configuration status.",
232 def ns_list(ctx
, filter, long):
233 """list all NS instances
237 --filter filterExpr Restricts the list to the NS instances matching the filter
240 filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
241 concatenated using the "&" character:
244 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
245 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
246 op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
248 value := scalar value
252 * zero or more occurrences
253 ? zero or one occurrence
254 [] grouping of expressions to be used with ? and *
255 "" quotation marks for marking string constants
259 "AttrName" is the name of one attribute in the data type that defines the representation
260 of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
261 <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
262 "Op" stands for the comparison operator. If the expression has concatenated <attrName>
263 entries, it means that the operator "op" is applied to the attribute addressed by the last
264 <attrName> entry included in the concatenation. All simple filter expressions are combined
265 by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
266 the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
267 concatenation of all "attrName" entries except the leaf attribute is called the "attribute
268 prefix". If an attribute referenced in an expression is an array, an object that contains a
269 corresponding array shall be considered to match the expression if any of the elements in the
270 array matches all expressions that have the same attribute prefix.
274 --filter admin-status=ENABLED
275 --filter nsd-ref=<NSD_NAME>
276 --filter nsd.vendor=<VENDOR>
277 --filter nsd.vendor=<VENDOR>&nsd-ref=<NSD_NAME>
278 --filter nsd.constituent-vnfd.vnfd-id-ref=<VNFD_NAME>
281 def summarize_deployment_status(status_dict
):
288 net_list
= status_dict
.get("nets", [])
291 if net
["status"] not in status_nets
:
292 status_nets
[net
["status"]] = 1
294 status_nets
[net
["status"]] += 1
296 for k
, v
in status_nets
.items():
297 message
+= "{}:{},".format(k
, v
)
298 message
+= "TOTAL:{}".format(n_nets
)
299 summary
+= "{}".format(message
)
304 vnf_list
= status_dict
["vnfs"]
306 member_vnf_index
= vnf
["member_vnf_index"]
307 if member_vnf_index
not in status_vnfs
:
308 status_vnfs
[member_vnf_index
] = {}
309 for vm
in vnf
["vms"]:
311 if vm
["status"] not in status_vms
:
312 status_vms
[vm
["status"]] = 1
314 status_vms
[vm
["status"]] += 1
315 if vm
["status"] not in status_vnfs
[member_vnf_index
]:
316 status_vnfs
[member_vnf_index
][vm
["status"]] = 1
318 status_vnfs
[member_vnf_index
][vm
["status"]] += 1
320 for k
, v
in status_vms
.items():
321 message
+= "{}:{},".format(k
, v
)
322 message
+= "TOTAL:{}".format(n_vms
)
323 summary
+= "\n{}".format(message
)
325 for k
, v
in status_vnfs
.items():
327 message
= "\n {} VMs: ".format(k
)
328 for k2
, v2
in v
.items():
329 message
+= "{}:{},".format(k2
, v2
)
331 message
+= "TOTAL:{}".format(total
)
335 def summarize_config_status(ee_list
):
343 if ee
["elementType"] not in status_ee
:
344 status_ee
[ee
["elementType"]] = {}
345 status_ee
[ee
["elementType"]][ee
["status"]] = 1
347 if ee
["status"] in status_ee
[ee
["elementType"]]:
348 status_ee
[ee
["elementType"]][ee
["status"]] += 1
350 status_ee
[ee
["elementType"]][ee
["status"]] = 1
351 for elementType
in ["KDU", "VDU", "PDU", "VNF", "NS"]:
352 if elementType
in status_ee
:
355 for k
, v
in status_ee
[elementType
].items():
356 message
+= "{}:{},".format(k
, v
)
358 message
+= "TOTAL:{}\n".format(total
)
359 summary
+= "{}: {}".format(elementType
, message
)
360 summary
+= "TOTAL Exec. Env.: {}".format(n_ee
)
365 check_client_version(ctx
.obj
, "--filter")
366 filter = "&".join(filter)
367 resp
= ctx
.obj
.ns
.list(filter)
369 resp
= ctx
.obj
.ns
.list()
382 "configuration status",
385 project_list
= ctx
.obj
.project
.list()
387 vim_list
= ctx
.obj
.vim
.list()
402 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
403 if fullclassname
== "osmclient.sol005.client.Client":
405 logger
.debug("NS info: {}".format(nsr
))
406 nsr_name
= nsr
["name"]
408 date
= datetime
.fromtimestamp(nsr
["create-time"]).strftime(
411 ns_state
= nsr
.get("nsState", nsr
["_admin"]["nsState"])
413 deployment_status
= summarize_deployment_status(
414 nsr
.get("deploymentStatus")
416 config_status
= summarize_config_status(nsr
.get("configurationStatus"))
417 project_id
, project_name
= get_project(project_list
, nsr
)
418 # project = '{} ({})'.format(project_name, project_id)
419 project
= project_name
420 vim_id
= nsr
.get("datacenter")
421 vim_name
= get_vim_name(vim_list
, vim_id
)
423 # vim = '{} ({})'.format(vim_name, vim_id)
425 if "currentOperation" in nsr
:
426 current_operation
= "{} ({})".format(
427 nsr
["currentOperation"], nsr
["currentOperationID"]
430 current_operation
= "{} ({})".format(
431 nsr
["_admin"].get("current-operation", "-"),
432 nsr
["_admin"]["nslcmop"],
434 error_details
= "N/A"
437 or ns_state
== "DEGRADED"
438 or ("currentOperation" not in nsr
and nsr
.get("errorDescription"))
440 error_details
= "{}\nDetail: {}".format(
441 nsr
["errorDescription"], nsr
["errorDetail"]
444 nsopdata
= ctx
.obj
.ns
.get_opdata(ns
["id"])
445 nsr
= nsopdata
["nsr:nsr"]
446 nsr_name
= nsr
["name-ref"]
447 nsr_id
= nsr
["ns-instance-config-ref"]
450 deployment_status
= (
451 nsr
["operational-status"]
452 if "operational-status" in nsr
455 ns_state
= deployment_status
456 config_status
= nsr
.get("config-status", "Not found")
457 current_operation
= "Unknown"
458 error_details
= nsr
.get("detailed-status", "Not found")
459 if config_status
== "config_not_needed":
460 config_status
= "configured (no charms)"
470 wrap_text(text
=error_details
, width
=40),
485 wrap_text(text
=error_details
, width
=40),
490 print('To get the history of all operations over a NS, run "osm ns-op-list NS_ID"')
492 'For more details on the current operation, run "osm ns-op-show OPERATION_ID"'
496 def nsd_list(ctx
, filter, long):
499 check_client_version(ctx
.obj
, "--filter")
500 filter = "&".join(filter)
501 resp
= ctx
.obj
.nsd
.list(filter)
503 resp
= ctx
.obj
.nsd
.list()
504 # print(yaml.safe_dump(resp))
505 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
506 if fullclassname
== "osmclient.sol005.client.Client":
520 table
= PrettyTable(["nsd name", "id"])
522 name
= nsd
.get("id", "-")
524 onb_state
= nsd
["_admin"].get("onboardingState", "-")
525 op_state
= nsd
["_admin"].get("operationalState", "-")
526 usage_state
= nsd
["_admin"].get("usageState", "-")
527 date
= datetime
.fromtimestamp(nsd
["_admin"]["created"]).strftime(
530 last_update
= datetime
.fromtimestamp(
531 nsd
["_admin"]["modified"]
532 ).strftime("%Y-%m-%dT%H:%M:%S")
545 table
.add_row([name
, nsd
["_id"]])
547 table
= PrettyTable(["nsd name", "id"])
549 table
.add_row([nsd
["name"], nsd
["id"]])
554 @cli_osm.command(name
="nsd-list", short_help
="list all NS packages")
559 help="restricts the list to the NSD/NSpkg matching the filter",
561 @click.option("--long", is_flag
=True, help="get more details")
563 def nsd_list1(ctx
, filter, long):
564 """list all NSD/NS pkg in the system"""
566 nsd_list(ctx
, filter, long)
569 @cli_osm.command(name
="nspkg-list", short_help
="list all NS packages")
574 help="restricts the list to the NSD/NSpkg matching the filter",
576 @click.option("--long", is_flag
=True, help="get more details")
578 def nsd_list2(ctx
, filter, long):
579 """list all NS packages"""
581 nsd_list(ctx
, filter, long)
584 def pkg_repo_list(ctx
, pkgtype
, filter, repo
, long):
585 resp
= ctx
.obj
.osmrepo
.pkg_list(pkgtype
, filter, repo
)
588 ["nfpkg name", "vendor", "version", "latest", "description", "repository"]
591 table
= PrettyTable(["nfpkg name", "repository"])
593 name
= vnfd
.get("id", vnfd
.get("name", "-"))
594 repository
= vnfd
.get("repository")
596 vendor
= vnfd
.get("provider", vnfd
.get("vendor"))
597 version
= vnfd
.get("version")
598 description
= vnfd
.get("description")
599 latest
= vnfd
.get("latest")
600 table
.add_row([name
, vendor
, version
, latest
, description
, repository
])
602 table
.add_row([name
, repository
])
607 def vnfd_list(ctx
, nf_type
, filter, long):
610 check_client_version(ctx
.obj
, "--nf_type")
612 check_client_version(ctx
.obj
, "--filter")
614 filter = "&".join(filter)
617 nf_filter
= "_admin.type=vnfd"
618 elif nf_type
== "pnf":
619 nf_filter
= "_admin.type=pnfd"
620 elif nf_type
== "hnf":
621 nf_filter
= "_admin.type=hnfd"
623 raise ClientException(
624 'wrong value for "--nf_type" option, allowed values: vnf, pnf, hnf'
627 filter = "{}&{}".format(nf_filter
, filter)
631 resp
= ctx
.obj
.vnfd
.list(filter)
633 resp
= ctx
.obj
.vnfd
.list()
634 # print(yaml.safe_dump(resp))
635 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
636 if fullclassname
== "osmclient.sol005.client.Client":
653 table
= PrettyTable(["nfpkg name", "id", "desc type"])
655 name
= vnfd
.get("id", vnfd
.get("name", "-"))
656 descriptor_type
= "sol006" if "product-name" in vnfd
else "rel8"
658 onb_state
= vnfd
["_admin"].get("onboardingState", "-")
659 op_state
= vnfd
["_admin"].get("operationalState", "-")
660 vendor
= vnfd
.get("provider", vnfd
.get("vendor"))
661 version
= vnfd
.get("version")
662 usage_state
= vnfd
["_admin"].get("usageState", "-")
663 date
= datetime
.fromtimestamp(vnfd
["_admin"]["created"]).strftime(
666 last_update
= datetime
.fromtimestamp(
667 vnfd
["_admin"]["modified"]
668 ).strftime("%Y-%m-%dT%H:%M:%S")
684 table
.add_row([name
, vnfd
["_id"], descriptor_type
])
686 table
= PrettyTable(["nfpkg name", "id"])
688 table
.add_row([vnfd
["name"], vnfd
["id"]])
693 @cli_osm.command(name
="vnfd-list", short_help
="list all xNF packages (VNF, HNF, PNF)")
694 @click.option("--nf_type", help="type of NF (vnf, pnf, hnf)")
699 help="restricts the list to the NF pkg matching the filter",
701 @click.option("--long", is_flag
=True, help="get more details")
703 def vnfd_list1(ctx
, nf_type
, filter, long):
704 """list all xNF packages (VNF, HNF, PNF)"""
706 vnfd_list(ctx
, nf_type
, filter, long)
709 @cli_osm.command(name
="vnfpkg-list", short_help
="list all xNF packages (VNF, HNF, PNF)")
710 @click.option("--nf_type", help="type of NF (vnf, pnf, hnf)")
715 help="restricts the list to the NFpkg matching the filter",
717 @click.option("--long", is_flag
=True, help="get more details")
719 def vnfd_list2(ctx
, nf_type
, filter, long):
720 """list all xNF packages (VNF, HNF, PNF)"""
722 vnfd_list(ctx
, nf_type
, filter, long)
725 @cli_osm.command(name
="nfpkg-list", short_help
="list all xNF packages (VNF, HNF, PNF)")
726 @click.option("--nf_type", help="type of NF (vnf, pnf, hnf)")
731 help="restricts the list to the NFpkg matching the filter",
733 @click.option("--long", is_flag
=True, help="get more details")
735 def nfpkg_list(ctx
, nf_type
, filter, long):
736 """list all xNF packages (VNF, HNF, PNF)"""
739 check_client_version(ctx
.obj
, ctx
.command
.name
)
740 vnfd_list(ctx
, nf_type
, filter, long)
741 # except ClientException as e:
747 name
="vnfpkg-repo-list", short_help
="list all xNF from OSM repositories"
753 help="restricts the list to the NFpkg matching the filter",
756 "--repo", default
=None, help="restricts the list to a particular OSM repository"
758 @click.option("--long", is_flag
=True, help="get more details")
760 def nfpkg_repo_list1(ctx
, filter, repo
, long):
761 """list xNF packages from OSM repositories"""
763 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
767 name
="nfpkg-repo-list", short_help
="list all xNF from OSM repositories"
773 help="restricts the list to the NFpkg matching the filter",
776 "--repo", default
=None, help="restricts the list to a particular OSM repository"
778 @click.option("--long", is_flag
=True, help="get more details")
780 def nfpkg_repo_list2(ctx
, filter, repo
, long):
781 """list xNF packages from OSM repositories"""
783 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
786 def vnf_list(ctx
, ns
, filter, long):
790 check_client_version(ctx
.obj
, "--ns")
792 filter = "&".join(filter)
793 check_client_version(ctx
.obj
, "--filter")
794 resp
= ctx
.obj
.vnf
.list(ns
, filter)
796 resp
= ctx
.obj
.vnf
.list()
797 # except ClientException as e:
800 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
801 if fullclassname
== "osmclient.sol005.client.Client":
823 table
= PrettyTable(field_names
)
825 name
= vnfr
["name"] if "name" in vnfr
else "-"
830 vnfr
["member-vnf-index-ref"],
832 vnfr
["vim-account-id"],
836 date
= datetime
.fromtimestamp(vnfr
["_admin"]["created"]).strftime(
839 last_update
= datetime
.fromtimestamp(
840 vnfr
["_admin"]["modified"]
841 ).strftime("%Y-%m-%dT%H:%M:%S")
842 new_row
.extend([date
, last_update
])
843 table
.add_row(new_row
)
845 table
= PrettyTable(["vnf name", "id", "operational status", "config status"])
847 if "mgmt-interface" not in vnfr
:
848 vnfr
["mgmt-interface"] = {}
849 vnfr
["mgmt-interface"]["ip-address"] = None
854 vnfr
["operational-status"],
855 vnfr
["config-status"],
862 @cli_osm.command(name
="vnf-list", short_help
="list all NF instances")
864 "--ns", default
=None, help="NS instance id or name to restrict the NF list"
870 help="restricts the list to the NF instances matching the filter.",
872 @click.option("--long", is_flag
=True, help="get more details")
874 def vnf_list1(ctx
, ns
, filter, long):
875 """list all NF instances"""
877 vnf_list(ctx
, ns
, filter, long)
880 @cli_osm.command(name
="nsd-repo-list", short_help
="list all NS from OSM repositories")
885 help="restricts the list to the NS matching the filter",
888 "--repo", default
=None, help="restricts the list to a particular OSM repository"
890 @click.option("--long", is_flag
=True, help="get more details")
892 def nspkg_repo_list(ctx
, filter, repo
, long):
893 """list xNF packages from OSM repositories"""
895 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
898 @cli_osm.command(name
="nspkg-repo-list", short_help
="list all NS from OSM repositories")
903 help="restricts the list to the NS matching the filter",
906 "--repo", default
=None, help="restricts the list to a particular OSM repository"
908 @click.option("--long", is_flag
=True, help="get more details")
910 def nspkg_repo_list2(ctx
, filter, repo
, long):
911 """list xNF packages from OSM repositories"""
913 pkg_repo_list(ctx
, pkgtype
, filter, repo
, long)
916 @cli_osm.command(name
="nf-list", short_help
="list all NF instances")
918 "--ns", default
=None, help="NS instance id or name to restrict the NF list"
924 help="restricts the list to the NF instances matching the filter.",
926 @click.option("--long", is_flag
=True, help="get more details")
928 def nf_list(ctx
, ns
, filter, long):
929 """list all NF instances
933 --ns TEXT NS instance id or name to restrict the VNF list
934 --filter filterExpr Restricts the list to the VNF instances matching the filter
937 filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
938 concatenated using the "&" character:
941 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
942 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
943 op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
945 value := scalar value
949 * zero or more occurrences
950 ? zero or one occurrence
951 [] grouping of expressions to be used with ? and *
952 "" quotation marks for marking string constants
956 "AttrName" is the name of one attribute in the data type that defines the representation
957 of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
958 <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
959 "Op" stands for the comparison operator. If the expression has concatenated <attrName>
960 entries, it means that the operator "op" is applied to the attribute addressed by the last
961 <attrName> entry included in the concatenation. All simple filter expressions are combined
962 by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
963 the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
964 concatenation of all "attrName" entries except the leaf attribute is called the "attribute
965 prefix". If an attribute referenced in an expression is an array, an object that contains a
966 corresponding array shall be considered to match the expression if any of the elements in the
967 array matches all expressions that have the same attribute prefix.
971 --filter vim-account-id=<VIM_ACCOUNT_ID>
972 --filter vnfd-ref=<VNFD_NAME>
973 --filter vdur.ip-address=<IP_ADDRESS>
974 --filter vnfd-ref=<VNFD_NAME>,vdur.ip-address=<IP_ADDRESS>
977 vnf_list(ctx
, ns
, filter, long)
981 name
="ns-op-list", short_help
="shows the history of operations over a NS instance"
983 @click.argument("name")
985 "--long", is_flag
=True, help="get more details of the NS operation (date, )."
988 def ns_op_list(ctx
, name
, long):
989 """shows the history of operations over a NS instance
991 NAME: name or ID of the NS instance
994 def formatParams(params
):
995 if params
["lcmOperationType"] == "instantiate":
996 params
.pop("nsDescription")
1000 elif params
["lcmOperationType"] == "action":
1001 params
.pop("primitive")
1002 params
.pop("lcmOperationType")
1003 params
.pop("nsInstanceId")
1008 check_client_version(ctx
.obj
, ctx
.command
.name
)
1009 resp
= ctx
.obj
.ns
.list_op(name
)
1010 # except ClientException as e:
1015 table
= PrettyTable(
1028 table
= PrettyTable(
1029 ["id", "operation", "action_name", "status", "date", "detail"]
1032 # print(yaml.safe_dump(resp))
1035 if op
["lcmOperationType"] == "action":
1036 action_name
= op
["operationParams"]["primitive"]
1038 if op
["operationState"] == "PROCESSING":
1039 if op
["queuePosition"] is not None and op
["queuePosition"] > 0:
1040 detail
= "In queue. Current position: {}".format(op
["queuePosition"])
1041 elif op
["lcmOperationType"] in ("instantiate", "terminate"):
1043 detail
= op
["stage"]
1044 elif op
["operationState"] in ("FAILED", "FAILED_TEMP"):
1045 detail
= op
.get("errorMessage", "-")
1046 date
= datetime
.fromtimestamp(op
["startTime"]).strftime("%Y-%m-%dT%H:%M:%S")
1047 last_update
= datetime
.fromtimestamp(op
["statusEnteredTime"]).strftime(
1054 op
["lcmOperationType"],
1057 text
=json
.dumps(formatParams(op
["operationParams"]), indent
=2),
1060 op
["operationState"],
1063 wrap_text(text
=detail
, width
=50),
1070 op
["lcmOperationType"],
1072 op
["operationState"],
1074 wrap_text(text
=detail
or "", width
=50),
1081 def nsi_list(ctx
, filter):
1082 """list all Network Slice Instances"""
1085 check_client_version(ctx
.obj
, ctx
.command
.name
)
1087 filter = "&".join(filter)
1088 resp
= ctx
.obj
.nsi
.list(filter)
1089 # except ClientException as e:
1092 table
= PrettyTable(
1094 "netslice instance name",
1096 "operational status",
1102 nsi_name
= nsi
["name"]
1105 nsi
["operational-status"] if "operational-status" in nsi
else "Not found"
1107 configstatus
= nsi
["config-status"] if "config-status" in nsi
else "Not found"
1109 nsi
["detailed-status"] if "detailed-status" in nsi
else "Not found"
1111 if configstatus
== "config_not_needed":
1112 configstatus
= "configured (no charms)"
1113 table
.add_row([nsi_name
, nsi_id
, opstatus
, configstatus
, detailed_status
])
1118 @cli_osm.command(name
="nsi-list", short_help
="list all Network Slice Instances (NSI)")
1123 help="restricts the list to the Network Slice Instances matching the filter",
1126 def nsi_list1(ctx
, filter):
1127 """list all Network Slice Instances (NSI)"""
1129 nsi_list(ctx
, filter)
1133 name
="netslice-instance-list", short_help
="list all Network Slice Instances (NSI)"
1139 help="restricts the list to the Network Slice Instances matching the filter",
1142 def nsi_list2(ctx
, filter):
1143 """list all Network Slice Instances (NSI)"""
1145 nsi_list(ctx
, filter)
1148 def nst_list(ctx
, filter):
1151 check_client_version(ctx
.obj
, ctx
.command
.name
)
1153 filter = "&".join(filter)
1154 resp
= ctx
.obj
.nst
.list(filter)
1155 # except ClientException as e:
1158 # print(yaml.safe_dump(resp))
1159 table
= PrettyTable(["nst name", "id"])
1161 name
= nst
["name"] if "name" in nst
else "-"
1162 table
.add_row([name
, nst
["_id"]])
1167 @cli_osm.command(name
="nst-list", short_help
="list all Network Slice Templates (NST)")
1172 help="restricts the list to the NST matching the filter",
1175 def nst_list1(ctx
, filter):
1176 """list all Network Slice Templates (NST) in the system"""
1178 nst_list(ctx
, filter)
1182 name
="netslice-template-list", short_help
="list all Network Slice Templates (NST)"
1188 help="restricts the list to the NST matching the filter",
1191 def nst_list2(ctx
, filter):
1192 """list all Network Slice Templates (NST) in the system"""
1194 nst_list(ctx
, filter)
1197 def nsi_op_list(ctx
, name
):
1200 check_client_version(ctx
.obj
, ctx
.command
.name
)
1201 resp
= ctx
.obj
.nsi
.list_op(name
)
1202 # except ClientException as e:
1205 table
= PrettyTable(["id", "operation", "status"])
1207 table
.add_row([op
["id"], op
["lcmOperationType"], op
["operationState"]])
1214 short_help
="shows the history of operations over a Network Slice Instance (NSI)",
1216 @click.argument("name")
1218 def nsi_op_list1(ctx
, name
):
1219 """shows the history of operations over a Network Slice Instance (NSI)
1221 NAME: name or ID of the Network Slice Instance
1224 nsi_op_list(ctx
, name
)
1228 name
="netslice-instance-op-list",
1229 short_help
="shows the history of operations over a Network Slice Instance (NSI)",
1231 @click.argument("name")
1233 def nsi_op_list2(ctx
, name
):
1234 """shows the history of operations over a Network Slice Instance (NSI)
1236 NAME: name or ID of the Network Slice Instance
1239 nsi_op_list(ctx
, name
)
1242 @cli_osm.command(name
="pdu-list", short_help
="list all Physical Deployment Units (PDU)")
1247 help="restricts the list to the Physical Deployment Units matching the filter",
1250 def pdu_list(ctx
, filter):
1251 """list all Physical Deployment Units (PDU)"""
1254 check_client_version(ctx
.obj
, ctx
.command
.name
)
1256 filter = "&".join(filter)
1257 resp
= ctx
.obj
.pdu
.list(filter)
1258 # except ClientException as e:
1261 table
= PrettyTable(["pdu name", "id", "type", "mgmt ip address"])
1263 pdu_name
= pdu
["name"]
1265 pdu_type
= pdu
["type"]
1266 pdu_ipaddress
= "None"
1267 for iface
in pdu
["interfaces"]:
1269 pdu_ipaddress
= iface
["ip-address"]
1271 table
.add_row([pdu_name
, pdu_id
, pdu_type
, pdu_ipaddress
])
1276 ####################
1278 ####################
1281 def nsd_show(ctx
, name
, literal
):
1284 resp
= ctx
.obj
.nsd
.get(name
)
1285 # resp = ctx.obj.nsd.get_individual(name)
1286 # except ClientException as e:
1291 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1294 table
= PrettyTable(["field", "value"])
1295 for k
, v
in list(resp
.items()):
1296 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1301 @cli_osm.command(name
="nsd-show", short_help
="shows the details of a NS package")
1302 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1303 @click.argument("name")
1305 def nsd_show1(ctx
, name
, literal
):
1306 """shows the content of a NSD
1308 NAME: name or ID of the NSD/NSpkg
1311 nsd_show(ctx
, name
, literal
)
1314 @cli_osm.command(name
="nspkg-show", short_help
="shows the details of a NS package")
1315 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1316 @click.argument("name")
1318 def nsd_show2(ctx
, name
, literal
):
1319 """shows the content of a NSD
1321 NAME: name or ID of the NSD/NSpkg
1324 nsd_show(ctx
, name
, literal
)
1327 def vnfd_show(ctx
, name
, literal
):
1330 resp
= ctx
.obj
.vnfd
.get(name
)
1331 # resp = ctx.obj.vnfd.get_individual(name)
1332 # except ClientException as e:
1337 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1340 table
= PrettyTable(["field", "value"])
1341 for k
, v
in list(resp
.items()):
1342 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1347 def pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
):
1350 filter = "&".join(filter)
1352 resp
= ctx
.obj
.osmrepo
.pkg_get(pkgtype
, name
, repo
, version
, filter)
1355 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1358 catalog
= pkgtype
+ "-catalog"
1359 full_catalog
= pkgtype
+ ":" + catalog
1360 if resp
.get(catalog
):
1361 resp
= resp
.pop(catalog
)[pkgtype
][0]
1362 elif resp
.get(full_catalog
):
1363 resp
= resp
.pop(full_catalog
)[pkgtype
][0]
1365 table
= PrettyTable(["field", "value"])
1366 for k
, v
in list(resp
.items()):
1367 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1372 @cli_osm.command(name
="vnfd-show", short_help
="shows the details of a NF package")
1373 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1374 @click.argument("name")
1376 def vnfd_show1(ctx
, name
, literal
):
1377 """shows the content of a VNFD
1379 NAME: name or ID of the VNFD/VNFpkg
1382 vnfd_show(ctx
, name
, literal
)
1385 @cli_osm.command(name
="vnfpkg-show", short_help
="shows the details of a NF package")
1386 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1387 @click.argument("name")
1389 def vnfd_show2(ctx
, name
, literal
):
1390 """shows the content of a VNFD
1392 NAME: name or ID of the VNFD/VNFpkg
1395 vnfd_show(ctx
, name
, literal
)
1399 name
="vnfpkg-repo-show",
1400 short_help
="shows the details of a NF package in an OSM repository",
1402 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1403 @click.option("--repo", required
=True, help="Repository name")
1404 @click.argument("name")
1405 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1406 @click.option("--version", default
="latest", help="package version")
1408 def vnfd_show3(ctx
, name
, repo
, version
, literal
=None, filter=None):
1409 """shows the content of a VNFD in a repository
1411 NAME: name or ID of the VNFD/VNFpkg
1414 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1418 name
="nsd-repo-show",
1419 short_help
="shows the details of a NS package in an OSM repository",
1421 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1422 @click.option("--repo", required
=True, help="Repository name")
1423 @click.argument("name")
1424 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1425 @click.option("--version", default
="latest", help="package version")
1427 def nsd_repo_show(ctx
, name
, repo
, version
, literal
=None, filter=None):
1428 """shows the content of a VNFD in a repository
1430 NAME: name or ID of the VNFD/VNFpkg
1433 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1437 name
="nspkg-repo-show",
1438 short_help
="shows the details of a NS package in an OSM repository",
1440 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1441 @click.option("--repo", required
=True, help="Repository name")
1442 @click.argument("name")
1443 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1444 @click.option("--version", default
="latest", help="package version")
1446 def nsd_repo_show2(ctx
, name
, repo
, version
, literal
=None, filter=None):
1447 """shows the content of a VNFD in a repository
1449 NAME: name or ID of the VNFD/VNFpkg
1452 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1455 @cli_osm.command(name
="nfpkg-show", short_help
="shows the details of a NF package")
1456 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1457 @click.argument("name")
1459 def nfpkg_show(ctx
, name
, literal
):
1460 """shows the content of a NF Descriptor
1462 NAME: name or ID of the NFpkg
1465 vnfd_show(ctx
, name
, literal
)
1469 name
="nfpkg-repo-show",
1470 short_help
="shows the details of a NF package in an OSM repository",
1472 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1473 @click.option("--repo", required
=True, help="Repository name")
1474 @click.argument("name")
1475 @click.option("--filter", default
=None, multiple
=True, help="filter by fields")
1476 @click.option("--version", default
="latest", help="package version")
1478 def vnfd_show4(ctx
, name
, repo
, version
, literal
=None, filter=None):
1479 """shows the content of a VNFD in a repository
1481 NAME: name or ID of the VNFD/VNFpkg
1484 pkg_repo_show(ctx
, pkgtype
, name
, repo
, version
, filter, literal
)
1487 @cli_osm.command(name
="ns-show", short_help
="shows the info of a NS instance")
1488 @click.argument("name")
1489 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1493 help="restricts the information to the fields in the filter",
1496 def ns_show(ctx
, name
, literal
, filter):
1497 """shows the info of a NS instance
1499 NAME: name or ID of the NS instance
1503 ns
= ctx
.obj
.ns
.get(name
)
1504 # except ClientException as e:
1509 print(yaml
.safe_dump(ns
, indent
=4, default_flow_style
=False))
1512 table
= PrettyTable(["field", "value"])
1514 for k
, v
in list(ns
.items()):
1515 if not filter or k
in filter:
1516 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1518 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
1519 if fullclassname
!= "osmclient.sol005.client.Client":
1520 nsopdata
= ctx
.obj
.ns
.get_opdata(ns
["id"])
1521 nsr_optdata
= nsopdata
["nsr:nsr"]
1522 for k
, v
in list(nsr_optdata
.items()):
1523 if not filter or k
in filter:
1524 table
.add_row([k
, wrap_text(json
.dumps(v
, indent
=2), width
=100)])
1529 @cli_osm.command(name
="vnf-show", short_help
="shows the info of a VNF instance")
1530 @click.argument("name")
1531 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1535 help="restricts the information to the fields in the filter",
1537 @click.option("--kdu", default
=None, help="KDU name (whose status will be shown)")
1539 def vnf_show(ctx
, name
, literal
, filter, kdu
):
1540 """shows the info of a VNF instance
1542 NAME: name or ID of the VNF instance
1545 def print_kdu_status(op_info_status
):
1546 """print KDU status properly formatted"""
1548 op_status
= yaml
.safe_load(op_info_status
)
1550 "namespace" in op_status
1551 and "info" in op_status
1552 and "last_deployed" in op_status
["info"]
1553 and "status" in op_status
["info"]
1554 and "code" in op_status
["info"]["status"]
1555 and "resources" in op_status
["info"]["status"]
1556 and "seconds" in op_status
["info"]["last_deployed"]
1558 last_deployed_time
= datetime
.fromtimestamp(
1559 op_status
["info"]["last_deployed"]["seconds"]
1560 ).strftime("%a %b %d %I:%M:%S %Y")
1561 print("LAST DEPLOYED: {}".format(last_deployed_time
))
1562 print("NAMESPACE: {}".format(op_status
["namespace"]))
1563 status_code
= "UNKNOWN"
1564 if op_status
["info"]["status"]["code"] == 1:
1565 status_code
= "DEPLOYED"
1566 print("STATUS: {}".format(status_code
))
1569 print(op_status
["info"]["status"]["resources"])
1570 if "notes" in op_status
["info"]["status"]:
1572 print(op_status
["info"]["status"]["notes"])
1574 print(op_info_status
)
1576 print(op_info_status
)
1581 raise ClientException(
1582 '"--literal" option is incompatible with "--kdu" option'
1585 raise ClientException(
1586 '"--filter" option is incompatible with "--kdu" option'
1590 check_client_version(ctx
.obj
, ctx
.command
.name
)
1591 resp
= ctx
.obj
.vnf
.get(name
)
1594 ns_id
= resp
["nsr-id-ref"]
1596 op_data
["member_vnf_index"] = resp
["member-vnf-index-ref"]
1597 op_data
["kdu_name"] = kdu
1598 op_data
["primitive"] = "status"
1599 op_data
["primitive_params"] = {}
1600 op_id
= ctx
.obj
.ns
.exec_op(ns_id
, op_name
="action", op_data
=op_data
, wait
=False)
1603 op_info
= ctx
.obj
.ns
.get_op(op_id
)
1604 if op_info
["operationState"] == "COMPLETED":
1605 print_kdu_status(op_info
["detailed-status"])
1609 print("Could not determine KDU status")
1613 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1616 table
= PrettyTable(["field", "value"])
1617 for k
, v
in list(resp
.items()):
1618 if not filter or k
in filter:
1619 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
1622 # except ClientException as e:
1627 # @cli_osm.command(name='vnf-monitoring-show')
1628 # @click.argument('vnf_name')
1629 # @click.pass_context
1630 # def vnf_monitoring_show(ctx, vnf_name):
1632 # check_client_version(ctx.obj, ctx.command.name, 'v1')
1633 # resp = ctx.obj.vnf.get_monitoring(vnf_name)
1634 # except ClientException as e:
1638 # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
1639 # if resp is not None:
1640 # for monitor in resp:
1644 # monitor['value-integer'],
1645 # monitor['units']])
1650 # @cli_osm.command(name='ns-monitoring-show')
1651 # @click.argument('ns_name')
1652 # @click.pass_context
1653 # def ns_monitoring_show(ctx, ns_name):
1655 # check_client_version(ctx.obj, ctx.command.name, 'v1')
1656 # resp = ctx.obj.ns.get_monitoring(ns_name)
1657 # except ClientException as e:
1661 # table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
1662 # for key, val in list(resp.items()):
1663 # for monitor in val:
1667 # monitor['value-integer'],
1668 # monitor['units']])
1673 @cli_osm.command(name
="ns-op-show", short_help
="shows the info of a NS operation")
1674 @click.argument("id")
1678 help="restricts the information to the fields in the filter",
1680 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1682 def ns_op_show(ctx
, id, filter, literal
):
1683 """shows the detailed info of a NS operation
1685 ID: operation identifier
1689 check_client_version(ctx
.obj
, ctx
.command
.name
)
1690 op_info
= ctx
.obj
.ns
.get_op(id)
1691 # except ClientException as e:
1696 print(yaml
.safe_dump(op_info
, indent
=4, default_flow_style
=False))
1699 table
= PrettyTable(["field", "value"])
1700 for k
, v
in list(op_info
.items()):
1701 if not filter or k
in filter:
1702 table
.add_row([k
, wrap_text(json
.dumps(v
, indent
=2), 100)])
1707 def nst_show(ctx
, name
, literal
):
1710 check_client_version(ctx
.obj
, ctx
.command
.name
)
1711 resp
= ctx
.obj
.nst
.get(name
)
1712 # resp = ctx.obj.nst.get_individual(name)
1713 # except ClientException as e:
1718 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
1721 table
= PrettyTable(["field", "value"])
1722 for k
, v
in list(resp
.items()):
1723 table
.add_row([k
, wrap_text(json
.dumps(v
, indent
=2), 100)])
1729 name
="nst-show", short_help
="shows the content of a Network Slice Template (NST)"
1731 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1732 @click.argument("name")
1734 def nst_show1(ctx
, name
, literal
):
1735 """shows the content of a Network Slice Template (NST)
1737 NAME: name or ID of the NST
1740 nst_show(ctx
, name
, literal
)
1744 name
="netslice-template-show",
1745 short_help
="shows the content of a Network Slice Template (NST)",
1747 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1748 @click.argument("name")
1750 def nst_show2(ctx
, name
, literal
):
1751 """shows the content of a Network Slice Template (NST)
1753 NAME: name or ID of the NST
1756 nst_show(ctx
, name
, literal
)
1759 def nsi_show(ctx
, name
, literal
, filter):
1762 check_client_version(ctx
.obj
, ctx
.command
.name
)
1763 nsi
= ctx
.obj
.nsi
.get(name
)
1764 # except ClientException as e:
1769 print(yaml
.safe_dump(nsi
, indent
=4, default_flow_style
=False))
1772 table
= PrettyTable(["field", "value"])
1774 for k
, v
in list(nsi
.items()):
1775 if not filter or k
in filter:
1776 table
.add_row([k
, json
.dumps(v
, indent
=2)])
1783 name
="nsi-show", short_help
="shows the content of a Network Slice Instance (NSI)"
1785 @click.argument("name")
1786 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1790 help="restricts the information to the fields in the filter",
1793 def nsi_show1(ctx
, name
, literal
, filter):
1794 """shows the content of a Network Slice Instance (NSI)
1796 NAME: name or ID of the Network Slice Instance
1799 nsi_show(ctx
, name
, literal
, filter)
1803 name
="netslice-instance-show",
1804 short_help
="shows the content of a Network Slice Instance (NSI)",
1806 @click.argument("name")
1807 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1811 help="restricts the information to the fields in the filter",
1814 def nsi_show2(ctx
, name
, literal
, filter):
1815 """shows the content of a Network Slice Instance (NSI)
1817 NAME: name or ID of the Network Slice Instance
1820 nsi_show(ctx
, name
, literal
, filter)
1823 def nsi_op_show(ctx
, id, filter):
1826 check_client_version(ctx
.obj
, ctx
.command
.name
)
1827 op_info
= ctx
.obj
.nsi
.get_op(id)
1828 # except ClientException as e:
1832 table
= PrettyTable(["field", "value"])
1833 for k
, v
in list(op_info
.items()):
1834 if not filter or k
in filter:
1835 table
.add_row([k
, json
.dumps(v
, indent
=2)])
1842 short_help
="shows the info of an operation over a Network Slice Instance(NSI)",
1844 @click.argument("id")
1848 help="restricts the information to the fields in the filter",
1851 def nsi_op_show1(ctx
, id, filter):
1852 """shows the info of an operation over a Network Slice Instance(NSI)
1854 ID: operation identifier
1857 nsi_op_show(ctx
, id, filter)
1861 name
="netslice-instance-op-show",
1862 short_help
="shows the info of an operation over a Network Slice Instance(NSI)",
1864 @click.argument("id")
1868 help="restricts the information to the fields in the filter",
1871 def nsi_op_show2(ctx
, id, filter):
1872 """shows the info of an operation over a Network Slice Instance(NSI)
1874 ID: operation identifier
1877 nsi_op_show(ctx
, id, filter)
1881 name
="pdu-show", short_help
="shows the content of a Physical Deployment Unit (PDU)"
1883 @click.argument("name")
1884 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
1888 help="restricts the information to the fields in the filter",
1891 def pdu_show(ctx
, name
, literal
, filter):
1892 """shows the content of a Physical Deployment Unit (PDU)
1894 NAME: name or ID of the PDU
1898 check_client_version(ctx
.obj
, ctx
.command
.name
)
1899 pdu
= ctx
.obj
.pdu
.get(name
)
1900 # except ClientException as e:
1905 print(yaml
.safe_dump(pdu
, indent
=4, default_flow_style
=False))
1908 table
= PrettyTable(["field", "value"])
1910 for k
, v
in list(pdu
.items()):
1911 if not filter or k
in filter:
1912 table
.add_row([k
, json
.dumps(v
, indent
=2)])
1918 ####################
1920 ####################
1923 def nsd_create(ctx
, filename
, overwrite
, skip_charm_build
, repo
, vendor
, version
):
1926 check_client_version(ctx
.obj
, ctx
.command
.name
)
1928 filename
= ctx
.obj
.osmrepo
.get_pkg("ns", filename
, repo
, vendor
, version
)
1929 ctx
.obj
.nsd
.create(filename
, overwrite
=overwrite
, skip_charm_build
=skip_charm_build
)
1930 # except ClientException as e:
1935 @cli_osm.command(name
="nsd-create", short_help
="creates a new NSD/NSpkg")
1936 @click.argument("filename")
1940 default
=None, # hidden=True,
1941 help="Deprecated. Use override",
1947 help="overrides fields in descriptor, format: "
1948 '"key1.key2...=value[;key3...=value;...]"',
1951 "--skip-charm-build",
1954 help="The charm will not be compiled, it is assumed to already exist",
1956 @click.option("--repo", default
=None, help="[repository]: Repository name")
1957 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
1961 help="[repository]: filter by version. Default: latest",
1964 def nsd_create1(ctx
, filename
, overwrite
, skip_charm_build
, repo
, vendor
, version
):
1965 """onboards a new NSpkg (alias of nspkg-create) (TO BE DEPRECATED)
1968 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
1969 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
1970 If FILENAME is an NF Package folder, it is built and then onboarded.
1976 overwrite
=overwrite
,
1977 skip_charm_build
=skip_charm_build
,
1984 @cli_osm.command(name
="nspkg-create", short_help
="creates a new NSD/NSpkg")
1985 @click.argument("filename")
1989 default
=None, # hidden=True,
1990 help="Deprecated. Use override",
1996 help="overrides fields in descriptor, format: "
1997 '"key1.key2...=value[;key3...=value;...]"',
2000 "--skip-charm-build",
2003 help="The charm will not be compiled, it is assumed to already exist",
2005 @click.option("--repo", default
=None, help="[repository]: Repository name")
2006 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2010 help="[repository]: filter by version. Default: latest",
2013 def nsd_pkg_create(ctx
, filename
, overwrite
, skip_charm_build
, repo
, vendor
, version
):
2014 """onboards a new NSpkg
2016 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2017 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2018 If FILENAME is an NF Package folder, it is built and then onboarded.
2024 overwrite
=overwrite
,
2025 skip_charm_build
=skip_charm_build
,
2046 check_client_version(ctx
.obj
, ctx
.command
.name
)
2048 filename
= ctx
.obj
.osmrepo
.get_pkg("vnf", filename
, repo
, vendor
, version
)
2049 ctx
.obj
.vnfd
.create(
2051 overwrite
=overwrite
,
2052 skip_charm_build
=skip_charm_build
,
2053 override_epa
=override_epa
,
2054 override_nonepa
=override_nonepa
,
2055 override_paravirt
=override_paravirt
,
2057 # except ClientException as e:
2062 @cli_osm.command(name
="vnfd-create", short_help
="creates a new VNFD/VNFpkg")
2063 @click.argument("filename")
2065 "--overwrite", "overwrite", default
=None, help="overwrite deprecated, use override"
2071 help="overrides fields in descriptor, format: "
2072 '"key1.key2...=value[;key3...=value;...]"',
2075 "--skip-charm-build",
2078 help="The charm will not be compiled, it is assumed to already exist",
2085 help="adds guest-epa parameters to all VDU",
2088 "--override-nonepa",
2092 help="removes all guest-epa parameters from all VDU",
2095 "--override-paravirt",
2099 help="overrides all VDU interfaces to PARAVIRT",
2101 @click.option("--repo", default
=None, help="[repository]: Repository name")
2102 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2106 help="[repository]: filter by version. Default: latest",
2121 """creates a new VNFD/VNFpkg
2123 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2124 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2125 If FILENAME is an NF Package folder, it is built and then onboarded.
2131 overwrite
=overwrite
,
2132 skip_charm_build
=skip_charm_build
,
2133 override_epa
=override_epa
,
2134 override_nonepa
=override_nonepa
,
2135 override_paravirt
=override_paravirt
,
2142 @cli_osm.command(name
="vnfpkg-create", short_help
="creates a new VNFD/VNFpkg")
2143 @click.argument("filename")
2147 default
=None, # hidden=True,
2148 help="Deprecated. Use override",
2154 help="overrides fields in descriptor, format: "
2155 '"key1.key2...=value[;key3...=value;...]"',
2158 "--skip-charm-build",
2161 help="The charm will not be compiled, it is assumed to already exist",
2168 help="adds guest-epa parameters to all VDU",
2171 "--override-nonepa",
2175 help="removes all guest-epa parameters from all VDU",
2178 "--override-paravirt",
2182 help="overrides all VDU interfaces to PARAVIRT",
2184 @click.option("--repo", default
=None, help="[repository]: Repository name")
2185 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2189 help="[repository]: filter by version. Default: latest",
2204 """creates a new VNFD/VNFpkg
2206 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2207 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2208 If FILENAME is an NF Package folder, it is built and then onboarded.
2214 overwrite
=overwrite
,
2215 skip_charm_build
=skip_charm_build
,
2216 override_epa
=override_epa
,
2217 override_nonepa
=override_nonepa
,
2218 override_paravirt
=override_paravirt
,
2225 @cli_osm.command(name
="nfpkg-create", short_help
="creates a new NFpkg")
2226 @click.argument("filename")
2230 default
=None, # hidden=True,
2231 help="Deprecated. Use override",
2237 help="overrides fields in descriptor, format: "
2238 '"key1.key2...=value[;key3...=value;...]"',
2241 "--skip-charm-build",
2244 help="The charm will not be compiled, it is assumed to already exist",
2251 help="adds guest-epa parameters to all VDU",
2254 "--override-nonepa",
2258 help="removes all guest-epa parameters from all VDU",
2261 "--override-paravirt",
2265 help="overrides all VDU interfaces to PARAVIRT",
2267 @click.option("--repo", default
=None, help="[repository]: Repository name")
2268 @click.option("--vendor", default
=None, help="[repository]: filter by vendor]")
2272 help="[repository]: filter by version. Default: latest",
2287 """creates a new NFpkg
2290 FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder
2291 If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.
2292 If FILENAME is an NF Package folder, it is built and then onboarded.
2298 overwrite
=overwrite
,
2299 skip_charm_build
=skip_charm_build
,
2300 override_epa
=override_epa
,
2301 override_nonepa
=override_nonepa
,
2302 override_paravirt
=override_paravirt
,
2309 @cli_osm.command(name
="ns-create", short_help
="creates a new Network Service instance")
2310 @click.option("--ns_name", prompt
=True, help="name of the NS instance")
2311 @click.option("--nsd_name", prompt
=True, help="name of the NS descriptor")
2315 help="default VIM account id or name for the deployment",
2317 @click.option("--admin_status", default
="ENABLED", help="administration status")
2321 help="comma separated list of public key files to inject to vnfs",
2323 @click.option("--config", default
=None, help="ns specific yaml configuration")
2324 @click.option("--config_file", default
=None, help="ns specific yaml configuration file")
2330 help="do not return the control immediately, but keep it "
2331 "until the operation is completed, or timeout",
2345 """creates a new NS instance"""
2349 check_client_version(ctx
.obj
, "--config_file")
2351 raise ClientException(
2352 '"--config" option is incompatible with "--config_file" option'
2354 with
open(config_file
, "r") as cf
:
2361 account
=vim_account
,
2364 # except ClientException as e:
2369 def nst_create(ctx
, filename
, overwrite
):
2372 check_client_version(ctx
.obj
, ctx
.command
.name
)
2373 ctx
.obj
.nst
.create(filename
, overwrite
)
2374 # except ClientException as e:
2380 name
="nst-create", short_help
="creates a new Network Slice Template (NST)"
2382 @click.argument("filename")
2386 default
=None, # hidden=True,
2387 help="Deprecated. Use override",
2393 help="overrides fields in descriptor, format: "
2394 '"key1.key2...=value[;key3...=value;...]"',
2397 def nst_create1(ctx
, filename
, overwrite
):
2398 """creates a new Network Slice Template (NST)
2400 FILENAME: NST package folder, NST yaml file or NSTpkg tar.gz file
2403 nst_create(ctx
, filename
, overwrite
)
2407 name
="netslice-template-create",
2408 short_help
="creates a new Network Slice Template (NST)",
2410 @click.argument("filename")
2414 default
=None, # hidden=True,
2415 help="Deprecated. Use override",
2421 help="overrides fields in descriptor, format: "
2422 '"key1.key2...=value[;key3...=value;...]"',
2425 def nst_create2(ctx
, filename
, overwrite
):
2426 """creates a new Network Slice Template (NST)
2428 FILENAME: NST yaml file or NSTpkg tar.gz file
2431 nst_create(ctx
, filename
, overwrite
)
2435 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
2437 """creates a new Network Slice Instance (NSI)"""
2440 check_client_version(ctx
.obj
, ctx
.command
.name
)
2443 raise ClientException(
2444 '"--config" option is incompatible with "--config_file" option'
2446 with
open(config_file
, "r") as cf
:
2453 account
=vim_account
,
2456 # except ClientException as e:
2461 @cli_osm.command(name
="nsi-create", short_help
="creates a new Network Slice Instance")
2462 @click.option("--nsi_name", prompt
=True, help="name of the Network Slice Instance")
2463 @click.option("--nst_name", prompt
=True, help="name of the Network Slice Template")
2467 help="default VIM account id or name for the deployment",
2470 "--ssh_keys", default
=None, help="comma separated list of keys to inject to vnfs"
2475 help="Netslice specific yaml configuration:\n"
2476 "netslice_subnet: [\n"
2477 "id: TEXT, vim_account: TEXT,\n"
2478 "vnf: [member-vnf-index: TEXT, vim_account: TEXT]\n"
2479 "vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]\n"
2480 "additionalParamsForNsi: {param: value, ...}\n"
2481 "additionalParamsForsubnet: [{id: SUBNET_ID, additionalParamsForNs: {}, additionalParamsForVnf: {}}]\n"
2483 "netslice-vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]",
2486 "--config_file", default
=None, help="nsi specific yaml configuration file"
2493 help="do not return the control immediately, but keep it "
2494 "until the operation is completed, or timeout",
2498 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
2500 """creates a new Network Slice Instance (NSI)"""
2503 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
=wait
2508 name
="netslice-instance-create", short_help
="creates a new Network Slice Instance"
2510 @click.option("--nsi_name", prompt
=True, help="name of the Network Slice Instance")
2511 @click.option("--nst_name", prompt
=True, help="name of the Network Slice Template")
2515 help="default VIM account id or name for the deployment",
2518 "--ssh_keys", default
=None, help="comma separated list of keys to inject to vnfs"
2523 help="Netslice specific yaml configuration:\n"
2524 "netslice_subnet: [\n"
2525 "id: TEXT, vim_account: TEXT,\n"
2526 "vnf: [member-vnf-index: TEXT, vim_account: TEXT]\n"
2527 "vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]"
2529 "netslice-vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]",
2532 "--config_file", default
=None, help="nsi specific yaml configuration file"
2539 help="do not return the control immediately, but keep it "
2540 "until the operation is completed, or timeout",
2544 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
2546 """creates a new Network Slice Instance (NSI)"""
2549 ctx
, nst_name
, nsi_name
, vim_account
, ssh_keys
, config
, config_file
, wait
=wait
2554 name
="pdu-create", short_help
="adds a new Physical Deployment Unit to the catalog"
2556 @click.option("--name", help="name of the Physical Deployment Unit")
2557 @click.option("--pdu_type", help="type of PDU (e.g. router, firewall, FW001)")
2560 help="interface(s) of the PDU: name=<NAME>,mgmt=<true|false>,ip-address=<IP_ADDRESS>"
2561 + "[,type=<overlay|underlay>][,mac-address=<MAC_ADDRESS>][,vim-network-name=<VIM_NET_NAME>]",
2564 @click.option("--description", help="human readable description")
2567 help="list of VIM accounts (in the same VIM) that can reach this PDU",
2571 "--descriptor_file",
2573 help="PDU descriptor file (as an alternative to using the other arguments",
2577 ctx
, name
, pdu_type
, interface
, description
, vim_account
, descriptor_file
2579 """creates a new Physical Deployment Unit (PDU)"""
2582 check_client_version(ctx
.obj
, ctx
.command
.name
)
2584 if not descriptor_file
:
2586 raise ClientException(
2587 'in absence of descriptor file, option "--name" is mandatory'
2590 raise ClientException(
2591 'in absence of descriptor file, option "--pdu_type" is mandatory'
2594 raise ClientException(
2595 'in absence of descriptor file, option "--interface" is mandatory (at least once)'
2598 raise ClientException(
2599 'in absence of descriptor file, option "--vim_account" is mandatory (at least once)'
2602 with
open(descriptor_file
, "r") as df
:
2603 pdu
= yaml
.safe_load(df
.read())
2607 pdu
["type"] = pdu_type
2609 pdu
["description"] = description
2611 pdu
["vim_accounts"] = vim_account
2614 for iface
in interface
:
2615 new_iface
= {k
: v
for k
, v
in [i
.split("=") for i
in iface
.split(",")]}
2616 new_iface
["mgmt"] = new_iface
.get("mgmt", "false").lower() == "true"
2617 ifaces_list
.append(new_iface
)
2618 pdu
["interfaces"] = ifaces_list
2619 ctx
.obj
.pdu
.create(pdu
)
2620 # except ClientException as e:
2625 ####################
2627 ####################
2630 def nsd_update(ctx
, name
, content
):
2633 check_client_version(ctx
.obj
, ctx
.command
.name
)
2634 ctx
.obj
.nsd
.update(name
, content
)
2635 # except ClientException as e:
2640 @cli_osm.command(name
="nsd-update", short_help
="updates a NSD/NSpkg")
2641 @click.argument("name")
2645 help="filename with the NSD/NSpkg replacing the current one",
2648 def nsd_update1(ctx
, name
, content
):
2649 """updates a NSD/NSpkg
2651 NAME: name or ID of the NSD/NSpkg
2654 nsd_update(ctx
, name
, content
)
2657 @cli_osm.command(name
="nspkg-update", short_help
="updates a NSD/NSpkg")
2658 @click.argument("name")
2662 help="filename with the NSD/NSpkg replacing the current one",
2665 def nsd_update2(ctx
, name
, content
):
2666 """updates a NSD/NSpkg
2668 NAME: name or ID of the NSD/NSpkg
2671 nsd_update(ctx
, name
, content
)
2674 def vnfd_update(ctx
, name
, content
):
2677 check_client_version(ctx
.obj
, ctx
.command
.name
)
2678 ctx
.obj
.vnfd
.update(name
, content
)
2679 # except ClientException as e:
2684 @cli_osm.command(name
="vnfd-update", short_help
="updates a new VNFD/VNFpkg")
2685 @click.argument("name")
2689 help="filename with the VNFD/VNFpkg replacing the current one",
2692 def vnfd_update1(ctx
, name
, content
):
2693 """updates a VNFD/VNFpkg
2695 NAME: name or ID of the VNFD/VNFpkg
2698 vnfd_update(ctx
, name
, content
)
2701 @cli_osm.command(name
="vnfpkg-update", short_help
="updates a VNFD/VNFpkg")
2702 @click.argument("name")
2706 help="filename with the VNFD/VNFpkg replacing the current one",
2709 def vnfd_update2(ctx
, name
, content
):
2710 """updates a VNFD/VNFpkg
2712 NAME: VNFD yaml file or VNFpkg tar.gz file
2715 vnfd_update(ctx
, name
, content
)
2718 @cli_osm.command(name
="nfpkg-update", short_help
="updates a NFpkg")
2719 @click.argument("name")
2721 "--content", default
=None, help="filename with the NFpkg replacing the current one"
2724 def nfpkg_update(ctx
, name
, content
):
2727 NAME: NF Descriptor yaml file or NFpkg tar.gz file
2730 vnfd_update(ctx
, name
, content
)
2733 def nst_update(ctx
, name
, content
):
2736 check_client_version(ctx
.obj
, ctx
.command
.name
)
2737 ctx
.obj
.nst
.update(name
, content
)
2738 # except ClientException as e:
2743 @cli_osm.command(name
="nst-update", short_help
="updates a Network Slice Template (NST)")
2744 @click.argument("name")
2748 help="filename with the NST/NSTpkg replacing the current one",
2751 def nst_update1(ctx
, name
, content
):
2752 """updates a Network Slice Template (NST)
2754 NAME: name or ID of the NSD/NSpkg
2757 nst_update(ctx
, name
, content
)
2761 name
="netslice-template-update", short_help
="updates a Network Slice Template (NST)"
2763 @click.argument("name")
2767 help="filename with the NST/NSTpkg replacing the current one",
2770 def nst_update2(ctx
, name
, content
):
2771 """updates a Network Slice Template (NST)
2773 NAME: name or ID of the NSD/NSpkg
2776 nst_update(ctx
, name
, content
)
2779 ####################
2781 ####################
2784 def nsd_delete(ctx
, name
, force
):
2788 ctx
.obj
.nsd
.delete(name
)
2790 check_client_version(ctx
.obj
, "--force")
2791 ctx
.obj
.nsd
.delete(name
, force
)
2792 # except ClientException as e:
2797 @cli_osm.command(name
="nsd-delete", short_help
="deletes a NSD/NSpkg")
2798 @click.argument("name")
2800 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2803 def nsd_delete1(ctx
, name
, force
):
2804 """deletes a NSD/NSpkg
2806 NAME: name or ID of the NSD/NSpkg to be deleted
2809 nsd_delete(ctx
, name
, force
)
2812 @cli_osm.command(name
="nspkg-delete", short_help
="deletes a NSD/NSpkg")
2813 @click.argument("name")
2815 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2818 def nsd_delete2(ctx
, name
, force
):
2819 """deletes a NSD/NSpkg
2821 NAME: name or ID of the NSD/NSpkg to be deleted
2824 nsd_delete(ctx
, name
, force
)
2827 def vnfd_delete(ctx
, name
, force
):
2831 ctx
.obj
.vnfd
.delete(name
)
2833 check_client_version(ctx
.obj
, "--force")
2834 ctx
.obj
.vnfd
.delete(name
, force
)
2835 # except ClientException as e:
2840 @cli_osm.command(name
="vnfd-delete", short_help
="deletes a VNFD/VNFpkg")
2841 @click.argument("name")
2843 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2846 def vnfd_delete1(ctx
, name
, force
):
2847 """deletes a VNFD/VNFpkg
2849 NAME: name or ID of the VNFD/VNFpkg to be deleted
2852 vnfd_delete(ctx
, name
, force
)
2855 @cli_osm.command(name
="vnfpkg-delete", short_help
="deletes a VNFD/VNFpkg")
2856 @click.argument("name")
2858 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2861 def vnfd_delete2(ctx
, name
, force
):
2862 """deletes a VNFD/VNFpkg
2864 NAME: name or ID of the VNFD/VNFpkg to be deleted
2867 vnfd_delete(ctx
, name
, force
)
2870 @cli_osm.command(name
="nfpkg-delete", short_help
="deletes a NFpkg")
2871 @click.argument("name")
2873 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2876 def nfpkg_delete(ctx
, name
, force
):
2879 NAME: name or ID of the NFpkg to be deleted
2882 vnfd_delete(ctx
, name
, force
)
2885 @cli_osm.command(name
="ns-delete", short_help
="deletes a NS instance")
2886 @click.argument("name")
2888 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2893 help="specific yaml configuration for the termination, e.g. '{autoremove: False, timeout_ns_terminate: "
2894 "600, skip_terminate_primitives: True}'",
2901 help="do not return the control immediately, but keep it "
2902 "until the operation is completed, or timeout",
2905 def ns_delete(ctx
, name
, force
, config
, wait
):
2906 """deletes a NS instance
2908 NAME: name or ID of the NS instance to be deleted
2913 ctx
.obj
.ns
.delete(name
, config
=config
, wait
=wait
)
2915 check_client_version(ctx
.obj
, "--force")
2916 ctx
.obj
.ns
.delete(name
, force
, config
=config
, wait
=wait
)
2917 # except ClientException as e:
2922 def nst_delete(ctx
, name
, force
):
2925 check_client_version(ctx
.obj
, ctx
.command
.name
)
2926 ctx
.obj
.nst
.delete(name
, force
)
2927 # except ClientException as e:
2932 @cli_osm.command(name
="nst-delete", short_help
="deletes a Network Slice Template (NST)")
2933 @click.argument("name")
2935 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2938 def nst_delete1(ctx
, name
, force
):
2939 """deletes a Network Slice Template (NST)
2941 NAME: name or ID of the NST/NSTpkg to be deleted
2944 nst_delete(ctx
, name
, force
)
2948 name
="netslice-template-delete", short_help
="deletes a Network Slice Template (NST)"
2950 @click.argument("name")
2952 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2955 def nst_delete2(ctx
, name
, force
):
2956 """deletes a Network Slice Template (NST)
2958 NAME: name or ID of the NST/NSTpkg to be deleted
2961 nst_delete(ctx
, name
, force
)
2964 def nsi_delete(ctx
, name
, force
, wait
):
2967 check_client_version(ctx
.obj
, ctx
.command
.name
)
2968 ctx
.obj
.nsi
.delete(name
, force
, wait
=wait
)
2969 # except ClientException as e:
2974 @cli_osm.command(name
="nsi-delete", short_help
="deletes a Network Slice Instance (NSI)")
2975 @click.argument("name")
2977 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
2984 help="do not return the control immediately, but keep it "
2985 "until the operation is completed, or timeout",
2988 def nsi_delete1(ctx
, name
, force
, wait
):
2989 """deletes a Network Slice Instance (NSI)
2991 NAME: name or ID of the Network Slice instance to be deleted
2994 nsi_delete(ctx
, name
, force
, wait
=wait
)
2998 name
="netslice-instance-delete", short_help
="deletes a Network Slice Instance (NSI)"
3000 @click.argument("name")
3002 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3005 def nsi_delete2(ctx
, name
, force
, wait
):
3006 """deletes a Network Slice Instance (NSI)
3008 NAME: name or ID of the Network Slice instance to be deleted
3011 nsi_delete(ctx
, name
, force
, wait
=wait
)
3015 name
="pdu-delete", short_help
="deletes a Physical Deployment Unit (PDU)"
3017 @click.argument("name")
3019 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3022 def pdu_delete(ctx
, name
, force
):
3023 """deletes a Physical Deployment Unit (PDU)
3025 NAME: name or ID of the PDU to be deleted
3029 check_client_version(ctx
.obj
, ctx
.command
.name
)
3030 ctx
.obj
.pdu
.delete(name
, force
)
3031 # except ClientException as e:
3041 @cli_osm.command(name
="vim-create", short_help
="creates a new VIM account")
3042 @click.option("--name", prompt
=True, help="Name to create datacenter")
3043 @click.option("--user", prompt
=True, help="VIM username")
3048 confirmation_prompt
=True,
3049 help="VIM password",
3051 @click.option("--auth_url", prompt
=True, help="VIM url")
3052 @click.option("--tenant", prompt
=True, help="VIM tenant name")
3053 @click.option("--config", default
=None, help="VIM specific config parameters")
3054 @click.option("--account_type", default
="openstack", help="VIM type")
3055 @click.option("--description", default
=None, help="human readable description")
3059 help="Name or id of the SDN controller associated to this VIM account",
3062 "--sdn_port_mapping",
3064 help="File describing the port mapping between compute nodes' ports and switch ports",
3071 help="do not return the control immediately, but keep it "
3072 "until the operation is completed, or timeout",
3074 @click.option("--vca", default
=None, help="VCA to be used in this VIM account")
3091 """creates a new VIM account"""
3095 check_client_version(ctx
.obj
, "--sdn_controller")
3096 if sdn_port_mapping
:
3097 check_client_version(ctx
.obj
, "--sdn_port_mapping")
3099 vim
["vim-username"] = user
3100 vim
["vim-password"] = password
3101 vim
["vim-url"] = auth_url
3102 vim
["vim-tenant-name"] = tenant
3103 vim
["vim-type"] = account_type
3104 vim
["description"] = description
3105 vim
["config"] = config
3108 if sdn_controller
or sdn_port_mapping
:
3109 ctx
.obj
.vim
.create(name
, vim
, sdn_controller
, sdn_port_mapping
, wait
=wait
)
3111 ctx
.obj
.vim
.create(name
, vim
, wait
=wait
)
3112 # except ClientException as e:
3117 @cli_osm.command(name
="vim-update", short_help
="updates a VIM account")
3118 @click.argument("name")
3119 @click.option("--newname", help="New name for the VIM account")
3120 @click.option("--user", help="VIM username")
3121 @click.option("--password", help="VIM password")
3122 @click.option("--auth_url", help="VIM url")
3123 @click.option("--tenant", help="VIM tenant name")
3124 @click.option("--config", help="VIM specific config parameters")
3125 @click.option("--account_type", help="VIM type")
3126 @click.option("--description", help="human readable description")
3130 help="Name or id of the SDN controller to be associated with this VIM"
3131 "account. Use empty string to disassociate",
3134 "--sdn_port_mapping",
3136 help="File describing the port mapping between compute nodes' ports and switch ports",
3143 help="do not return the control immediately, but keep it "
3144 "until the operation is completed, or timeout",
3162 """updates a VIM account
3164 NAME: name or ID of the VIM account
3168 check_client_version(ctx
.obj
, ctx
.command
.name
)
3171 vim
["name"] = newname
3173 vim
["vim_user"] = user
3175 vim
["vim_password"] = password
3177 vim
["vim_url"] = auth_url
3179 vim
["vim-tenant-name"] = tenant
3181 vim
["vim_type"] = account_type
3183 vim
["description"] = description
3185 vim
["config"] = config
3186 ctx
.obj
.vim
.update(name
, vim
, sdn_controller
, sdn_port_mapping
, wait
=wait
)
3187 # except ClientException as e:
3192 @cli_osm.command(name
="vim-delete", short_help
="deletes a VIM account")
3193 @click.argument("name")
3195 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3202 help="do not return the control immediately, but keep it "
3203 "until the operation is completed, or timeout",
3206 def vim_delete(ctx
, name
, force
, wait
):
3207 """deletes a VIM account
3209 NAME: name or ID of the VIM account to be deleted
3214 ctx
.obj
.vim
.delete(name
, wait
=wait
)
3216 check_client_version(ctx
.obj
, "--force")
3217 ctx
.obj
.vim
.delete(name
, force
, wait
=wait
)
3218 # except ClientException as e:
3223 @cli_osm.command(name
="vim-list", short_help
="list all VIM accounts")
3224 # @click.option('--ro_update/--no_ro_update',
3226 # help='update list from RO')
3231 help="restricts the list to the VIM accounts matching the filter",
3236 help="get more details of the NS (project, vim, deployment status, configuration status.",
3239 def vim_list(ctx
, filter, long):
3240 """list all VIM accounts"""
3243 filter = "&".join(filter)
3244 check_client_version(ctx
.obj
, "--filter")
3246 # check_client_version(ctx.obj, '--ro_update', 'v1')
3247 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
3248 if fullclassname
== "osmclient.sol005.client.Client":
3249 resp
= ctx
.obj
.vim
.list(filter)
3251 # resp = ctx.obj.vim.list(ro_update)
3253 table
= PrettyTable(
3254 ["vim name", "uuid", "project", "operational state", "error details"]
3256 project_list
= ctx
.obj
.project
.list()
3258 table
= PrettyTable(["vim name", "uuid", "operational state"])
3261 if "vim_password" in vim
:
3262 vim
["vim_password"] = "********"
3263 logger
.debug("VIM details: {}".format(yaml
.safe_dump(vim
)))
3264 vim_state
= vim
["_admin"].get("operationalState", "-")
3265 error_details
= "N/A"
3266 if vim_state
== "ERROR":
3267 error_details
= vim
["_admin"].get("detailed-status", "Not found")
3268 project_id
, project_name
= get_project(project_list
, vim
)
3269 # project_info = '{} ({})'.format(project_name, project_id)
3270 project_info
= project_name
3277 wrap_text(text
=error_details
, width
=80),
3282 [vim
["name"], vim
["uuid"], vim
["_admin"].get("operationalState", "-")]
3288 @cli_osm.command(name
="vim-show", short_help
="shows the details of a VIM account")
3289 @click.argument("name")
3293 help="restricts the information to the fields in the filter",
3296 def vim_show(ctx
, name
, filter):
3297 """shows the details of a VIM account
3299 NAME: name or ID of the VIM account
3303 resp
= ctx
.obj
.vim
.get(name
)
3304 if "vim_password" in resp
:
3305 resp
["vim_password"] = "********"
3306 # except ClientException as e:
3310 table
= PrettyTable(["key", "attribute"])
3311 for k
, v
in list(resp
.items()):
3312 if not filter or k
in filter:
3313 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
3318 ####################
3320 ####################
3323 @cli_osm.command(name
="wim-create", short_help
="creates a new WIM account")
3324 @click.option("--name", prompt
=True, help="Name for the WIM account")
3325 @click.option("--user", help="WIM username")
3326 @click.option("--password", help="WIM password")
3327 @click.option("--url", prompt
=True, help="WIM url")
3328 # @click.option('--tenant',
3329 # help='wIM tenant name')
3330 @click.option("--config", default
=None, help="WIM specific config parameters")
3331 @click.option("--wim_type", help="WIM type")
3332 @click.option("--description", default
=None, help="human readable description")
3334 "--wim_port_mapping",
3336 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
3337 "(WAN service endpoint id and info)",
3344 help="do not return the control immediately, but keep it "
3345 "until the operation is completed, or timeout",
3361 """creates a new WIM account"""
3364 check_client_version(ctx
.obj
, ctx
.command
.name
)
3365 # if sdn_controller:
3366 # check_client_version(ctx.obj, '--sdn_controller')
3367 # if sdn_port_mapping:
3368 # check_client_version(ctx.obj, '--sdn_port_mapping')
3373 wim
["password"] = password
3375 wim
["wim_url"] = url
3376 # if tenant: wim['tenant'] = tenant
3377 wim
["wim_type"] = wim_type
3379 wim
["description"] = description
3381 wim
["config"] = config
3382 ctx
.obj
.wim
.create(name
, wim
, wim_port_mapping
, wait
=wait
)
3383 # except ClientException as e:
3388 @cli_osm.command(name
="wim-update", short_help
="updates a WIM account")
3389 @click.argument("name")
3390 @click.option("--newname", help="New name for the WIM account")
3391 @click.option("--user", help="WIM username")
3392 @click.option("--password", help="WIM password")
3393 @click.option("--url", help="WIM url")
3394 @click.option("--config", help="WIM specific config parameters")
3395 @click.option("--wim_type", help="WIM type")
3396 @click.option("--description", help="human readable description")
3398 "--wim_port_mapping",
3400 help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
3401 "(WAN service endpoint id and info)",
3408 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3424 """updates a WIM account
3426 NAME: name or ID of the WIM account
3430 check_client_version(ctx
.obj
, ctx
.command
.name
)
3433 wim
["name"] = newname
3437 wim
["password"] = password
3440 # if tenant: wim['tenant'] = tenant
3442 wim
["wim_type"] = wim_type
3444 wim
["description"] = description
3446 wim
["config"] = config
3447 ctx
.obj
.wim
.update(name
, wim
, wim_port_mapping
, wait
=wait
)
3448 # except ClientException as e:
3453 @cli_osm.command(name
="wim-delete", short_help
="deletes a WIM account")
3454 @click.argument("name")
3456 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3463 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3466 def wim_delete(ctx
, name
, force
, wait
):
3467 """deletes a WIM account
3469 NAME: name or ID of the WIM account to be deleted
3473 check_client_version(ctx
.obj
, ctx
.command
.name
)
3474 ctx
.obj
.wim
.delete(name
, force
, wait
=wait
)
3475 # except ClientException as e:
3480 @cli_osm.command(name
="wim-list", short_help
="list all WIM accounts")
3485 help="restricts the list to the WIM accounts matching the filter",
3488 def wim_list(ctx
, filter):
3489 """list all WIM accounts"""
3492 check_client_version(ctx
.obj
, ctx
.command
.name
)
3494 filter = "&".join(filter)
3495 resp
= ctx
.obj
.wim
.list(filter)
3496 table
= PrettyTable(["wim name", "uuid"])
3498 table
.add_row([wim
["name"], wim
["uuid"]])
3501 # except ClientException as e:
3506 @cli_osm.command(name
="wim-show", short_help
="shows the details of a WIM account")
3507 @click.argument("name")
3509 def wim_show(ctx
, name
):
3510 """shows the details of a WIM account
3512 NAME: name or ID of the WIM account
3516 check_client_version(ctx
.obj
, ctx
.command
.name
)
3517 resp
= ctx
.obj
.wim
.get(name
)
3518 if "password" in resp
:
3519 resp
["wim_password"] = "********"
3520 # except ClientException as e:
3524 table
= PrettyTable(["key", "attribute"])
3525 for k
, v
in list(resp
.items()):
3526 table
.add_row([k
, json
.dumps(v
, indent
=2)])
3531 ####################
3532 # SDN controller operations
3533 ####################
3536 @cli_osm.command(name
="sdnc-create", short_help
="creates a new SDN controller")
3537 @click.option("--name", prompt
=True, help="Name to create sdn controller")
3538 @click.option("--type", prompt
=True, help="SDN controller type")
3540 "--sdn_controller_version", # hidden=True,
3541 help="Deprecated. Use --config {version: sdn_controller_version}",
3543 @click.option("--url", help="URL in format http[s]://HOST:IP/")
3544 @click.option("--ip_address", help="Deprecated. Use --url") # hidden=True,
3545 @click.option("--port", help="Deprecated. Use --url") # hidden=True,
3547 "--switch_dpid", help="Deprecated. Use --config {switch_id: DPID}" # hidden=True,
3551 help="Extra information for SDN in yaml format, as {switch_id: identity used for the plugin (e.g. DPID: "
3552 "Openflow Datapath ID), version: version}",
3554 @click.option("--user", help="SDN controller username")
3558 confirmation_prompt
=True,
3559 help="SDN controller password",
3561 @click.option("--description", default
=None, help="human readable description")
3567 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3570 def sdnc_create(ctx
, **kwargs
):
3571 """creates a new SDN controller"""
3576 if kwargs
[x
] and x
not in ("wait", "ip_address", "port", "switch_dpid")
3578 if kwargs
.get("port"):
3579 print("option '--port' is deprecated, use '--url' instead")
3580 sdncontroller
["port"] = int(kwargs
["port"])
3581 if kwargs
.get("ip_address"):
3582 print("option '--ip_address' is deprecated, use '--url' instead")
3583 sdncontroller
["ip"] = kwargs
["ip_address"]
3584 if kwargs
.get("switch_dpid"):
3586 "option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead"
3588 sdncontroller
["dpid"] = kwargs
["switch_dpid"]
3589 if kwargs
.get("sdn_controller_version"):
3591 "option '--sdn_controller_version' is deprecated, use '--config={version: SDN_CONTROLLER_VERSION}'"
3595 check_client_version(ctx
.obj
, ctx
.command
.name
)
3596 ctx
.obj
.sdnc
.create(kwargs
["name"], sdncontroller
, wait
=kwargs
["wait"])
3597 # except ClientException as e:
3602 @cli_osm.command(name
="sdnc-update", short_help
="updates an SDN controller")
3603 @click.argument("name")
3604 @click.option("--newname", help="New name for the SDN controller")
3605 @click.option("--description", default
=None, help="human readable description")
3606 @click.option("--type", help="SDN controller type")
3607 @click.option("--url", help="URL in format http[s]://HOST:IP/")
3610 help="Extra information for SDN in yaml format, as "
3611 "{switch_id: identity used for the plugin (e.g. DPID: "
3612 "Openflow Datapath ID), version: version}",
3614 @click.option("--user", help="SDN controller username")
3615 @click.option("--password", help="SDN controller password")
3616 @click.option("--ip_address", help="Deprecated. Use --url") # hidden=True
3617 @click.option("--port", help="Deprecated. Use --url") # hidden=True
3619 "--switch_dpid", help="Deprecated. Use --config {switch_dpid: DPID}"
3622 "--sdn_controller_version", help="Deprecated. Use --config {version: VERSION}"
3629 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3632 def sdnc_update(ctx
, **kwargs
):
3633 """updates an SDN controller
3635 NAME: name or ID of the SDN controller
3642 and x
not in ("wait", "ip_address", "port", "switch_dpid", "new_name")
3644 if kwargs
.get("newname"):
3645 sdncontroller
["name"] = kwargs
["newname"]
3646 if kwargs
.get("port"):
3647 print("option '--port' is deprecated, use '--url' instead")
3648 sdncontroller
["port"] = int(kwargs
["port"])
3649 if kwargs
.get("ip_address"):
3650 print("option '--ip_address' is deprecated, use '--url' instead")
3651 sdncontroller
["ip"] = kwargs
["ip_address"]
3652 if kwargs
.get("switch_dpid"):
3654 "option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead"
3656 sdncontroller
["dpid"] = kwargs
["switch_dpid"]
3657 if kwargs
.get("sdn_controller_version"):
3659 "option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'"
3664 check_client_version(ctx
.obj
, ctx
.command
.name
)
3665 ctx
.obj
.sdnc
.update(kwargs
["name"], sdncontroller
, wait
=kwargs
["wait"])
3666 # except ClientException as e:
3671 @cli_osm.command(name
="sdnc-delete", short_help
="deletes an SDN controller")
3672 @click.argument("name")
3674 "--force", is_flag
=True, help="forces the deletion bypassing pre-conditions"
3681 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
3684 def sdnc_delete(ctx
, name
, force
, wait
):
3685 """deletes an SDN controller
3687 NAME: name or ID of the SDN controller to be deleted
3691 check_client_version(ctx
.obj
, ctx
.command
.name
)
3692 ctx
.obj
.sdnc
.delete(name
, force
, wait
=wait
)
3693 # except ClientException as e:
3698 @cli_osm.command(name
="sdnc-list", short_help
="list all SDN controllers")
3703 help="restricts the list to the SDN controllers matching the filter with format: 'k[.k..]=v[&k[.k]=v2]'",
3706 def sdnc_list(ctx
, filter):
3707 """list all SDN controllers"""
3710 check_client_version(ctx
.obj
, ctx
.command
.name
)
3712 filter = "&".join(filter)
3713 resp
= ctx
.obj
.sdnc
.list(filter)
3714 # except ClientException as e:
3717 table
= PrettyTable(["sdnc name", "id"])
3719 table
.add_row([sdnc
["name"], sdnc
["_id"]])
3724 @cli_osm.command(name
="sdnc-show", short_help
="shows the details of an SDN controller")
3725 @click.argument("name")
3727 def sdnc_show(ctx
, name
):
3728 """shows the details of an SDN controller
3730 NAME: name or ID of the SDN controller
3734 check_client_version(ctx
.obj
, ctx
.command
.name
)
3735 resp
= ctx
.obj
.sdnc
.get(name
)
3736 # except ClientException as e:
3740 table
= PrettyTable(["key", "attribute"])
3741 for k
, v
in list(resp
.items()):
3742 table
.add_row([k
, json
.dumps(v
, indent
=2)])
3747 ###########################
3748 # K8s cluster operations
3749 ###########################
3752 @cli_osm.command(name
="k8scluster-add", short_help
="adds a K8s cluster to OSM")
3753 @click.argument("name")
3755 "--creds", prompt
=True, help="credentials file, i.e. a valid `.kube/config` file"
3757 @click.option("--version", prompt
=True, help="Kubernetes version")
3759 "--vim", prompt
=True, help="VIM target, the VIM where the cluster resides"
3764 help='''list of VIM networks, in JSON inline format, where the cluster is
3765 accessible via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"''',
3767 @click.option("--description", default
=None, help="human readable description")
3770 default
="kube-system",
3771 help="namespace to be used for its operation, defaults to `kube-system`",
3776 help="list of CNI plugins, in JSON inline format, used in the cluster",
3778 # @click.option('--skip-init',
3780 # help='If set, K8s cluster is assumed to be ready for its use with OSM')
3781 # @click.option('--wait',
3783 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
3786 ctx
, name
, creds
, version
, vim
, k8s_nets
, description
, namespace
, cni
3788 """adds a K8s cluster to OSM
3790 NAME: name of the K8s cluster
3793 check_client_version(ctx
.obj
, ctx
.command
.name
)
3795 cluster
["name"] = name
3796 with
open(creds
, "r") as cf
:
3797 cluster
["credentials"] = yaml
.safe_load(cf
.read())
3798 cluster
["k8s_version"] = version
3799 cluster
["vim_account"] = vim
3800 cluster
["nets"] = yaml
.safe_load(k8s_nets
)
3802 cluster
["description"] = description
3804 cluster
["namespace"] = namespace
3806 cluster
["cni"] = yaml
.safe_load(cni
)
3807 ctx
.obj
.k8scluster
.create(name
, cluster
)
3808 # except ClientException as e:
3813 @cli_osm.command(name
="k8scluster-update", short_help
="updates a K8s cluster")
3814 @click.argument("name")
3815 @click.option("--newname", help="New name for the K8s cluster")
3816 @click.option("--creds", help="credentials file, i.e. a valid `.kube/config` file")
3817 @click.option("--version", help="Kubernetes version")
3818 @click.option("--vim", help="VIM target, the VIM where the cluster resides")
3821 help='''list of VIM networks, in JSON inline format, where the cluster is accessible
3822 via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"''',
3824 @click.option("--description", help="human readable description")
3827 help="namespace to be used for its operation, defaults to `kube-system`",
3830 "--cni", help="list of CNI plugins, in JSON inline format, used in the cluster"
3833 def k8scluster_update(
3834 ctx
, name
, newname
, creds
, version
, vim
, k8s_nets
, description
, namespace
, cni
3836 """updates a K8s cluster
3838 NAME: name or ID of the K8s cluster
3841 check_client_version(ctx
.obj
, ctx
.command
.name
)
3844 cluster
["name"] = newname
3846 with
open(creds
, "r") as cf
:
3847 cluster
["credentials"] = yaml
.safe_load(cf
.read())
3849 cluster
["k8s_version"] = version
3851 cluster
["vim_account"] = vim
3853 cluster
["nets"] = yaml
.safe_load(k8s_nets
)
3855 cluster
["description"] = description
3857 cluster
["namespace"] = namespace
3859 cluster
["cni"] = yaml
.safe_load(cni
)
3860 ctx
.obj
.k8scluster
.update(name
, cluster
)
3861 # except ClientException as e:
3866 @cli_osm.command(name
="k8scluster-delete", short_help
="deletes a K8s cluster")
3867 @click.argument("name")
3869 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
3871 # @click.option('--wait',
3873 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
3875 def k8scluster_delete(ctx
, name
, force
):
3876 """deletes a K8s cluster
3878 NAME: name or ID of the K8s cluster to be deleted
3881 check_client_version(ctx
.obj
, ctx
.command
.name
)
3882 ctx
.obj
.k8scluster
.delete(name
, force
=force
)
3883 # except ClientException as e:
3888 @cli_osm.command(name
="k8scluster-list")
3893 help="restricts the list to the K8s clusters matching the filter",
3895 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
3896 @click.option("--long", is_flag
=True, help="get more details")
3898 def k8scluster_list(ctx
, filter, literal
, long):
3899 """list all K8s clusters"""
3901 check_client_version(ctx
.obj
, ctx
.command
.name
)
3903 filter = "&".join(filter)
3904 resp
= ctx
.obj
.k8scluster
.list(filter)
3906 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
3909 table
= PrettyTable(
3917 "Operational State",
3918 "Op. state (details)",
3923 project_list
= ctx
.obj
.project
.list()
3925 table
= PrettyTable(
3926 ["Name", "Id", "VIM", "Operational State", "Op. state details"]
3929 vim_list
= ctx
.obj
.vim
.list()
3932 for cluster
in resp
:
3933 logger
.debug("Cluster details: {}".format(yaml
.safe_dump(cluster
)))
3934 vim_name
= get_vim_name(vim_list
, cluster
["vim_account"])
3935 # vim_info = '{} ({})'.format(vim_name,cluster['vim_account'])
3937 op_state_details
= "Helm: {}\nJuju: {}".format(
3938 cluster
["_admin"].get("helm-chart", {}).get("operationalState", "-"),
3939 cluster
["_admin"].get("juju-bundle", {}).get("operationalState", "-"),
3942 project_id
, project_name
= get_project(project_list
, cluster
)
3943 # project_info = '{} ({})'.format(project_name, project_id)
3944 project_info
= project_name
3945 detailed_status
= cluster
["_admin"].get("detailed-status", "-")
3951 cluster
["k8s_version"],
3953 json
.dumps(cluster
["nets"]),
3954 cluster
["_admin"]["operationalState"],
3956 trunc_text(cluster
.get("description") or "", 40),
3957 wrap_text(text
=detailed_status
, width
=40),
3966 cluster
["_admin"]["operationalState"],
3972 # except ClientException as e:
3978 name
="k8scluster-show", short_help
="shows the details of a K8s cluster"
3980 @click.argument("name")
3981 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
3983 def k8scluster_show(ctx
, name
, literal
):
3984 """shows the details of a K8s cluster
3986 NAME: name or ID of the K8s cluster
3989 resp
= ctx
.obj
.k8scluster
.get(name
)
3991 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
3993 table
= PrettyTable(["key", "attribute"])
3994 for k
, v
in list(resp
.items()):
3995 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
3998 # except ClientException as e:
4003 ###########################
4005 ###########################
4008 @cli_osm.command(name
="vca-add", short_help
="adds a VCA (Juju controller) to OSM")
4009 @click.argument("name")
4013 help="Comma-separated list of IP or hostnames of the Juju controller",
4015 @click.option("--user", prompt
=True, help="Username with admin priviledges")
4016 @click.option("--secret", prompt
=True, help="Password of the specified username")
4017 @click.option("--cacert", prompt
=True, help="CA certificate")
4021 help="Name of the cloud that will be used for LXD containers (LXD proxy charms)",
4024 "--lxd-credentials",
4026 help="Name of the cloud credentialsto be used for the LXD cloud",
4031 help="Name of the cloud that will be used for K8s containers (K8s proxy charms)",
4034 "--k8s-credentials",
4036 help="Name of the cloud credentialsto be used for the K8s cloud",
4041 help="Configuration options for the models",
4043 @click.option("--description", default
=None, help="human readable description")
4059 """adds a VCA to OSM
4061 NAME: name of the VCA
4063 check_client_version(ctx
.obj
, ctx
.command
.name
)
4066 vca
["endpoints"] = endpoints
.split(",")
4068 vca
["secret"] = secret
4069 vca
["cacert"] = cacert
4070 vca
["lxd-cloud"] = lxd_cloud
4071 vca
["lxd-credentials"] = lxd_credentials
4072 vca
["k8s-cloud"] = k8s_cloud
4073 vca
["k8s-credentials"] = k8s_credentials
4075 vca
["description"] = description
4077 model_config
= load(model_config
)
4078 vca
["model-config"] = model_config
4079 ctx
.obj
.vca
.create(name
, vca
)
4082 def load(data
: Any
):
4083 if os
.path
.isfile(data
):
4084 return load_file(data
)
4087 return json
.loads(data
)
4088 except ValueError as e
:
4089 raise ClientException(e
)
4092 def load_file(file_path
: str) -> Dict
:
4094 with
open(file_path
, "r") as f
:
4097 return yaml
.safe_load(content
)
4098 except yaml
.scanner
.ScannerError
:
4101 return json
.loads(content
)
4104 raise ClientException(f
"{file_path} must be a valid yaml or json file")
4107 @cli_osm.command(name
="vca-update", short_help
="updates a K8s cluster")
4108 @click.argument("name")
4110 "--endpoints", help="Comma-separated list of IP or hostnames of the Juju controller"
4112 @click.option("--user", help="Username with admin priviledges")
4113 @click.option("--secret", help="Password of the specified username")
4114 @click.option("--cacert", help="CA certificate")
4117 help="Name of the cloud that will be used for LXD containers (LXD proxy charms)",
4120 "--lxd-credentials",
4121 help="Name of the cloud credentialsto be used for the LXD cloud",
4125 help="Name of the cloud that will be used for K8s containers (K8s proxy charms)",
4128 "--k8s-credentials",
4129 help="Name of the cloud credentialsto be used for the K8s cloud",
4133 help="Configuration options for the models",
4135 @click.option("--description", default
=None, help="human readable description")
4151 """updates a K8s cluster
4153 NAME: name or ID of the K8s cluster
4155 check_client_version(ctx
.obj
, ctx
.command
.name
)
4159 vca
["endpoints"] = endpoints
.split(",")
4163 vca
["secret"] = secret
4165 vca
["cacert"] = cacert
4167 vca
["lxd-cloud"] = lxd_cloud
4169 vca
["lxd-credentials"] = lxd_credentials
4171 vca
["k8s-cloud"] = k8s_cloud
4173 vca
["k8s-credentials"] = k8s_credentials
4175 vca
["description"] = description
4177 model_config
= load(model_config
)
4178 vca
["model-config"] = model_config
4179 ctx
.obj
.vca
.update(name
, vca
)
4182 @cli_osm.command(name
="vca-delete", short_help
="deletes a K8s cluster")
4183 @click.argument("name")
4185 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
4188 def vca_delete(ctx
, name
, force
):
4189 """deletes a K8s cluster
4191 NAME: name or ID of the K8s cluster to be deleted
4193 check_client_version(ctx
.obj
, ctx
.command
.name
)
4194 ctx
.obj
.vca
.delete(name
, force
=force
)
4197 @cli_osm.command(name
="vca-list")
4202 help="restricts the list to the VCAs matching the filter",
4204 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4205 @click.option("--long", is_flag
=True, help="get more details")
4207 def vca_list(ctx
, filter, literal
, long):
4209 check_client_version(ctx
.obj
, ctx
.command
.name
)
4211 filter = "&".join(filter)
4212 resp
= ctx
.obj
.vca
.list(filter)
4214 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4217 table
= PrettyTable(
4218 ["Name", "Id", "Project", "Operational State", "Detailed Status"]
4220 project_list
= ctx
.obj
.project
.list()
4222 table
= PrettyTable(["Name", "Id", "Operational State"])
4224 logger
.debug("VCA details: {}".format(yaml
.safe_dump(vca
)))
4226 project_id
, project_name
= get_project(project_list
, vca
)
4227 detailed_status
= vca
.get("_admin", {}).get("detailed-status", "-")
4233 vca
.get("_admin", {}).get("operationalState", "-"),
4234 wrap_text(text
=detailed_status
, width
=40),
4242 vca
.get("_admin", {}).get("operationalState", "-"),
4249 @cli_osm.command(name
="vca-show", short_help
="shows the details of a K8s cluster")
4250 @click.argument("name")
4251 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4253 def vca_show(ctx
, name
, literal
):
4254 """shows the details of a K8s cluster
4256 NAME: name or ID of the K8s cluster
4259 resp
= ctx
.obj
.vca
.get(name
)
4261 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4263 table
= PrettyTable(["key", "attribute"])
4264 for k
, v
in list(resp
.items()):
4265 table
.add_row([k
, wrap_text(text
=json
.dumps(v
, indent
=2), width
=100)])
4270 ###########################
4272 ###########################
4275 @cli_osm.command(name
="repo-add", short_help
="adds a repo to OSM")
4276 @click.argument("name")
4277 @click.argument("uri")
4280 type=click
.Choice(["helm-chart", "juju-bundle", "osm"]),
4282 help="type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles, osm for OSM Repositories)",
4284 @click.option("--description", default
=None, help="human readable description")
4286 "--user", default
=None, help="OSM repository: The username of the OSM repository"
4291 help="OSM repository: The password of the OSM repository",
4293 # @click.option('--wait',
4295 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4297 def repo_add(ctx
, **kwargs
):
4298 """adds a repo to OSM
4300 NAME: name of the repo
4301 URI: URI of the repo
4304 kwargs
= {k
: v
for k
, v
in kwargs
.items() if v
is not None}
4306 repo
["url"] = repo
.pop("uri")
4307 if repo
["type"] in ["helm-chart", "juju-bundle"]:
4308 ctx
.obj
.repo
.create(repo
["name"], repo
)
4310 ctx
.obj
.osmrepo
.create(repo
["name"], repo
)
4311 # except ClientException as e:
4316 @cli_osm.command(name
="repo-update", short_help
="updates a repo in OSM")
4317 @click.argument("name")
4318 @click.option("--newname", help="New name for the repo")
4319 @click.option("--uri", help="URI of the repo")
4320 @click.option("--description", help="human readable description")
4321 # @click.option('--wait',
4323 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4325 def repo_update(ctx
, name
, newname
, uri
, description
):
4326 """updates a repo in OSM
4328 NAME: name of the repo
4331 check_client_version(ctx
.obj
, ctx
.command
.name
)
4334 repo
["name"] = newname
4338 repo
["description"] = description
4340 ctx
.obj
.repo
.update(name
, repo
)
4342 ctx
.obj
.osmrepo
.update(name
, repo
)
4344 # except ClientException as e:
4350 name
="repo-index", short_help
="Index a repository from a folder with artifacts"
4353 "--origin", default
=".", help="origin path where the artifacts are located"
4356 "--destination", default
=".", help="destination path where the index is deployed"
4359 def repo_index(ctx
, origin
, destination
):
4360 """Index a repository
4362 NAME: name or ID of the repo to be deleted
4364 check_client_version(ctx
.obj
, ctx
.command
.name
)
4365 ctx
.obj
.osmrepo
.repo_index(origin
, destination
)
4368 @cli_osm.command(name
="repo-delete", short_help
="deletes a repo")
4369 @click.argument("name")
4371 "--force", is_flag
=True, help="forces the deletion from the DB (not recommended)"
4373 # @click.option('--wait',
4375 # help='do not return the control immediately, but keep it until the operation is completed, or timeout')
4377 def repo_delete(ctx
, name
, force
):
4380 NAME: name or ID of the repo to be deleted
4384 ctx
.obj
.repo
.delete(name
, force
=force
)
4386 ctx
.obj
.osmrepo
.delete(name
, force
=force
)
4387 # except ClientException as e:
4392 @cli_osm.command(name
="repo-list")
4397 help="restricts the list to the repos matching the filter",
4399 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4401 def repo_list(ctx
, filter, literal
):
4402 """list all repos"""
4405 check_client_version(ctx
.obj
, ctx
.command
.name
)
4407 filter = "&".join(filter)
4408 resp
= ctx
.obj
.repo
.list(filter)
4409 resp
+= ctx
.obj
.osmrepo
.list(filter)
4411 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4413 table
= PrettyTable(["Name", "Id", "Type", "URI", "Description"])
4415 # cluster['k8s-nets'] = json.dumps(yaml.safe_load(cluster['k8s-nets']))
4422 trunc_text(repo
.get("description") or "", 40),
4428 # except ClientException as e:
4433 @cli_osm.command(name
="repo-show", short_help
="shows the details of a repo")
4434 @click.argument("name")
4435 @click.option("--literal", is_flag
=True, help="print literally, no pretty table")
4437 def repo_show(ctx
, name
, literal
):
4438 """shows the details of a repo
4440 NAME: name or ID of the repo
4443 resp
= ctx
.obj
.repo
.get(name
)
4445 resp
= ctx
.obj
.osmrepo
.get(name
)
4449 print(yaml
.safe_dump(resp
, indent
=4, default_flow_style
=False))
4451 table
= PrettyTable(["key", "attribute"])
4453 for k
, v
in list(resp
.items()):
4454 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4458 # except ClientException as e:
4463 ####################
4464 # Project mgmt operations
4465 ####################
4468 @cli_osm.command(name
="project-create", short_help
="creates a new project")
4469 @click.argument("name")
4470 # @click.option('--description',
4471 # default='no description',
4472 # help='human readable description')
4473 @click.option("--domain-name", "domain_name", default
=None, help="assign to a domain")
4479 help="provide quotas. Can be used several times: 'quota1=number[,quota2=number,...]'. Quotas can be one "
4480 "of vnfds, nsds, nsts, pdus, nsrs, nsis, vim_accounts, wim_accounts, sdns, k8sclusters, k8srepos",
4483 def project_create(ctx
, name
, domain_name
, quotas
):
4484 """Creates a new project
4486 NAME: name of the project
4487 DOMAIN_NAME: optional domain name for the project when keystone authentication is used
4488 QUOTAS: set quotas for the project
4491 project
= {"name": name
}
4493 project
["domain_name"] = domain_name
4494 quotas_dict
= _process_project_quotas(quotas
)
4496 project
["quotas"] = quotas_dict
4499 check_client_version(ctx
.obj
, ctx
.command
.name
)
4500 ctx
.obj
.project
.create(name
, project
)
4501 # except ClientException as e:
4506 def _process_project_quotas(quota_list
):
4511 for quota
in quota_list
:
4512 for single_quota
in quota
.split(","):
4513 k
, v
= single_quota
.split("=")
4514 quotas_dict
[k
] = None if v
in ("None", "null", "") else int(v
)
4515 except (ValueError, TypeError):
4516 raise ClientException(
4517 "invalid format for 'quotas'. Use 'k1=v1,v1=v2'. v must be a integer or null"
4522 @cli_osm.command(name
="project-delete", short_help
="deletes a project")
4523 @click.argument("name")
4524 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
4526 def project_delete(ctx
, name
):
4527 """deletes a project
4529 NAME: name or ID of the project to be deleted
4533 check_client_version(ctx
.obj
, ctx
.command
.name
)
4534 ctx
.obj
.project
.delete(name
)
4535 # except ClientException as e:
4540 @cli_osm.command(name
="project-list", short_help
="list all projects")
4545 help="restricts the list to the projects matching the filter",
4548 def project_list(ctx
, filter):
4549 """list all projects"""
4552 check_client_version(ctx
.obj
, ctx
.command
.name
)
4554 filter = "&".join(filter)
4555 resp
= ctx
.obj
.project
.list(filter)
4556 # except ClientException as e:
4559 table
= PrettyTable(["name", "id"])
4561 table
.add_row([proj
["name"], proj
["_id"]])
4566 @cli_osm.command(name
="project-show", short_help
="shows the details of a project")
4567 @click.argument("name")
4569 def project_show(ctx
, name
):
4570 """shows the details of a project
4572 NAME: name or ID of the project
4576 check_client_version(ctx
.obj
, ctx
.command
.name
)
4577 resp
= ctx
.obj
.project
.get(name
)
4578 # except ClientException as e:
4582 table
= PrettyTable(["key", "attribute"])
4583 for k
, v
in resp
.items():
4584 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4590 name
="project-update", short_help
="updates a project (only the name can be updated)"
4592 @click.argument("project")
4593 @click.option("--name", default
=None, help="new name for the project")
4599 help="change quotas. Can be used several times: 'quota1=number|empty[,quota2=...]' "
4600 "(use empty to reset quota to default",
4603 def project_update(ctx
, project
, name
, quotas
):
4605 Update a project name
4608 :param project: id or name of the project to modify
4609 :param name: new name for the project
4610 :param quotas: change quotas of the project
4614 project_changes
= {}
4616 project_changes
["name"] = name
4617 quotas_dict
= _process_project_quotas(quotas
)
4619 project_changes
["quotas"] = quotas_dict
4622 check_client_version(ctx
.obj
, ctx
.command
.name
)
4623 ctx
.obj
.project
.update(project
, project_changes
)
4624 # except ClientException as e:
4628 ####################
4629 # User mgmt operations
4630 ####################
4633 @cli_osm.command(name
="user-create", short_help
="creates a new user")
4634 @click.argument("username")
4639 confirmation_prompt
=True,
4640 help="user password",
4644 # prompt="Comma separate list of projects",
4646 callback
=lambda ctx
, param
, value
: "".join(value
).split(",")
4647 if all(len(x
) == 1 for x
in value
)
4649 help="list of project ids that the user belongs to",
4652 "--project-role-mappings",
4653 "project_role_mappings",
4656 help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4658 @click.option("--domain-name", "domain_name", default
=None, help="assign to a domain")
4660 def user_create(ctx
, username
, password
, projects
, project_role_mappings
, domain_name
):
4661 """Creates a new user
4664 USERNAME: name of the user
4665 PASSWORD: password of the user
4666 PROJECTS: projects assigned to user (internal only)
4667 PROJECT_ROLE_MAPPING: roles in projects assigned to user (keystone)
4668 DOMAIN_NAME: optional domain name for the user when keystone authentication is used
4672 user
["username"] = username
4673 user
["password"] = password
4674 user
["projects"] = projects
4675 user
["project_role_mappings"] = project_role_mappings
4677 user
["domain_name"] = domain_name
4680 check_client_version(ctx
.obj
, ctx
.command
.name
)
4681 ctx
.obj
.user
.create(username
, user
)
4682 # except ClientException as e:
4687 @cli_osm.command(name
="user-update", short_help
="updates user information")
4688 @click.argument("username")
4693 # confirmation_prompt=True,
4694 help="user password",
4696 @click.option("--set-username", "set_username", default
=None, help="change username")
4702 help="create/replace the roles for this project: 'project,role1[,role2,...]'",
4709 help="removes project from user: 'project'",
4712 "--add-project-role",
4716 help="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4719 "--remove-project-role",
4720 "remove_project_role",
4723 help="remove role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
4734 remove_project_role
,
4736 """Update a user information
4739 USERNAME: name of the user
4740 PASSWORD: new password
4741 SET_USERNAME: new username
4742 SET_PROJECT: creating mappings for project/role(s)
4743 REMOVE_PROJECT: deleting mappings for project/role(s)
4744 ADD_PROJECT_ROLE: adding mappings for project/role(s)
4745 REMOVE_PROJECT_ROLE: removing mappings for project/role(s)
4749 user
["password"] = password
4750 user
["username"] = set_username
4751 user
["set-project"] = set_project
4752 user
["remove-project"] = remove_project
4753 user
["add-project-role"] = add_project_role
4754 user
["remove-project-role"] = remove_project_role
4757 check_client_version(ctx
.obj
, ctx
.command
.name
)
4758 ctx
.obj
.user
.update(username
, user
)
4759 # except ClientException as e:
4764 @cli_osm.command(name
="user-delete", short_help
="deletes a user")
4765 @click.argument("name")
4766 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
4768 def user_delete(ctx
, name
):
4772 NAME: name or ID of the user to be deleted
4776 check_client_version(ctx
.obj
, ctx
.command
.name
)
4777 ctx
.obj
.user
.delete(name
)
4778 # except ClientException as e:
4783 @cli_osm.command(name
="user-list", short_help
="list all users")
4788 help="restricts the list to the users matching the filter",
4791 def user_list(ctx
, filter):
4792 """list all users"""
4794 check_client_version(ctx
.obj
, ctx
.command
.name
)
4796 filter = "&".join(filter)
4797 resp
= ctx
.obj
.user
.list(filter)
4798 # except ClientException as e:
4801 table
= PrettyTable(["name", "id"])
4803 table
.add_row([user
["username"], user
["_id"]])
4808 @cli_osm.command(name
="user-show", short_help
="shows the details of a user")
4809 @click.argument("name")
4811 def user_show(ctx
, name
):
4812 """shows the details of a user
4814 NAME: name or ID of the user
4818 check_client_version(ctx
.obj
, ctx
.command
.name
)
4819 resp
= ctx
.obj
.user
.get(name
)
4820 if "password" in resp
:
4821 resp
["password"] = "********"
4822 # except ClientException as e:
4826 table
= PrettyTable(["key", "attribute"])
4827 for k
, v
in resp
.items():
4828 table
.add_row([k
, json
.dumps(v
, indent
=2)])
4833 ####################
4834 # Fault Management operations
4835 ####################
4838 @cli_osm.command(name
="ns-alarm-create")
4839 @click.argument("name")
4840 @click.option("--ns", prompt
=True, help="NS instance id or name")
4842 "--vnf", prompt
=True, help="VNF name (VNF member index as declared in the NSD)"
4844 @click.option("--vdu", prompt
=True, help="VDU name (VDU name as declared in the VNFD)")
4845 @click.option("--metric", prompt
=True, help="Name of the metric (e.g. cpu_utilization)")
4849 help="severity of the alarm (WARNING, MINOR, MAJOR, CRITICAL, INDETERMINATE)",
4852 "--threshold_value",
4854 help="threshold value that, when crossed, an alarm is triggered",
4857 "--threshold_operator",
4859 help="threshold operator describing the comparison (GE, LE, GT, LT, EQ)",
4864 help="statistic (AVERAGE, MINIMUM, MAXIMUM, COUNT, SUM)",
4867 def ns_alarm_create(
4879 """creates a new alarm for a NS instance"""
4880 # TODO: Check how to validate threshold_value.
4881 # Should it be an integer (1-100), percentage, or decimal (0.01-1.00)?
4884 ns_instance
= ctx
.obj
.ns
.get(ns
)
4886 alarm
["alarm_name"] = name
4887 alarm
["ns_id"] = ns_instance
["_id"]
4888 alarm
["correlation_id"] = ns_instance
["_id"]
4889 alarm
["vnf_member_index"] = vnf
4890 alarm
["vdu_name"] = vdu
4891 alarm
["metric_name"] = metric
4892 alarm
["severity"] = severity
4893 alarm
["threshold_value"] = int(threshold_value
)
4894 alarm
["operation"] = threshold_operator
4895 alarm
["statistic"] = statistic
4896 check_client_version(ctx
.obj
, ctx
.command
.name
)
4897 ctx
.obj
.ns
.create_alarm(alarm
)
4898 # except ClientException as e:
4903 # @cli_osm.command(name='ns-alarm-delete')
4904 # @click.argument('name')
4905 # @click.pass_context
4906 # def ns_alarm_delete(ctx, name):
4907 # """deletes an alarm
4909 # NAME: name of the alarm to be deleted
4912 # check_client_version(ctx.obj, ctx.command.name)
4913 # ctx.obj.ns.delete_alarm(name)
4914 # except ClientException as e:
4919 ####################
4920 # Performance Management operations
4921 ####################
4925 name
="ns-metric-export",
4926 short_help
="exports a metric to the internal OSM bus, which can be read by other apps",
4928 @click.option("--ns", prompt
=True, help="NS instance id or name")
4930 "--vnf", prompt
=True, help="VNF name (VNF member index as declared in the NSD)"
4932 @click.option("--vdu", prompt
=True, help="VDU name (VDU name as declared in the VNFD)")
4933 @click.option("--metric", prompt
=True, help="name of the metric (e.g. cpu_utilization)")
4934 # @click.option('--period', default='1w',
4935 # help='metric collection period (e.g. 20s, 30m, 2h, 3d, 1w)')
4937 "--interval", help="periodic interval (seconds) to export metrics continuously"
4940 def ns_metric_export(ctx
, ns
, vnf
, vdu
, metric
, interval
):
4941 """exports a metric to the internal OSM bus, which can be read by other apps"""
4942 # TODO: Check how to validate interval.
4943 # Should it be an integer (seconds), or should a suffix (s,m,h,d,w) also be permitted?
4946 ns_instance
= ctx
.obj
.ns
.get(ns
)
4948 metric_data
["ns_id"] = ns_instance
["_id"]
4949 metric_data
["correlation_id"] = ns_instance
["_id"]
4950 metric_data
["vnf_member_index"] = vnf
4951 metric_data
["vdu_name"] = vdu
4952 metric_data
["metric_name"] = metric
4953 metric_data
["collection_unit"] = "WEEK"
4954 metric_data
["collection_period"] = 1
4955 check_client_version(ctx
.obj
, ctx
.command
.name
)
4957 print("{}".format(ctx
.obj
.ns
.export_metric(metric_data
)))
4961 print("{} {}".format(ctx
.obj
.ns
.export_metric(metric_data
), i
))
4962 time
.sleep(int(interval
))
4964 # except ClientException as e:
4969 ####################
4971 ####################
4974 @cli_osm.command(name
="version", short_help
="shows client and server versions")
4976 def get_version(ctx
):
4977 """shows client and server versions"""
4979 check_client_version(ctx
.obj
, "version")
4980 print("Server version: {}".format(ctx
.obj
.get_version()))
4982 "Client version: {}".format(pkg_resources
.get_distribution("osmclient").version
)
4984 # except ClientException as e:
4990 name
="upload-package", short_help
="uploads a VNF package or NS package"
4992 @click.argument("filename")
4994 "--skip-charm-build",
4997 help="the charm will not be compiled, it is assumed to already exist",
5000 def upload_package(ctx
, filename
, skip_charm_build
):
5001 """uploads a vnf package or ns package
5003 filename: vnf or ns package folder, or vnf or ns package file (tar.gz)
5007 ctx
.obj
.package
.upload(filename
, skip_charm_build
=skip_charm_build
)
5008 fullclassname
= ctx
.obj
.__module
__ + "." + ctx
.obj
.__class
__.__name
__
5009 if fullclassname
!= "osmclient.sol005.client.Client":
5010 ctx
.obj
.package
.wait_for_upload(filename
)
5011 # except ClientException as e:
5016 # @cli_osm.command(name='ns-scaling-show')
5017 # @click.argument('ns_name')
5018 # @click.pass_context
5019 # def show_ns_scaling(ctx, ns_name):
5020 # """shows the status of a NS scaling operation
5022 # NS_NAME: name of the NS instance being scaled
5025 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5026 # resp = ctx.obj.ns.list()
5027 # except ClientException as e:
5031 # table = PrettyTable(
5034 # 'operational status',
5039 # if ns_name == ns['name']:
5040 # nsopdata = ctx.obj.ns.get_opdata(ns['id'])
5041 # scaling_records = nsopdata['nsr:nsr']['scaling-group-record']
5042 # for record in scaling_records:
5043 # if 'instance' in record:
5044 # instances = record['instance']
5045 # for inst in instances:
5047 # [record['scaling-group-name-ref'],
5048 # inst['instance-id'],
5049 # inst['op-status'],
5050 # time.strftime('%Y-%m-%d %H:%M:%S',
5052 # inst['create-time'])),
5058 # @cli_osm.command(name='ns-scale')
5059 # @click.argument('ns_name')
5060 # @click.option('--ns_scale_group', prompt=True)
5061 # @click.option('--index', prompt=True)
5062 # @click.option('--wait',
5066 # help='do not return the control immediately, but keep it \
5067 # until the operation is completed, or timeout')
5068 # @click.pass_context
5069 # def ns_scale(ctx, ns_name, ns_scale_group, index, wait):
5072 # NS_NAME: name of the NS instance to be scaled
5075 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5076 # ctx.obj.ns.scale(ns_name, ns_scale_group, index, wait=wait)
5077 # except ClientException as e:
5082 # @cli_osm.command(name='config-agent-list')
5083 # @click.pass_context
5084 # def config_agent_list(ctx):
5085 # """list config agents"""
5087 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5088 # except ClientException as e:
5091 # table = PrettyTable(['name', 'account-type', 'details'])
5092 # for account in ctx.obj.vca.list():
5095 # account['account-type'],
5101 # @cli_osm.command(name='config-agent-delete')
5102 # @click.argument('name')
5103 # @click.pass_context
5104 # def config_agent_delete(ctx, name):
5105 # """deletes a config agent
5107 # NAME: name of the config agent to be deleted
5110 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5111 # ctx.obj.vca.delete(name)
5112 # except ClientException as e:
5117 # @cli_osm.command(name='config-agent-add')
5118 # @click.option('--name',
5120 # @click.option('--account_type',
5122 # @click.option('--server',
5124 # @click.option('--user',
5126 # @click.option('--secret',
5129 # confirmation_prompt=True)
5130 # @click.pass_context
5131 # def config_agent_add(ctx, name, account_type, server, user, secret):
5132 # """adds a config agent"""
5134 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5135 # ctx.obj.vca.create(name, account_type, server, user, secret)
5136 # except ClientException as e:
5141 # @cli_osm.command(name='ro-dump')
5142 # @click.pass_context
5144 # """shows RO agent information"""
5145 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5146 # resp = ctx.obj.vim.get_resource_orchestrator()
5147 # table = PrettyTable(['key', 'attribute'])
5148 # for k, v in list(resp.items()):
5149 # table.add_row([k, json.dumps(v, indent=2)])
5154 # @cli_osm.command(name='vcs-list')
5155 # @click.pass_context
5156 # def vcs_list(ctx):
5157 # check_client_version(ctx.obj, ctx.command.name, 'v1')
5158 # resp = ctx.obj.utils.get_vcs_info()
5159 # table = PrettyTable(['component name', 'state'])
5160 # for component in resp:
5161 # table.add_row([component['component_name'], component['state']])
5167 name
="ns-action", short_help
="executes an action/primitive over a NS instance"
5169 @click.argument("ns_name")
5173 help="member-vnf-index if the target is a vnf instead of a ns)",
5175 @click.option("--kdu_name", default
=None, help="kdu-name if the target is a kdu)")
5176 @click.option("--vdu_id", default
=None, help="vdu-id if the target is a vdu")
5178 "--vdu_count", default
=None, type=int, help="number of vdu instance of this vdu_id"
5180 @click.option("--action_name", prompt
=True, help="action name")
5181 @click.option("--params", default
=None, help="action params in YAML/JSON inline string")
5182 @click.option("--params_file", default
=None, help="YAML/JSON file with action params")
5184 "--timeout", required
=False, default
=None, type=int, help="timeout in seconds"
5191 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5207 """executes an action/primitive over a NS instance
5209 NS_NAME: name or ID of the NS instance
5213 check_client_version(ctx
.obj
, ctx
.command
.name
)
5216 op_data
["member_vnf_index"] = vnf_name
5218 op_data
["kdu_name"] = kdu_name
5220 op_data
["vdu_id"] = vdu_id
5221 if vdu_count
is not None:
5222 op_data
["vdu_count_index"] = vdu_count
5224 op_data
["timeout_ns_action"] = timeout
5225 op_data
["primitive"] = action_name
5227 with
open(params_file
, "r") as pf
:
5230 op_data
["primitive_params"] = yaml
.safe_load(params
)
5232 op_data
["primitive_params"] = {}
5233 print(ctx
.obj
.ns
.exec_op(ns_name
, op_name
="action", op_data
=op_data
, wait
=wait
))
5235 # except ClientException as e:
5241 name
="vnf-scale", short_help
="executes a VNF scale (adding/removing VDUs)"
5243 @click.argument("ns_name")
5244 @click.argument("vnf_name")
5246 "--scaling-group", prompt
=True, help="scaling-group-descriptor name to use"
5249 "--scale-in", default
=False, is_flag
=True, help="performs a scale in operation"
5255 help="performs a scale out operation (by default)",
5258 "--timeout", required
=False, default
=None, type=int, help="timeout in seconds"
5265 help="do not return the control immediately, but keep it until the operation is completed, or timeout",
5269 ctx
, ns_name
, vnf_name
, scaling_group
, scale_in
, scale_out
, timeout
, wait
5272 Executes a VNF scale (adding/removing VDUs)
5275 NS_NAME: name or ID of the NS instance.
5276 VNF_NAME: member-vnf-index in the NS to be scaled.
5280 check_client_version(ctx
.obj
, ctx
.command
.name
)
5281 if not scale_in
and not scale_out
:
5283 ctx
.obj
.ns
.scale_vnf(
5284 ns_name
, vnf_name
, scaling_group
, scale_in
, scale_out
, wait
, timeout
5286 # except ClientException as e:
5291 @cli_osm.command(name
="alarm-show", short_help
="show alarm details")
5292 @click.argument("uuid")
5294 def alarm_show(ctx
, uuid
):
5295 """Show alarm's detail information"""
5297 check_client_version(ctx
.obj
, ctx
.command
.name
)
5298 resp
= ctx
.obj
.ns
.get_alarm(uuid
=uuid
)
5312 table
= PrettyTable(["key", "attribute"])
5314 # Arrange and return the response data
5315 resp
= resp
.replace("ObjectId", "")
5317 for key
in alarm_filter
:
5319 value
= alarm
.get(key
)
5322 value
= alarm
.get(key
)
5324 elif key
== "ns-id":
5325 value
= alarm
["tags"].get("ns_id")
5326 elif key
== "vdu_name":
5327 value
= alarm
["tags"].get("vdu_name")
5328 elif key
== "status":
5329 value
= alarm
["alarm_status"]
5332 table
.add_row([key
, wrap_text(text
=json
.dumps(value
, indent
=2), width
=100)])
5340 @cli_osm.command(name
="alarm-list", short_help
="list all alarms")
5342 "--ns_id", default
=None, required
=False, help="List out alarm for given ns id"
5345 def alarm_list(ctx
, ns_id
):
5346 """list all alarm"""
5348 check_client_version(ctx
.obj
, ctx
.command
.name
)
5349 project_name
= os
.getenv("OSM_PROJECT", "admin")
5350 resp
= ctx
.obj
.ns
.get_alarm(project_name
=project_name
, ns_id
=ns_id
)
5352 table
= PrettyTable(
5353 ["alarm-id", "metric", "threshold", "operation", "action", "status"]
5356 # return the response data in a table
5357 resp
= resp
.replace("ObjectId", "")
5362 wrap_text(text
=str(alarm
["uuid"]), width
=38),
5366 wrap_text(text
=alarm
["action"], width
=25),
5367 alarm
["alarm_status"],
5375 @cli_osm.command(name
="alarm-update", short_help
="Update a alarm")
5376 @click.argument("uuid")
5377 @click.option("--threshold", default
=None, help="Alarm threshold")
5378 @click.option("--is_enable", default
=None, type=bool, help="enable or disable alarm")
5380 def alarm_update(ctx
, uuid
, threshold
, is_enable
):
5385 if not threshold
and is_enable
is None:
5386 raise ClientException(
5387 "Please provide option to update i.e threshold or is_enable"
5389 ctx
.obj
.ns
.update_alarm(uuid
, threshold
, is_enable
)
5392 ##############################
5393 # Role Management Operations #
5394 ##############################
5397 @cli_osm.command(name
="role-create", short_help
="creates a new role")
5398 @click.argument("name")
5399 @click.option("--permissions", default
=None, help="role permissions using a dictionary")
5401 def role_create(ctx
, name
, permissions
):
5406 NAME: Name or ID of the role.
5407 DEFINITION: Definition of grant/denial of access to resources.
5411 check_client_version(ctx
.obj
, ctx
.command
.name
)
5412 ctx
.obj
.role
.create(name
, permissions
)
5413 # except ClientException as e:
5418 @cli_osm.command(name
="role-update", short_help
="updates a role")
5419 @click.argument("name")
5420 @click.option("--set-name", default
=None, help="change name of rle")
5421 # @click.option('--permissions',
5423 # help='provide a yaml format dictionary with incremental changes. Values can be bool or None to delete')
5427 help="yaml format dictionary with permission: True/False to access grant/denial",
5429 @click.option("--remove", default
=None, help="yaml format list to remove a permission")
5431 def role_update(ctx
, name
, set_name
, add
, remove
):
5436 NAME: Name or ID of the role.
5437 DEFINITION: Definition overwrites the old definition.
5438 ADD: Grant/denial of access to resource to add.
5439 REMOVE: Grant/denial of access to resource to remove.
5443 check_client_version(ctx
.obj
, ctx
.command
.name
)
5444 ctx
.obj
.role
.update(name
, set_name
, None, add
, remove
)
5445 # except ClientException as e:
5450 @cli_osm.command(name
="role-delete", short_help
="deletes a role")
5451 @click.argument("name")
5452 # @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
5454 def role_delete(ctx
, name
):
5459 NAME: Name or ID of the role.
5463 check_client_version(ctx
.obj
, ctx
.command
.name
)
5464 ctx
.obj
.role
.delete(name
)
5465 # except ClientException as e:
5470 @cli_osm.command(name
="role-list", short_help
="list all roles")
5475 help="restricts the list to the projects matching the filter",
5478 def role_list(ctx
, filter):
5484 check_client_version(ctx
.obj
, ctx
.command
.name
)
5486 filter = "&".join(filter)
5487 resp
= ctx
.obj
.role
.list(filter)
5488 # except ClientException as e:
5491 table
= PrettyTable(["name", "id"])
5493 table
.add_row([role
["name"], role
["_id"]])
5498 @cli_osm.command(name
="role-show", short_help
="show specific role")
5499 @click.argument("name")
5501 def role_show(ctx
, name
):
5503 Shows the details of a role.
5506 NAME: Name or ID of the role.
5510 check_client_version(ctx
.obj
, ctx
.command
.name
)
5511 resp
= ctx
.obj
.role
.get(name
)
5512 # except ClientException as e:
5516 table
= PrettyTable(["key", "attribute"])
5517 for k
, v
in resp
.items():
5518 table
.add_row([k
, json
.dumps(v
, indent
=2)])
5523 @cli_osm.command(name
="package-create", short_help
="Create empty NS package structure")
5524 @click.argument("package-type")
5525 @click.argument("package-name")
5529 help=('(NS/VNF/NST) Set the location for package creation. Default: "."'),
5533 default
="image-name",
5534 help='(VNF) Set the name of the vdu image. Default "image-name"',
5537 "--vdus", default
=1, help="(VNF) Set the number of vdus in a VNF. Default 1"
5540 "--vcpu", default
=1, help="(VNF) Set the number of virtual CPUs in a vdu. Default 1"
5545 help="(VNF) Set the memory size (MB) of the vdu. Default 1024",
5548 "--storage", default
=10, help="(VNF) Set the disk size (GB) of the vdu. Default 10"
5553 help="(VNF) Set the number of additional interfaces apart from the management interface. Default 0",
5556 "--vendor", default
="OSM", help='(NS/VNF) Set the descriptor vendor. Default "OSM"'
5562 help="(NS/VNF/NST) Flag for overriding the package if exists.",
5568 help="(NS/VNF/NST) Flag for generating descriptor .yaml with all possible commented options",
5571 "--netslice-subnets", default
=1, help="(NST) Number of netslice subnets. Default 1"
5574 "--netslice-vlds", default
=1, help="(NST) Number of netslice vlds. Default 1"
5595 Creates an OSM NS, VNF, NST package
5598 PACKAGE_TYPE: Package to be created: NS, VNF or NST.
5599 PACKAGE_NAME: Name of the package to create the folder with the content.
5604 check_client_version(ctx
.obj
, ctx
.command
.name
)
5606 "Creating the {} structure: {}/{}".format(
5607 package_type
.upper(), base_directory
, package_name
5610 resp
= ctx
.obj
.package_tool
.create(
5620 interfaces
=interfaces
,
5623 netslice_subnets
=netslice_subnets
,
5624 netslice_vlds
=netslice_vlds
,
5627 # except ClientException as inst:
5628 # print("ERROR: {}".format(inst))
5633 name
="package-validate", short_help
="Validate descriptors given a base directory"
5635 @click.argument("base-directory", default
=".", required
=False)
5637 "--recursive/--no-recursive",
5639 help="The activated recursive option will validate the yaml files"
5640 " within the indicated directory and in its subdirectories",
5646 help="Validates also the descriptors using the previous OSM format (pre SOL006)",
5649 def package_validate(ctx
, base_directory
, recursive
, old
):
5651 Validate descriptors given a base directory.
5654 BASE_DIRECTORY: Base folder for NS, VNF or NST package.
5658 check_client_version(ctx
.obj
, ctx
.command
.name
)
5659 results
= ctx
.obj
.package_tool
.validate(base_directory
, recursive
, old
)
5660 table
= PrettyTable()
5661 table
.field_names
= ["TYPE", "PATH", "VALID", "ERROR"]
5662 # Print the dictionary generated by the validation function
5663 for result
in results
:
5665 [result
["type"], result
["path"], result
["valid"], result
["error"]]
5667 table
.sortby
= "VALID"
5668 table
.align
["PATH"] = "l"
5669 table
.align
["TYPE"] = "l"
5670 table
.align
["ERROR"] = "l"
5672 # except ClientException as inst:
5673 # print("ERROR: {}".format(inst))
5678 name
="package-translate", short_help
="Translate descriptors given a base directory"
5680 @click.argument("base-directory", default
=".", required
=False)
5682 "--recursive/--no-recursive",
5684 help="The activated recursive option will translate the yaml files"
5685 " within the indicated directory and in its subdirectories",
5691 help="Do not translate yet, only make a dry-run to test translation",
5694 def package_translate(ctx
, base_directory
, recursive
, dryrun
):
5696 Translate descriptors given a base directory.
5699 BASE_DIRECTORY: Stub folder for NS, VNF or NST package.
5702 check_client_version(ctx
.obj
, ctx
.command
.name
)
5703 results
= ctx
.obj
.package_tool
.translate(base_directory
, recursive
, dryrun
)
5704 table
= PrettyTable()
5705 table
.field_names
= [
5713 # Print the dictionary generated by the validation function
5714 for result
in results
:
5717 result
["current type"],
5721 result
["translated"],
5725 table
.sortby
= "TRANSLATED"
5726 table
.align
["PATH"] = "l"
5727 table
.align
["TYPE"] = "l"
5728 table
.align
["ERROR"] = "l"
5730 # except ClientException as inst:
5731 # print("ERROR: {}".format(inst))
5735 @cli_osm.command(name
="package-build", short_help
="Build the tar.gz of the package")
5736 @click.argument("package-folder")
5738 "--skip-validation", default
=False, is_flag
=True, help="skip package validation"
5741 "--skip-charm-build",
5744 help="the charm will not be compiled, it is assumed to already exist",
5747 def package_build(ctx
, package_folder
, skip_validation
, skip_charm_build
):
5749 Build the package NS, VNF given the package_folder.
5752 PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged
5756 check_client_version(ctx
.obj
, ctx
.command
.name
)
5757 results
= ctx
.obj
.package_tool
.build(
5759 skip_validation
=skip_validation
,
5760 skip_charm_build
=skip_charm_build
,
5763 # except ClientException as inst:
5764 # print("ERROR: {}".format(inst))
5769 name
="descriptor-translate",
5770 short_help
="Translate input descriptor file from Rel EIGHT OSM descriptors to SOL006 and prints in standard output",
5772 @click.argument("descriptor-file", required
=True)
5774 def descriptor_translate(ctx
, descriptor_file
):
5776 Translate input descriptor.
5779 DESCRIPTOR_FILE: Descriptor file for NS, VNF or Network Slice.
5782 check_client_version(ctx
.obj
, ctx
.command
.name
)
5783 result
= ctx
.obj
.package_tool
.descriptor_translate(descriptor_file
)
5791 except pycurl
.error
as exc
:
5794 'Maybe "--hostname" option or OSM_HOSTNAME environment variable needs to be specified'
5796 except ClientException
as exc
:
5797 print("ERROR: {}".format(exc
))
5798 except (FileNotFoundError
, PermissionError
) as exc
:
5799 print("Cannot open file: {}".format(exc
))
5800 except yaml
.YAMLError
as exc
:
5801 print("Invalid YAML format: {}".format(exc
))
5803 # TODO capture other controlled exceptions here
5804 # TODO remove the ClientException captures from all places, unless they do something different
5807 if __name__
== "__main__":