Merge branch 'master' into v7.0
Change-Id: I0b8da73514a19adcfe8fd9e5d1a2e1b24f40a6f8
Signed-off-by: garciadeblas <gerardo.garciadeblas@telefonica.com>
diff --git a/Dockerfile b/Dockerfile
index e40b8bc..ef0175a 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -11,9 +11,9 @@
# License for the specific language governing permissions and limitations
# under the License.
#
-FROM ubuntu:16.04
+FROM ubuntu:18.04
-RUN apt-get update && apt-get -y install git make python python3 \
- libcurl4-gnutls-dev libgnutls-dev tox python-dev python3-dev \
- debhelper python-setuptools python3-setuptools python-all python3-all \
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get -y install git \
+ make python3 python3-pip libcurl4-openssl-dev libssl-dev tox python3-dev \
+ debhelper python3-setuptools python3-all python-all python-pip \
apt-utils
diff --git a/README.md b/README.md
index bc1f89c..1791594 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,71 @@
+<!--
+Copyright 2020 ETSI
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.
+See the License for the specific language governing permissions and
+limitations under the License
+-->
# python-osmclient
-A python client for osm orchestration
-A test commit
+OSM client library and console script
-# Installation
+## Installation
-## python-osmclient
-### Install dependencies
+### From git-repo
+
```bash
-sudo apt-get install python-dev libcurl4-gnutls-dev python-pip libgnutls-dev python-prettytable
-sudo pip install pycurl
+# Ubuntu 18.04 pre-requirements
+sudo apt-get install python3-pip libcurl4-openssl-dev libssl-dev
+# CentOS pre-requirements
+# sudo yum install python3-pip libcurl-devel gnutls-devel
+sudo -H python3 -m pip install python-magic
+# Install OSM Information model
+sudo -H python3 -m pip install git+https://osm.etsi.org/gerrit/osm/IM --upgrade
+# Install OSM client from the git repo.
+# You can install the latest client from master branch in this way:
+sudo -H python3 -m pip install git+https://osm.etsi.org/gerrit/osm/osmclient
+# You could also install a specific tag/version in this way
+# sudo -H python3 -m pip install git+https://osm.etsi.org/gerrit/osm/osmclient@v7.0.0rc1
```
-### Install python-osmclient
- sudo pip install git+https://github.com/mfmarche/python-osmclient
+### From cloned repo (for developers)
-
-## Snap
-```bash
-apt install snapd
-snap install osmclient --channel=beta
+```
+# Ubuntu 18.04 pre-requirements
+sudo apt-get install python3-pip libcurl4-openssl-dev libssl-dev
+# Centos pre-requirements
+# sudo yum install python3-pip libcurl-devel gnutls-devel
+sudo -H python3 -m pip install python-magic
+# Install OSM Information model
+sudo -H python3 -m pip install git+https://osm.etsi.org/gerrit/osm/IM --upgrade
+# Clone the osmclient repo and install OSM client from the git repo.
+git clone https://osm.etsi.org/gerrit/osm/osmclient
+cd osmclient
+python3 -m pip install --user -e .
+# logout and login so that PATH can be updated. Executable osm will be found in /home/ubuntu/.local/bin
```
-# Setup
-Set the OSM_HOSTNAME variable to the host of the osm server.
+## Setup
-Example
+Set the OSM_HOSTNAME variable to the host of the OSM server (default: localhost).
+
```bash
-localhost$ export OSM_HOSTNAME=<hostname>:8008
+localhost$ export OSM_HOSTNAME=<hostname>
```
-# Examples
+## Examples
-## upload vnfd
+### upload vnfd
+
```bash
localhost$ osm upload-package ubuntu_xenial_vnf.tar.gz
{'transaction_id': 'ec12af77-1b91-4c84-b233-60f2c2c16d14'}
@@ -44,7 +77,8 @@
+--------------------+--------------------+
```
-## upload nsd
+### upload nsd
+
```bash
localhost$ osm upload-package ubuntu_xenial_ns.tar.gz
{'transaction_id': 'b560c9cb-43e1-49ef-a2da-af7aab24ce9d'}
@@ -55,7 +89,8 @@
| ubuntu_xenial_nsd | ubuntu_xenial_nsd |
+-------------------+-------------------+
```
-## vim-list
+
+### vim-list
```bash
localhost$ osm vim-list
@@ -66,8 +101,8 @@
+-------------+-----------------+--------------------------------------+
```
+### instantiate ns
-## instantiate ns
```bash
localhost$ osm ns-create ubuntu_xenial_nsd testns openstack-site
{'success': ''}
@@ -79,7 +114,58 @@
+------------------+--------------------------------------+-------------------+--------------------+---------------+
```
-# Bash Completion
-python-osmclient uses [click](http://click.pocoo.org/5/). You can setup bash completion by putting this in your .bashrc:
+## Using osmclient as a library to interact with OSM
- eval "$(_OSM_COMPLETE=source osm)"
+Assuming that you have installed python-osmclient package, it's pretty simple to write some Python code to interact with OSM.
+
+### Simple Python code to get the list of NS packages
+
+```python
+from osmclient import client
+from osmclient.common.exceptions import ClientException
+hostname = "127.0.0.1"
+myclient = client.Client(host=hostname, sol005=True)
+resp = myclient.nsd.list()
+print yaml.safe_dump(resp)
+```
+
+### Simple Python code to get the list of VNF packages from a specific user and project
+
+The code will print for each package a pretty table, then the full details in yaml
+
+```python
+from osmclient import client
+from osmclient.common.exceptions import ClientException
+import yaml
+from prettytable import PrettyTable
+hostname = "127.0.0.1"
+user = admin
+password = admin
+project = admin
+kwargs = {}
+if user is not None:
+ kwargs['user']=user
+if password is not None:
+ kwargs['password']=password
+if project is not None:
+ kwargs['project']=project
+myclient = client.Client(host=hostname, sol005=True, **kwargs)
+resp = myclient.vnfd.list()
+print yaml.safe_dump(resp)
+```
+
+## Enable autocompletion
+
+You can enable autocompletion in OSM client by creating a file osm-complete.sh in the following way:
+
+```bash
+mkdir -p $HOME/.bash_completion.d
+_OSM_COMPLETE=source osm > $HOME/.bash_completion.d/osm-complete.sh
+```
+
+Then you can add the following to your $HOME/.bashrc file:
+
+```bash
+. .bash_completion.d/osm-complete.sh
+```
+
diff --git a/debian/py3dist-overrides b/debian/py3dist-overrides
new file mode 100644
index 0000000..e6059cd
--- /dev/null
+++ b/debian/py3dist-overrides
@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+python-magic
diff --git a/debian/python3-osmclient.postinst b/debian/python3-osmclient.postinst
new file mode 100644
index 0000000..75ec83f
--- /dev/null
+++ b/debian/python3-osmclient.postinst
@@ -0,0 +1,30 @@
+#!/bin/bash
+
+##
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+##
+
+echo "POST INSTALL OSMCLIENT"
+#Install pyangbind, required for python3-osm-im
+python3 -m pip install pyangbind verboselogs
+#configure autocomplete for osmclient
+[ -z "$SUDO_USER" ] && SUDO_USER="$USER"
+su $SUDO_USER -c 'mkdir -p $HOME/.bash_completion.d'
+su $SUDO_USER -c '_OSM_COMPLETE=source osm > $HOME/.bash_completion.d/osm-complete.sh'
+
+if ! su $SUDO_USER -c 'grep -q bash_completion.d/osm-complete.sh ${HOME}/.bashrc'
+then
+ echo " inserting .bash_completion.d/osm-complete.sh execution at .bashrc"
+ su $SUDO_USER -c 'echo ". ${HOME}/.bash_completion.d/osm-complete.sh" >> ${HOME}/.bashrc'
+fi
+
diff --git a/devops-stages/stage-build.sh b/devops-stages/stage-build.sh
index dd4af61..7b00243 100755
--- a/devops-stages/stage-build.sh
+++ b/devops-stages/stage-build.sh
@@ -13,5 +13,5 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-rm -rf deb_dist
+rm -rf deb_dist osmclient-*.tar.gz
tox -e build,build3
diff --git a/osmclient/client.py b/osmclient/client.py
index eccfee2..56570b4 100644
--- a/osmclient/client.py
+++ b/osmclient/client.py
@@ -21,9 +21,32 @@
from osmclient.v1 import client as client
from osmclient.sol005 import client as sol005client
+import logging
+import verboselogs
+verboselogs.install()
def Client(version=1, host=None, sol005=True, *args, **kwargs):
+ log_format_simple = "%(levelname)s %(message)s"
+ log_format_complete = "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(funcName)s(): %(message)s"
+ log_formatter_simple = logging.Formatter(log_format_simple, datefmt='%Y-%m-%dT%H:%M:%S')
+ handler = logging.StreamHandler()
+ handler.setFormatter(log_formatter_simple)
+ logger = logging.getLogger('osmclient')
+ logger.setLevel(level=logging.WARNING)
+ logger.addHandler(handler)
+ verbose = kwargs.get('verbose',0)
+ if verbose>0:
+ log_formatter = logging.Formatter(log_format_complete, datefmt='%Y-%m-%dT%H:%M:%S')
+ #handler = logging.StreamHandler()
+ handler.setFormatter(log_formatter)
+ #logger.addHandler(handler)
+ if verbose==1:
+ logger.setLevel(level=logging.INFO)
+ elif verbose==2:
+ logger.setLevel(level=logging.VERBOSE)
+ elif verbose>2:
+ logger.setLevel(level=logging.DEBUG)
if not sol005:
if version == 1:
return client.Client(host, *args, **kwargs)
diff --git a/osmclient/common/http.py b/osmclient/common/http.py
index 17f82e3..b67b594 100644
--- a/osmclient/common/http.py
+++ b/osmclient/common/http.py
@@ -50,9 +50,13 @@
curl_cmd = self._get_curl_cmd(endpoint)
curl_cmd.setopt(pycurl.HTTPGET, 1)
curl_cmd.setopt(pycurl.WRITEFUNCTION, data.write)
+ self._logger.info("Request METHOD: {} URL: {}".format("GET",self._url + endpoint))
curl_cmd.perform()
+ http_code = curl_cmd.getinfo(pycurl.HTTP_CODE)
+ self._logger.info("Response HTTPCODE: {}".format(http_code))
curl_cmd.close()
if data.getvalue():
+ self._logger.debug("Response DATA: {}".format(json.loads(data.getvalue().decode())))
return json.loads(data.getvalue().decode())
return None
@@ -61,9 +65,13 @@
curl_cmd = self._get_curl_cmd(endpoint)
curl_cmd.setopt(pycurl.CUSTOMREQUEST, "DELETE")
curl_cmd.setopt(pycurl.WRITEFUNCTION, data.write)
+ self._logger.info("Request METHOD: {} URL: {}".format("DELETE",self._url + endpoint))
curl_cmd.perform()
+ http_code = curl_cmd.getinfo(pycurl.HTTP_CODE)
+ self._logger.info("Response HTTPCODE: {}".format(http_code))
curl_cmd.close()
if data.getvalue():
+ self._logger.debug("Response DATA: {}".format(json.loads(data.getvalue().decode())))
return json.loads(data.getvalue().decode())
return None
@@ -84,8 +92,12 @@
(pycurl.FORM_FILE,
formfile[1])))])
+ self._logger.info("Request METHOD: {} URL: {}".format("POST",self._url + endpoint))
curl_cmd.perform()
+ http_code = curl_cmd.getinfo(pycurl.HTTP_CODE)
+ self._logger.info("Response HTTPCODE: {}".format(http_code))
curl_cmd.close()
if data.getvalue():
+ self._logger.debug("Response DATA: {}".format(json.loads(data.getvalue().decode())))
return json.loads(data.getvalue().decode())
return None
diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py
index 18b8033..af8cab9 100755
--- a/osmclient/scripts/osm.py
+++ b/osmclient/scripts/osm.py
@@ -29,8 +29,14 @@
import os
import textwrap
import pkg_resources
+import logging
+from datetime import datetime
+# Global variables
+
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'], max_content_width=160)
+
def wrap_text(text, width):
wrapper = textwrap.TextWrapper(width=width)
lines = text.splitlines()
@@ -53,6 +59,7 @@
:return: -
:raises ClientError: if the specified version does not match the client version
"""
+ logger.debug("")
fullclassname = obj.__module__ + "." + obj.__class__.__name__
message = 'The following commands or options are only supported with the option "--sol005": {}'.format(what)
if version == 'v1':
@@ -62,9 +69,7 @@
return
-CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'], max_content_width=160)
-
-@click.group(context_settings=CONTEXT_SETTINGS)
+@click.group(context_settings=dict(help_option_names=['-h', '--help'], max_content_width=160))
@click.option('--hostname',
default="127.0.0.1",
envvar='OSM_HOSTNAME',
@@ -90,6 +95,8 @@
envvar='OSM_PROJECT',
help='project (defaults to admin). ' +
'Also can set OSM_PROJECT in environment')
+@click.option('-v', '--verbose', count=True,
+ help='increase verbosity (-v INFO, -vv VERBOSE, -vvv DEBUG)')
#@click.option('--so-port',
# default=None,
# envvar='OSM_SO_PORT',
@@ -111,13 +118,14 @@
# help='hostname of RO server. ' +
# 'Also can set OSM_RO_PORT in environment')
@click.pass_context
-def cli(ctx, hostname, user, password, project):
+def cli_osm(ctx, hostname, user, password, project, verbose):
+ global logger
if hostname is None:
print((
"either hostname option or OSM_HOSTNAME " +
"environment variable needs to be specified"))
exit(1)
- kwargs={}
+ kwargs = {'verbose': verbose}
# if so_port is not None:
# kwargs['so_port']=so_port
# if so_project is not None:
@@ -133,19 +141,21 @@
kwargs['password']=password
if project is not None:
kwargs['project']=project
-
ctx.obj = client.Client(host=hostname, sol005=sol005, **kwargs)
+ logger = logging.getLogger('osmclient')
####################
# LIST operations
####################
-@cli.command(name='ns-list', short_help='list all NS instances')
+@cli_osm.command(name='ns-list', short_help='list all NS instances')
@click.option('--filter', default=None,
help='restricts the list to the NS instances matching the filter.')
+@click.option('--details', is_flag=True,
+ help='get more details of current operation in the NS.')
@click.pass_context
-def ns_list(ctx, filter):
+def ns_list(ctx, filter,details):
"""list all NS instances
\b
@@ -193,46 +203,155 @@
--filter nsd.vendor=<VENDOR>&nsd-ref=<NSD_NAME>
--filter nsd.constituent-vnfd.vnfd-id-ref=<VNFD_NAME>
"""
+ def summarize_deployment_status(status_dict):
+ #Nets
+ summary = ""
+ n_nets = 0
+ status_nets = {}
+ net_list = status_dict['nets']
+ for net in net_list:
+ n_nets += 1
+ if net['status'] not in status_nets:
+ status_nets[net['status']] = 1
+ else:
+ status_nets[net['status']] +=1
+ message = "Nets: "
+ for k,v in status_nets.items():
+ message += "{}:{},".format(k,v)
+ message += "TOTAL:{}".format(n_nets)
+ summary += "{}".format(message)
+ #VMs and VNFs
+ n_vms = 0
+ status_vms = {}
+ status_vnfs = {}
+ vnf_list = status_dict['vnfs']
+ for vnf in vnf_list:
+ member_vnf_index = vnf['member_vnf_index']
+ if member_vnf_index not in status_vnfs:
+ status_vnfs[member_vnf_index] = {}
+ for vm in vnf['vms']:
+ n_vms += 1
+ if vm['status'] not in status_vms:
+ status_vms[vm['status']] = 1
+ else:
+ status_vms[vm['status']] +=1
+ if vm['status'] not in status_vnfs[member_vnf_index]:
+ status_vnfs[member_vnf_index][vm['status']] = 1
+ else:
+ status_vnfs[member_vnf_index][vm['status']] += 1
+ message = "VMs: "
+ for k,v in status_vms.items():
+ message += "{}:{},".format(k,v)
+ message += "TOTAL:{}".format(n_vms)
+ summary += "\n{}".format(message)
+ summary += "\nNFs:"
+ for k,v in status_vnfs.items():
+ total = 0
+ message = "\n {} VMs: ".format(k)
+ for k2,v2 in v.items():
+ message += "{}:{},".format(k2,v2)
+ total += v2
+ message += "TOTAL:{}".format(total)
+ summary += message
+ return summary
+
+ def summarize_config_status(ee_list):
+ n_ee = 0
+ status_ee = {}
+ for ee in ee_list:
+ n_ee += 1
+ if ee['elementType'] not in status_ee:
+ status_ee[ee['elementType']] = {}
+ status_ee[ee['elementType']][ee['status']] = 1
+ continue;
+ if ee['status'] in status_ee[ee['elementType']]:
+ status_ee[ee['elementType']][ee['status']] += 1
+ else:
+ status_ee[ee['elementType']][ee['status']] = 1
+ summary = ""
+ for elementType in ["KDU", "VDU", "PDU", "VNF", "NS"]:
+ if elementType in status_ee:
+ message = ""
+ total = 0
+ for k,v in status_ee[elementType].items():
+ message += "{}:{},".format(k,v)
+ total += v
+ message += "TOTAL:{}\n".format(total)
+ summary += "{}: {}".format(elementType, message)
+ summary += "TOTAL Exec. Env.: {}".format(n_ee)
+ return summary
+ logger.debug("")
if filter:
check_client_version(ctx.obj, '--filter')
resp = ctx.obj.ns.list(filter)
else:
resp = ctx.obj.ns.list()
- table = PrettyTable(
+ if details:
+ table = PrettyTable(
['ns instance name',
'id',
- 'operational status',
- 'config status',
- 'detailed status'])
+ 'ns state',
+ 'current operation',
+ 'error details',
+ 'deployment status',
+ 'configuration status'])
+ else:
+ table = PrettyTable(
+ ['ns instance name',
+ 'id',
+ 'ns state',
+ 'current operation',
+ 'error details'])
for ns in resp:
fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
if fullclassname == 'osmclient.sol005.client.Client':
nsr = ns
nsr_name = nsr['name']
nsr_id = nsr['_id']
+ ns_state = nsr['nsState']
+ if details:
+ deployment_status = summarize_deployment_status(nsr['deploymentStatus'])
+ config_status = summarize_config_status(nsr['configurationStatus'])
+ current_operation = "{} ({})".format(nsr['currentOperation'],nsr['currentOperationID'])
+ error_details = "N/A"
+ if ns_state == "BROKEN" or ns_state == "DEGRADED":
+ error_details = "{}\nDetail: {}".format(nsr['errorDescription'],nsr['errorDetail'])
else:
nsopdata = ctx.obj.ns.get_opdata(ns['id'])
nsr = nsopdata['nsr:nsr']
nsr_name = nsr['name-ref']
nsr_id = nsr['ns-instance-config-ref']
- opstatus = nsr['operational-status'] if 'operational-status' in nsr else 'Not found'
- configstatus = nsr['config-status'] if 'config-status' in nsr else 'Not found'
- detailed_status = nsr['detailed-status'] if 'detailed-status' in nsr else 'Not found'
- detailed_status = wrap_text(text=detailed_status,width=50)
- if configstatus == "config_not_needed":
- configstatus = "configured (no charms)"
+ deployment_status = nsr['operational-status'] if 'operational-status' in nsr else 'Not found'
+ ns_state = deployment_status
+ config_status = nsr['config-status'] if 'config-status' in nsr else 'Not found'
+ current_operation = "Unknown"
+ error_details = nsr['detailed-status'] if 'detailed-status' in nsr else 'Not found'
+ if config_status == "config_not_needed":
+ config_status = "configured (no charms)"
- table.add_row(
- [nsr_name,
- nsr_id,
- opstatus,
- configstatus,
- detailed_status])
+ if details:
+ table.add_row(
+ [nsr_name,
+ nsr_id,
+ ns_state,
+ current_operation,
+ wrap_text(text=error_details,width=40),
+ deployment_status,
+ config_status])
+ else:
+ table.add_row(
+ [nsr_name,
+ nsr_id,
+ ns_state,
+ current_operation,
+ wrap_text(text=error_details,width=40)])
table.align = 'l'
print(table)
-
+ print('To get the history of all operations over a NS, run "osm ns-op-list NS_ID"')
+ print('For more details on the current operation, run "osm ns-op-show OPERATION_ID"')
def nsd_list(ctx, filter):
+ logger.debug("")
if filter:
check_client_version(ctx.obj, '--filter')
resp = ctx.obj.nsd.list(filter)
@@ -252,25 +371,28 @@
print(table)
-@cli.command(name='nsd-list', short_help='list all NS packages')
+@cli_osm.command(name='nsd-list', short_help='list all NS packages')
@click.option('--filter', default=None,
help='restricts the list to the NSD/NSpkg matching the filter')
@click.pass_context
def nsd_list1(ctx, filter):
"""list all NSD/NS pkg in the system"""
+ logger.debug("")
nsd_list(ctx, filter)
-@cli.command(name='nspkg-list', short_help='list all NS packages')
+@cli_osm.command(name='nspkg-list', short_help='list all NS packages')
@click.option('--filter', default=None,
help='restricts the list to the NSD/NSpkg matching the filter')
@click.pass_context
def nsd_list2(ctx, filter):
"""list all NS packages"""
+ logger.debug("")
nsd_list(ctx, filter)
def vnfd_list(ctx, nf_type, filter):
+ logger.debug("")
if nf_type:
check_client_version(ctx.obj, '--nf_type')
elif filter:
@@ -306,54 +428,57 @@
print(table)
-@cli.command(name='vnfd-list', short_help='list all xNF packages (VNF, HNF, PNF)')
+@cli_osm.command(name='vnfd-list', short_help='list all xNF packages (VNF, HNF, PNF)')
@click.option('--nf_type', help='type of NF (vnf, pnf, hnf)')
@click.option('--filter', default=None,
help='restricts the list to the NF pkg matching the filter')
@click.pass_context
def vnfd_list1(ctx, nf_type, filter):
"""list all xNF packages (VNF, HNF, PNF)"""
+ logger.debug("")
vnfd_list(ctx, nf_type, filter)
-@cli.command(name='vnfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)')
+@cli_osm.command(name='vnfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)')
@click.option('--nf_type', help='type of NF (vnf, pnf, hnf)')
@click.option('--filter', default=None,
help='restricts the list to the NFpkg matching the filter')
@click.pass_context
def vnfd_list2(ctx, nf_type, filter):
"""list all xNF packages (VNF, HNF, PNF)"""
+ logger.debug("")
vnfd_list(ctx, nf_type, filter)
-@cli.command(name='nfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)')
+@cli_osm.command(name='nfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)')
@click.option('--nf_type', help='type of NF (vnf, pnf, hnf)')
@click.option('--filter', default=None,
help='restricts the list to the NFpkg matching the filter')
@click.pass_context
def nfpkg_list(ctx, nf_type, filter):
"""list all xNF packages (VNF, HNF, PNF)"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- vnfd_list(ctx, nf_type, filter)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ vnfd_list(ctx, nf_type, filter)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
def vnf_list(ctx, ns, filter):
- try:
- if ns or filter:
- if ns:
- check_client_version(ctx.obj, '--ns')
- if filter:
- check_client_version(ctx.obj, '--filter')
- resp = ctx.obj.vnf.list(ns, filter)
- else:
- resp = ctx.obj.vnf.list()
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ if ns or filter:
+ if ns:
+ check_client_version(ctx.obj, '--ns')
+ if filter:
+ check_client_version(ctx.obj, '--filter')
+ resp = ctx.obj.vnf.list(ns, filter)
+ else:
+ resp = ctx.obj.vnf.list()
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
if fullclassname == 'osmclient.sol005.client.Client':
table = PrettyTable(
@@ -393,17 +518,18 @@
print(table)
-@cli.command(name='vnf-list', short_help='list all NF instances')
+@cli_osm.command(name='vnf-list', short_help='list all NF instances')
@click.option('--ns', default=None, help='NS instance id or name to restrict the NF list')
@click.option('--filter', default=None,
help='restricts the list to the NF instances matching the filter.')
@click.pass_context
def vnf_list1(ctx, ns, filter):
"""list all NF instances"""
+ logger.debug("")
vnf_list(ctx, ns, filter)
-@cli.command(name='nf-list', short_help='list all NF instances')
+@cli_osm.command(name='nf-list', short_help='list all NF instances')
@click.option('--ns', default=None, help='NS instance id or name to restrict the NF list')
@click.option('--filter', default=None,
help='restricts the list to the NF instances matching the filter.')
@@ -456,10 +582,11 @@
--filter vdur.ip-address=<IP_ADDRESS>
--filter vnfd-ref=<VNFD_NAME>,vdur.ip-address=<IP_ADDRESS>
"""
+ logger.debug("")
vnf_list(ctx, ns, filter)
-@cli.command(name='ns-op-list', short_help='shows the history of operations over a NS instance')
+@cli_osm.command(name='ns-op-list', short_help='shows the history of operations over a NS instance')
@click.argument('name')
@click.pass_context
def ns_op_list(ctx, name):
@@ -467,33 +594,60 @@
NAME: name or ID of the NS instance
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.ns.list_op(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ def formatParams(params):
+ if params['lcmOperationType']=='instantiate':
+ params.pop('nsDescription')
+ params.pop('nsName')
+ params.pop('nsdId')
+ params.pop('nsr_id')
+ elif params['lcmOperationType']=='action':
+ params.pop('primitive')
+ params.pop('lcmOperationType')
+ params.pop('nsInstanceId')
+ return params
- table = PrettyTable(['id', 'operation', 'action_name', 'status'])
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.ns.list_op(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+ table = PrettyTable(['id', 'operation', 'action_name', 'operation_params', 'status', 'detail'])
#print(yaml.safe_dump(resp))
for op in resp:
action_name = "N/A"
if op['lcmOperationType']=='action':
action_name = op['operationParams']['primitive']
- table.add_row([op['id'], op['lcmOperationType'], action_name,
- op['operationState']])
+ detail = "-"
+ if op['operationState']=='PROCESSING':
+ if op['lcmOperationType']=='instantiate':
+ if op['stage']:
+ detail = op['stage']
+ else:
+ detail = "In queue. Current position: {}".format(op['queuePosition'])
+ elif op['operationState']=='FAILED' or op['operationState']=='FAILED_TEMP':
+ detail = op['errorMessage']
+ table.add_row([op['id'],
+ op['lcmOperationType'],
+ action_name,
+ wrap_text(text=json.dumps(formatParams(op['operationParams']),indent=2),width=70),
+ op['operationState'],
+ wrap_text(text=detail,width=50)])
table.align = 'l'
print(table)
def nsi_list(ctx, filter):
"""list all Network Slice Instances"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.nsi.list(filter)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.nsi.list(filter)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(
['netslice instance name',
'id',
@@ -518,31 +672,34 @@
print(table)
-@cli.command(name='nsi-list', short_help='list all Network Slice Instances (NSI)')
+@cli_osm.command(name='nsi-list', short_help='list all Network Slice Instances (NSI)')
@click.option('--filter', default=None,
help='restricts the list to the Network Slice Instances matching the filter')
@click.pass_context
def nsi_list1(ctx, filter):
"""list all Network Slice Instances (NSI)"""
+ logger.debug("")
nsi_list(ctx, filter)
-@cli.command(name='netslice-instance-list', short_help='list all Network Slice Instances (NSI)')
+@cli_osm.command(name='netslice-instance-list', short_help='list all Network Slice Instances (NSI)')
@click.option('--filter', default=None,
help='restricts the list to the Network Slice Instances matching the filter')
@click.pass_context
def nsi_list2(ctx, filter):
"""list all Network Slice Instances (NSI)"""
+ logger.debug("")
nsi_list(ctx, filter)
def nst_list(ctx, filter):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.nst.list(filter)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.nst.list(filter)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
# print(yaml.safe_dump(resp))
table = PrettyTable(['nst name', 'id'])
for nst in resp:
@@ -552,31 +709,34 @@
print(table)
-@cli.command(name='nst-list', short_help='list all Network Slice Templates (NST)')
+@cli_osm.command(name='nst-list', short_help='list all Network Slice Templates (NST)')
@click.option('--filter', default=None,
help='restricts the list to the NST matching the filter')
@click.pass_context
def nst_list1(ctx, filter):
"""list all Network Slice Templates (NST) in the system"""
+ logger.debug("")
nst_list(ctx, filter)
-@cli.command(name='netslice-template-list', short_help='list all Network Slice Templates (NST)')
+@cli_osm.command(name='netslice-template-list', short_help='list all Network Slice Templates (NST)')
@click.option('--filter', default=None,
help='restricts the list to the NST matching the filter')
@click.pass_context
def nst_list2(ctx, filter):
"""list all Network Slice Templates (NST) in the system"""
+ logger.debug("")
nst_list(ctx, filter)
def nsi_op_list(ctx, name):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.nsi.list_op(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.nsi.list_op(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['id', 'operation', 'status'])
for op in resp:
table.add_row([op['id'], op['lcmOperationType'],
@@ -585,7 +745,7 @@
print(table)
-@cli.command(name='nsi-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)')
+@cli_osm.command(name='nsi-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)')
@click.argument('name')
@click.pass_context
def nsi_op_list1(ctx, name):
@@ -593,10 +753,11 @@
NAME: name or ID of the Network Slice Instance
"""
+ logger.debug("")
nsi_op_list(ctx, name)
-@cli.command(name='netslice-instance-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)')
+@cli_osm.command(name='netslice-instance-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)')
@click.argument('name')
@click.pass_context
def nsi_op_list2(ctx, name):
@@ -604,21 +765,23 @@
NAME: name or ID of the Network Slice Instance
"""
+ logger.debug("")
nsi_op_list(ctx, name)
-@cli.command(name='pdu-list', short_help='list all Physical Deployment Units (PDU)')
+@cli_osm.command(name='pdu-list', short_help='list all Physical Deployment Units (PDU)')
@click.option('--filter', default=None,
help='restricts the list to the Physical Deployment Units matching the filter')
@click.pass_context
def pdu_list(ctx, filter):
"""list all Physical Deployment Units (PDU)"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.pdu.list(filter)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.pdu.list(filter)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(
['pdu name',
'id',
@@ -647,12 +810,13 @@
####################
def nsd_show(ctx, name, literal):
- try:
- resp = ctx.obj.nsd.get(name)
- # resp = ctx.obj.nsd.get_individual(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ resp = ctx.obj.nsd.get(name)
+ # resp = ctx.obj.nsd.get_individual(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
if literal:
print(yaml.safe_dump(resp))
@@ -665,7 +829,7 @@
print(table)
-@cli.command(name='nsd-show', short_help='shows the content of a NSD')
+@cli_osm.command(name='nsd-show', short_help='shows the content of a NSD')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@click.argument('name')
@@ -675,10 +839,11 @@
NAME: name or ID of the NSD/NSpkg
"""
+ logger.debug("")
nsd_show(ctx, name, literal)
-@cli.command(name='nspkg-show', short_help='shows the content of a NSD')
+@cli_osm.command(name='nspkg-show', short_help='shows the content of a NSD')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@click.argument('name')
@@ -688,16 +853,18 @@
NAME: name or ID of the NSD/NSpkg
"""
+ logger.debug("")
nsd_show(ctx, name, literal)
def vnfd_show(ctx, name, literal):
- try:
- resp = ctx.obj.vnfd.get(name)
- # resp = ctx.obj.vnfd.get_individual(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ resp = ctx.obj.vnfd.get(name)
+ # resp = ctx.obj.vnfd.get_individual(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
if literal:
print(yaml.safe_dump(resp))
@@ -710,7 +877,7 @@
print(table)
-@cli.command(name='vnfd-show', short_help='shows the content of a VNFD')
+@cli_osm.command(name='vnfd-show', short_help='shows the content of a VNFD')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@click.argument('name')
@@ -720,10 +887,11 @@
NAME: name or ID of the VNFD/VNFpkg
"""
+ logger.debug("")
vnfd_show(ctx, name, literal)
-@cli.command(name='vnfpkg-show', short_help='shows the content of a VNFD')
+@cli_osm.command(name='vnfpkg-show', short_help='shows the content of a VNFD')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@click.argument('name')
@@ -733,10 +901,11 @@
NAME: name or ID of the VNFD/VNFpkg
"""
+ logger.debug("")
vnfd_show(ctx, name, literal)
-@cli.command(name='nfpkg-show', short_help='shows the content of a NF Descriptor')
+@cli_osm.command(name='nfpkg-show', short_help='shows the content of a NF Descriptor')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@click.argument('name')
@@ -746,10 +915,11 @@
NAME: name or ID of the NFpkg
"""
+ logger.debug("")
vnfd_show(ctx, name, literal)
-@cli.command(name='ns-show', short_help='shows the info of a NS instance')
+@cli_osm.command(name='ns-show', short_help='shows the info of a NS instance')
@click.argument('name')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@@ -760,11 +930,12 @@
NAME: name or ID of the NS instance
"""
- try:
- ns = ctx.obj.ns.get(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ ns = ctx.obj.ns.get(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
if literal:
print(yaml.safe_dump(ns))
@@ -787,7 +958,7 @@
print(table)
-@cli.command(name='vnf-show', short_help='shows the info of a VNF instance')
+@cli_osm.command(name='vnf-show', short_help='shows the info of a VNF instance')
@click.argument('name')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@@ -799,51 +970,78 @@
NAME: name or ID of the VNF instance
"""
+ def print_kdu_status(op_info_status):
+ """print KDU status properly formatted
+ """
+ try:
+ op_status = yaml.safe_load(op_info_status)
+ if "namespace" in op_status and "info" in op_status and \
+ "last_deployed" in op_status["info"] and "status" in op_status["info"] and \
+ "code" in op_status["info"]["status"] and "resources" in op_status["info"]["status"] and \
+ "notes" in op_status["info"]["status"] and "seconds" in op_status["info"]["last_deployed"]:
+ last_deployed_time = datetime.fromtimestamp(op_status["info"]["last_deployed"]["seconds"]).strftime("%a %b %d %I:%M:%S %Y")
+ print("LAST DEPLOYED: {}".format(last_deployed_time))
+ print("NAMESPACE: {}".format(op_status["namespace"]))
+ status_code = "UNKNOWN"
+ if op_status["info"]["status"]["code"]==1:
+ status_code = "DEPLOYED"
+ print("STATUS: {}".format(status_code))
+ print()
+ print("RESOURCES:")
+ print(op_status["info"]["status"]["resources"])
+ print("NOTES:")
+ print(op_status["info"]["status"]["notes"])
+ else:
+ print(op_info_status)
+ except Exception:
+ print(op_info_status)
+
+ logger.debug("")
if kdu:
if literal:
raise ClientException('"--literal" option is incompatible with "--kdu" option')
if filter:
raise ClientException('"--filter" option is incompatible with "--kdu" option')
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.vnf.get(name)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.vnf.get(name)
- if kdu:
- ns_id = resp['nsr-id-ref']
- op_data={}
- op_data['member_vnf_index'] = resp['member-vnf-index-ref']
- op_data['kdu_name'] = kdu
- op_data['primitive'] = 'status'
- op_data['primitive_params'] = {}
- op_id = ctx.obj.ns.exec_op(ns_id, op_name='action', op_data=op_data, wait=False)
- t = 0
- while t<30:
- op_info = ctx.obj.ns.get_op(op_id)
- if op_info['operationState'] == 'COMPLETED':
- print(op_info['detailed-status'])
- return
- time.sleep(5)
- t += 5
- print ("Could not determine KDU status")
+ if kdu:
+ ns_id = resp['nsr-id-ref']
+ op_data={}
+ op_data['member_vnf_index'] = resp['member-vnf-index-ref']
+ op_data['kdu_name'] = kdu
+ op_data['primitive'] = 'status'
+ op_data['primitive_params'] = {}
+ op_id = ctx.obj.ns.exec_op(ns_id, op_name='action', op_data=op_data, wait=False)
+ t = 0
+ while t<30:
+ op_info = ctx.obj.ns.get_op(op_id)
+ if op_info['operationState'] == 'COMPLETED':
+ print_kdu_status(op_info['detailed-status'])
+ return
+ time.sleep(5)
+ t += 5
+ print ("Could not determine KDU status")
- if literal:
- print(yaml.safe_dump(resp))
- return
+ if literal:
+ print(yaml.safe_dump(resp))
+ return
- table = PrettyTable(['field', 'value'])
+ table = PrettyTable(['field', 'value'])
- for k, v in list(resp.items()):
- if filter is None or filter in k:
- table.add_row([k, wrap_text(text=json.dumps(v,indent=2),width=100)])
- table.align = 'l'
- print(table)
- except ClientException as e:
- print(str(e))
- exit(1)
+ for k, v in list(resp.items()):
+ if filter is None or filter in k:
+ table.add_row([k, wrap_text(text=json.dumps(v,indent=2),width=100)])
+ table.align = 'l'
+ print(table)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-#@cli.command(name='vnf-monitoring-show')
+#@cli_osm.command(name='vnf-monitoring-show')
#@click.argument('vnf_name')
#@click.pass_context
#def vnf_monitoring_show(ctx, vnf_name):
@@ -866,7 +1064,7 @@
# print(table)
-#@cli.command(name='ns-monitoring-show')
+#@cli_osm.command(name='ns-monitoring-show')
#@click.argument('ns_name')
#@click.pass_context
#def ns_monitoring_show(ctx, ns_name):
@@ -889,7 +1087,7 @@
# print(table)
-@cli.command(name='ns-op-show', short_help='shows the info of a NS operation')
+@cli_osm.command(name='ns-op-show', short_help='shows the info of a NS operation')
@click.argument('id')
@click.option('--filter', default=None)
@click.option('--literal', is_flag=True,
@@ -900,12 +1098,13 @@
ID: operation identifier
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- op_info = ctx.obj.ns.get_op(id)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ op_info = ctx.obj.ns.get_op(id)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
if literal:
print(yaml.safe_dump(op_info))
@@ -920,13 +1119,14 @@
def nst_show(ctx, name, literal):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.nst.get(name)
- #resp = ctx.obj.nst.get_individual(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.nst.get(name)
+ #resp = ctx.obj.nst.get_individual(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
if literal:
print(yaml.safe_dump(resp))
@@ -939,7 +1139,7 @@
print(table)
-@cli.command(name='nst-show', short_help='shows the content of a Network Slice Template (NST)')
+@cli_osm.command(name='nst-show', short_help='shows the content of a Network Slice Template (NST)')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@click.argument('name')
@@ -949,10 +1149,11 @@
NAME: name or ID of the NST
"""
+ logger.debug("")
nst_show(ctx, name, literal)
-@cli.command(name='netslice-template-show', short_help='shows the content of a Network Slice Template (NST)')
+@cli_osm.command(name='netslice-template-show', short_help='shows the content of a Network Slice Template (NST)')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@click.argument('name')
@@ -962,16 +1163,18 @@
NAME: name or ID of the NST
"""
+ logger.debug("")
nst_show(ctx, name, literal)
def nsi_show(ctx, name, literal, filter):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- nsi = ctx.obj.nsi.get(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ nsi = ctx.obj.nsi.get(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
if literal:
print(yaml.safe_dump(nsi))
@@ -987,7 +1190,7 @@
print(table)
-@cli.command(name='nsi-show', short_help='shows the content of a Network Slice Instance (NSI)')
+@cli_osm.command(name='nsi-show', short_help='shows the content of a Network Slice Instance (NSI)')
@click.argument('name')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@@ -998,10 +1201,11 @@
NAME: name or ID of the Network Slice Instance
"""
+ logger.debug("")
nsi_show(ctx, name, literal, filter)
-@cli.command(name='netslice-instance-show', short_help='shows the content of a Network Slice Instance (NSI)')
+@cli_osm.command(name='netslice-instance-show', short_help='shows the content of a Network Slice Instance (NSI)')
@click.argument('name')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@@ -1012,16 +1216,18 @@
NAME: name or ID of the Network Slice Instance
"""
+ logger.debug("")
nsi_show(ctx, name, literal, filter)
def nsi_op_show(ctx, id, filter):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- op_info = ctx.obj.nsi.get_op(id)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ op_info = ctx.obj.nsi.get_op(id)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['field', 'value'])
for k, v in list(op_info.items()):
@@ -1031,7 +1237,7 @@
print(table)
-@cli.command(name='nsi-op-show', short_help='shows the info of an operation over a Network Slice Instance(NSI)')
+@cli_osm.command(name='nsi-op-show', short_help='shows the info of an operation over a Network Slice Instance(NSI)')
@click.argument('id')
@click.option('--filter', default=None)
@click.pass_context
@@ -1040,10 +1246,11 @@
ID: operation identifier
"""
+ logger.debug("")
nsi_op_show(ctx, id, filter)
-@cli.command(name='netslice-instance-op-show', short_help='shows the info of an operation over a Network Slice Instance(NSI)')
+@cli_osm.command(name='netslice-instance-op-show', short_help='shows the info of an operation over a Network Slice Instance(NSI)')
@click.argument('id')
@click.option('--filter', default=None)
@click.pass_context
@@ -1052,10 +1259,11 @@
ID: operation identifier
"""
+ logger.debug("")
nsi_op_show(ctx, id, filter)
-@cli.command(name='pdu-show', short_help='shows the content of a Physical Deployment Unit (PDU)')
+@cli_osm.command(name='pdu-show', short_help='shows the content of a Physical Deployment Unit (PDU)')
@click.argument('name')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@@ -1066,12 +1274,13 @@
NAME: name or ID of the PDU
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- pdu = ctx.obj.pdu.get(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ pdu = ctx.obj.pdu.get(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
if literal:
print(yaml.safe_dump(pdu))
@@ -1092,18 +1301,19 @@
####################
def nsd_create(ctx, filename, overwrite):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.nsd.create(filename, overwrite)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.nsd.create(filename, overwrite)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='nsd-create', short_help='creates a new NSD/NSpkg')
+@cli_osm.command(name='nsd-create', short_help='creates a new NSD/NSpkg')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrite deprecated, use override')
+@click.option('--overwrite', 'overwrite', default=None, # hidden=True,
+ help='Deprecated. Use override')
@click.option('--override', 'overwrite', default=None,
help='overrides fields in descriptor, format: '
'"key1.key2...=value[;key3...=value;...]"')
@@ -1113,13 +1323,14 @@
FILENAME: NSD yaml file or NSpkg tar.gz file
"""
+ logger.debug("")
nsd_create(ctx, filename, overwrite)
-@cli.command(name='nspkg-create', short_help='creates a new NSD/NSpkg')
+@cli_osm.command(name='nspkg-create', short_help='creates a new NSD/NSpkg')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrite deprecated, use override')
+@click.option('--overwrite', 'overwrite', default=None, # hidden=True,
+ help='Deprecated. Use override')
@click.option('--override', 'overwrite', default=None,
help='overrides fields in descriptor, format: '
'"key1.key2...=value[;key3...=value;...]"')
@@ -1129,19 +1340,21 @@
FILENAME: NSD yaml file or NSpkg tar.gz file
"""
+ logger.debug("")
nsd_create(ctx, filename, overwrite)
def vnfd_create(ctx, filename, overwrite):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.vnfd.create(filename, overwrite)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.vnfd.create(filename, overwrite)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='vnfd-create', short_help='creates a new VNFD/VNFpkg')
+@cli_osm.command(name='vnfd-create', short_help='creates a new VNFD/VNFpkg')
@click.argument('filename')
@click.option('--overwrite', 'overwrite', default=None,
help='overwrite deprecated, use override')
@@ -1154,13 +1367,14 @@
FILENAME: VNFD yaml file or VNFpkg tar.gz file
"""
+ logger.debug("")
vnfd_create(ctx, filename, overwrite)
-@cli.command(name='vnfpkg-create', short_help='creates a new VNFD/VNFpkg')
+@cli_osm.command(name='vnfpkg-create', short_help='creates a new VNFD/VNFpkg')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrite deprecated, use override')
+@click.option('--overwrite', 'overwrite', default=None, # hidden=True,
+ help='Deprecated. Use override')
@click.option('--override', 'overwrite', default=None,
help='overrides fields in descriptor, format: '
'"key1.key2...=value[;key3...=value;...]"')
@@ -1170,13 +1384,14 @@
FILENAME: VNFD yaml file or VNFpkg tar.gz file
"""
+ logger.debug("")
vnfd_create(ctx, filename, overwrite)
-@cli.command(name='nfpkg-create', short_help='creates a new NFpkg')
+@cli_osm.command(name='nfpkg-create', short_help='creates a new NFpkg')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrite deprecated, use override')
+@click.option('--overwrite', 'overwrite', default=None, # hidden=True,
+ help='Deprecated. Use override')
@click.option('--override', 'overwrite', default=None,
help='overrides fields in descriptor, format: '
'"key1.key2...=value[;key3...=value;...]"')
@@ -1186,10 +1401,11 @@
FILENAME: NF Descriptor yaml file or NFpkg tar.gz file
"""
+ logger.debug("")
vnfd_create(ctx, filename, overwrite)
-@cli.command(name='ns-create', short_help='creates a new Network Service instance')
+@cli_osm.command(name='ns-create', short_help='creates a new Network Service instance')
@click.option('--ns_name',
prompt=True, help='name of the NS instance')
@click.option('--nsd_name',
@@ -1212,8 +1428,8 @@
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def ns_create(ctx,
nsd_name,
@@ -1225,39 +1441,41 @@
config_file,
wait):
"""creates a new NS instance"""
- try:
- if config_file:
- check_client_version(ctx.obj, '--config_file')
- if config:
- raise ClientException('"--config" option is incompatible with "--config_file" option')
- with open(config_file, 'r') as cf:
- config=cf.read()
- ctx.obj.ns.create(
- nsd_name,
- ns_name,
- config=config,
- ssh_keys=ssh_keys,
- account=vim_account,
- wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ if config_file:
+ check_client_version(ctx.obj, '--config_file')
+ if config:
+ raise ClientException('"--config" option is incompatible with "--config_file" option')
+ with open(config_file, 'r') as cf:
+ config=cf.read()
+ ctx.obj.ns.create(
+ nsd_name,
+ ns_name,
+ config=config,
+ ssh_keys=ssh_keys,
+ account=vim_account,
+ wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
def nst_create(ctx, filename, overwrite):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.nst.create(filename, overwrite)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.nst.create(filename, overwrite)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='nst-create', short_help='creates a new Network Slice Template (NST)')
+@cli_osm.command(name='nst-create', short_help='creates a new Network Slice Template (NST)')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrites deprecated use override')
-@click.option('--override', 'overwrite' ,default=None,
+@click.option('--overwrite', 'overwrite', default=None, # hidden=True,
+ help='Deprecated. Use override')
+@click.option('--override', 'overwrite', default=None,
help='overrides fields in descriptor, format: '
'"key1.key2...=value[;key3...=value;...]"')
@click.pass_context
@@ -1266,13 +1484,14 @@
FILENAME: NST yaml file or NSTpkg tar.gz file
"""
+ logger.debug("")
nst_create(ctx, filename, overwrite)
-@cli.command(name='netslice-template-create', short_help='creates a new Network Slice Template (NST)')
+@cli_osm.command(name='netslice-template-create', short_help='creates a new Network Slice Template (NST)')
@click.argument('filename')
-@click.option('--overwrite', 'overwrite', default=None,
- help='overwrites deprecated use override')
+@click.option('--overwrite', 'overwrite', default=None, # hidden=True,
+ help='Deprecated. Use override')
@click.option('--override', 'overwrite', default=None,
help='overrides fields in descriptor, format: '
'"key1.key2...=value[;key3...=value;...]"')
@@ -1282,26 +1501,28 @@
FILENAME: NST yaml file or NSTpkg tar.gz file
"""
+ logger.debug("")
nst_create(ctx, filename, overwrite)
def nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait):
"""creates a new Network Slice Instance (NSI)"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- if config_file:
- if config:
- raise ClientException('"--config" option is incompatible with "--config_file" option')
- with open(config_file, 'r') as cf:
- config=cf.read()
- ctx.obj.nsi.create(nst_name, nsi_name, config=config, ssh_keys=ssh_keys,
- account=vim_account, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ if config_file:
+ if config:
+ raise ClientException('"--config" option is incompatible with "--config_file" option')
+ with open(config_file, 'r') as cf:
+ config=cf.read()
+ ctx.obj.nsi.create(nst_name, nsi_name, config=config, ssh_keys=ssh_keys,
+ account=vim_account, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='nsi-create', short_help='creates a new Network Slice Instance')
+@cli_osm.command(name='nsi-create', short_help='creates a new Network Slice Instance')
@click.option('--nsi_name', prompt=True, help='name of the Network Slice Instance')
@click.option('--nst_name', prompt=True, help='name of the Network Slice Template')
@click.option('--vim_account', prompt=True, help='default VIM account id or name for the deployment')
@@ -1325,15 +1546,16 @@
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def nsi_create1(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait):
"""creates a new Network Slice Instance (NSI)"""
+ logger.debug("")
nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait=wait)
-@cli.command(name='netslice-instance-create', short_help='creates a new Network Slice Instance')
+@cli_osm.command(name='netslice-instance-create', short_help='creates a new Network Slice Instance')
@click.option('--nsi_name', prompt=True, help='name of the Network Slice Instance')
@click.option('--nst_name', prompt=True, help='name of the Network Slice Template')
@click.option('--vim_account', prompt=True, help='default VIM account id or name for the deployment')
@@ -1355,15 +1577,16 @@
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def nsi_create2(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait):
"""creates a new Network Slice Instance (NSI)"""
+ logger.debug("")
nsi_create(ctx, nst_name, nsi_name, vim_account, ssh_keys, config, config_file, wait=wait)
-@cli.command(name='pdu-create', short_help='adds a new Physical Deployment Unit to the catalog')
+@cli_osm.command(name='pdu-create', short_help='adds a new Physical Deployment Unit to the catalog')
@click.option('--name', help='name of the Physical Deployment Unit')
@click.option('--pdu_type', help='type of PDU (e.g. router, firewall, FW001)')
@click.option('--interface',
@@ -1372,55 +1595,59 @@
multiple=True)
@click.option('--description', help='human readable description')
@click.option('--vim_account', help='list of VIM accounts (in the same VIM) that can reach this PDU', multiple=True)
-@click.option('--descriptor_file', default=None, help='PDU descriptor file (as an alternative to using the other arguments')
+@click.option('--descriptor_file', default=None,
+ help='PDU descriptor file (as an alternative to using the other arguments')
@click.pass_context
def pdu_create(ctx, name, pdu_type, interface, description, vim_account, descriptor_file):
"""creates a new Physical Deployment Unit (PDU)"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- pdu = {}
- if not descriptor_file:
- if not name:
- raise ClientException('in absence of descriptor file, option "--name" is mandatory')
- if not pdu_type:
- raise ClientException('in absence of descriptor file, option "--pdu_type" is mandatory')
- if not interface:
- raise ClientException('in absence of descriptor file, option "--interface" is mandatory (at least once)')
- if not vim_account:
- raise ClientException('in absence of descriptor file, option "--vim_account" is mandatory (at least once)')
- else:
- with open(descriptor_file, 'r') as df:
- pdu = yaml.safe_load(df.read())
- if name: pdu["name"] = name
- if pdu_type: pdu["type"] = pdu_type
- if description: pdu["description"] = description
- if vim_account: pdu["vim_accounts"] = vim_account
- if interface:
- ifaces_list = []
- for iface in interface:
- new_iface={k:v for k,v in [i.split('=') for i in iface.split(',')]}
- new_iface["mgmt"] = (new_iface.get("mgmt","false").lower() == "true")
- ifaces_list.append(new_iface)
- pdu["interfaces"] = ifaces_list
- ctx.obj.pdu.create(pdu)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ pdu = {}
+ if not descriptor_file:
+ if not name:
+ raise ClientException('in absence of descriptor file, option "--name" is mandatory')
+ if not pdu_type:
+ raise ClientException('in absence of descriptor file, option "--pdu_type" is mandatory')
+ if not interface:
+ raise ClientException('in absence of descriptor file, option "--interface" is mandatory (at least once)')
+ if not vim_account:
+ raise ClientException('in absence of descriptor file, option "--vim_account" is mandatory (at least once)')
+ else:
+ with open(descriptor_file, 'r') as df:
+ pdu = yaml.safe_load(df.read())
+ if name: pdu["name"] = name
+ if pdu_type: pdu["type"] = pdu_type
+ if description: pdu["description"] = description
+ if vim_account: pdu["vim_accounts"] = vim_account
+ if interface:
+ ifaces_list = []
+ for iface in interface:
+ new_iface={k:v for k,v in [i.split('=') for i in iface.split(',')]}
+ new_iface["mgmt"] = (new_iface.get("mgmt","false").lower() == "true")
+ ifaces_list.append(new_iface)
+ pdu["interfaces"] = ifaces_list
+ ctx.obj.pdu.create(pdu)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
####################
# UPDATE operations
####################
def nsd_update(ctx, name, content):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.nsd.update(name, content)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.nsd.update(name, content)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='nsd-update', short_help='updates a NSD/NSpkg')
+@cli_osm.command(name='nsd-update', short_help='updates a NSD/NSpkg')
@click.argument('name')
@click.option('--content', default=None,
help='filename with the NSD/NSpkg replacing the current one')
@@ -1430,10 +1657,11 @@
NAME: name or ID of the NSD/NSpkg
"""
+ logger.debug("")
nsd_update(ctx, name, content)
-@cli.command(name='nspkg-update', short_help='updates a NSD/NSpkg')
+@cli_osm.command(name='nspkg-update', short_help='updates a NSD/NSpkg')
@click.argument('name')
@click.option('--content', default=None,
help='filename with the NSD/NSpkg replacing the current one')
@@ -1443,19 +1671,21 @@
NAME: name or ID of the NSD/NSpkg
"""
+ logger.debug("")
nsd_update(ctx, name, content)
def vnfd_update(ctx, name, content):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.vnfd.update(name, content)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.vnfd.update(name, content)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='vnfd-update', short_help='updates a new VNFD/VNFpkg')
+@cli_osm.command(name='vnfd-update', short_help='updates a new VNFD/VNFpkg')
@click.argument('name')
@click.option('--content', default=None,
help='filename with the VNFD/VNFpkg replacing the current one')
@@ -1465,10 +1695,11 @@
NAME: name or ID of the VNFD/VNFpkg
"""
+ logger.debug("")
vnfd_update(ctx, name, content)
-@cli.command(name='vnfpkg-update', short_help='updates a VNFD/VNFpkg')
+@cli_osm.command(name='vnfpkg-update', short_help='updates a VNFD/VNFpkg')
@click.argument('name')
@click.option('--content', default=None,
help='filename with the VNFD/VNFpkg replacing the current one')
@@ -1478,10 +1709,11 @@
NAME: VNFD yaml file or VNFpkg tar.gz file
"""
+ logger.debug("")
vnfd_update(ctx, name, content)
-@cli.command(name='nfpkg-update', short_help='updates a NFpkg')
+@cli_osm.command(name='nfpkg-update', short_help='updates a NFpkg')
@click.argument('name')
@click.option('--content', default=None,
help='filename with the NFpkg replacing the current one')
@@ -1491,19 +1723,21 @@
NAME: NF Descriptor yaml file or NFpkg tar.gz file
"""
+ logger.debug("")
vnfd_update(ctx, name, content)
def nst_update(ctx, name, content):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.nst.update(name, content)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.nst.update(name, content)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='nst-update', short_help='updates a Network Slice Template (NST)')
+@cli_osm.command(name='nst-update', short_help='updates a Network Slice Template (NST)')
@click.argument('name')
@click.option('--content', default=None,
help='filename with the NST/NSTpkg replacing the current one')
@@ -1513,10 +1747,11 @@
NAME: name or ID of the NSD/NSpkg
"""
+ logger.debug("")
nst_update(ctx, name, content)
-@cli.command(name='netslice-template-update', short_help='updates a Network Slice Template (NST)')
+@cli_osm.command(name='netslice-template-update', short_help='updates a Network Slice Template (NST)')
@click.argument('name')
@click.option('--content', default=None,
help='filename with the NST/NSTpkg replacing the current one')
@@ -1526,6 +1761,7 @@
NAME: name or ID of the NSD/NSpkg
"""
+ logger.debug("")
nst_update(ctx, name, content)
@@ -1534,18 +1770,19 @@
####################
def nsd_delete(ctx, name, force):
- try:
- if not force:
- ctx.obj.nsd.delete(name)
- else:
- check_client_version(ctx.obj, '--force')
- ctx.obj.nsd.delete(name, force)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ if not force:
+ ctx.obj.nsd.delete(name)
+ else:
+ check_client_version(ctx.obj, '--force')
+ ctx.obj.nsd.delete(name, force)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='nsd-delete', short_help='deletes a NSD/NSpkg')
+@cli_osm.command(name='nsd-delete', short_help='deletes a NSD/NSpkg')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -1554,10 +1791,11 @@
NAME: name or ID of the NSD/NSpkg to be deleted
"""
+ logger.debug("")
nsd_delete(ctx, name, force)
-@cli.command(name='nspkg-delete', short_help='deletes a NSD/NSpkg')
+@cli_osm.command(name='nspkg-delete', short_help='deletes a NSD/NSpkg')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -1566,22 +1804,24 @@
NAME: name or ID of the NSD/NSpkg to be deleted
"""
+ logger.debug("")
nsd_delete(ctx, name, force)
def vnfd_delete(ctx, name, force):
- try:
- if not force:
- ctx.obj.vnfd.delete(name)
- else:
- check_client_version(ctx.obj, '--force')
- ctx.obj.vnfd.delete(name, force)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ if not force:
+ ctx.obj.vnfd.delete(name)
+ else:
+ check_client_version(ctx.obj, '--force')
+ ctx.obj.vnfd.delete(name, force)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='vnfd-delete', short_help='deletes a VNFD/VNFpkg')
+@cli_osm.command(name='vnfd-delete', short_help='deletes a VNFD/VNFpkg')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -1590,10 +1830,11 @@
NAME: name or ID of the VNFD/VNFpkg to be deleted
"""
+ logger.debug("")
vnfd_delete(ctx, name, force)
-@cli.command(name='vnfpkg-delete', short_help='deletes a VNFD/VNFpkg')
+@cli_osm.command(name='vnfpkg-delete', short_help='deletes a VNFD/VNFpkg')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -1602,10 +1843,11 @@
NAME: name or ID of the VNFD/VNFpkg to be deleted
"""
+ logger.debug("")
vnfd_delete(ctx, name, force)
-@cli.command(name='nfpkg-delete', short_help='deletes a NFpkg')
+@cli_osm.command(name='nfpkg-delete', short_help='deletes a NFpkg')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -1614,45 +1856,48 @@
NAME: name or ID of the NFpkg to be deleted
"""
+ logger.debug("")
vnfd_delete(ctx, name, force)
-@cli.command(name='ns-delete', short_help='deletes a NS instance')
+@cli_osm.command(name='ns-delete', short_help='deletes a NS instance')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.option('--wait',
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def ns_delete(ctx, name, force, wait):
"""deletes a NS instance
NAME: name or ID of the NS instance to be deleted
"""
- try:
- if not force:
- ctx.obj.ns.delete(name, wait=wait)
- else:
- check_client_version(ctx.obj, '--force')
- ctx.obj.ns.delete(name, force, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ if not force:
+ ctx.obj.ns.delete(name, wait=wait)
+ else:
+ check_client_version(ctx.obj, '--force')
+ ctx.obj.ns.delete(name, force, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
def nst_delete(ctx, name, force):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.nst.delete(name, force)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.nst.delete(name, force)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='nst-delete', short_help='deletes a Network Slice Template (NST)')
+@cli_osm.command(name='nst-delete', short_help='deletes a Network Slice Template (NST)')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -1661,10 +1906,11 @@
NAME: name or ID of the NST/NSTpkg to be deleted
"""
+ logger.debug("")
nst_delete(ctx, name, force)
-@cli.command(name='netslice-template-delete', short_help='deletes a Network Slice Template (NST)')
+@cli_osm.command(name='netslice-template-delete', short_help='deletes a Network Slice Template (NST)')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -1673,37 +1919,40 @@
NAME: name or ID of the NST/NSTpkg to be deleted
"""
+ logger.debug("")
nst_delete(ctx, name, force)
def nsi_delete(ctx, name, force, wait):
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.nsi.delete(name, force, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.nsi.delete(name, force, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='nsi-delete', short_help='deletes a Network Slice Instance (NSI)')
+@cli_osm.command(name='nsi-delete', short_help='deletes a Network Slice Instance (NSI)')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.option('--wait',
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def nsi_delete1(ctx, name, force, wait):
"""deletes a Network Slice Instance (NSI)
NAME: name or ID of the Network Slice instance to be deleted
"""
+ logger.debug("")
nsi_delete(ctx, name, force, wait=wait)
-@cli.command(name='netslice-instance-delete', short_help='deletes a Network Slice Instance (NSI)')
+@cli_osm.command(name='netslice-instance-delete', short_help='deletes a Network Slice Instance (NSI)')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -1712,10 +1961,11 @@
NAME: name or ID of the Network Slice instance to be deleted
"""
+ logger.debug("")
nsi_delete(ctx, name, force, wait=wait)
-@cli.command(name='pdu-delete', short_help='deletes a Physical Deployment Unit (PDU)')
+@cli_osm.command(name='pdu-delete', short_help='deletes a Physical Deployment Unit (PDU)')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -1724,19 +1974,20 @@
NAME: name or ID of the PDU to be deleted
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.pdu.delete(name, force)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.pdu.delete(name, force)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
#################
# VIM operations
#################
-@cli.command(name='vim-create', short_help='creates a new VIM account')
+@cli_osm.command(name='vim-create', short_help='creates a new VIM account')
@click.option('--name',
prompt=True,
help='Name to create datacenter')
@@ -1769,8 +2020,8 @@
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def vim_create(ctx,
name,
@@ -1785,29 +2036,30 @@
sdn_port_mapping,
wait):
"""creates a new VIM account"""
- try:
- if sdn_controller:
- check_client_version(ctx.obj, '--sdn_controller')
- if sdn_port_mapping:
- check_client_version(ctx.obj, '--sdn_port_mapping')
- vim = {}
- vim['vim-username'] = user
- vim['vim-password'] = password
- vim['vim-url'] = auth_url
- vim['vim-tenant-name'] = tenant
- vim['vim-type'] = account_type
- vim['description'] = description
- vim['config'] = config
- if sdn_controller or sdn_port_mapping:
- ctx.obj.vim.create(name, vim, sdn_controller, sdn_port_mapping, wait=wait)
- else:
- ctx.obj.vim.create(name, vim, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ if sdn_controller:
+ check_client_version(ctx.obj, '--sdn_controller')
+ if sdn_port_mapping:
+ check_client_version(ctx.obj, '--sdn_port_mapping')
+ vim = {}
+ vim['vim-username'] = user
+ vim['vim-password'] = password
+ vim['vim-url'] = auth_url
+ vim['vim-tenant-name'] = tenant
+ vim['vim-type'] = account_type
+ vim['description'] = description
+ vim['config'] = config
+ if sdn_controller or sdn_port_mapping:
+ ctx.obj.vim.create(name, vim, sdn_controller, sdn_port_mapping, wait=wait)
+ else:
+ ctx.obj.vim.create(name, vim, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='vim-update', short_help='updates a VIM account')
+@cli_osm.command(name='vim-update', short_help='updates a VIM account')
@click.argument('name')
@click.option('--newname', help='New name for the VIM account')
@click.option('--user', help='VIM username')
@@ -1823,8 +2075,8 @@
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def vim_update(ctx,
name,
@@ -1843,50 +2095,52 @@
NAME: name or ID of the VIM account
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- vim = {}
- if newname: vim['name'] = newname
- if user: vim['vim_user'] = user
- if password: vim['vim_password'] = password
- if auth_url: vim['vim_url'] = auth_url
- if tenant: vim['vim-tenant-name'] = tenant
- if account_type: vim['vim_type'] = account_type
- if description: vim['description'] = description
- if config: vim['config'] = config
- ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ vim = {}
+ if newname: vim['name'] = newname
+ if user: vim['vim_user'] = user
+ if password: vim['vim_password'] = password
+ if auth_url: vim['vim_url'] = auth_url
+ if tenant: vim['vim-tenant-name'] = tenant
+ if account_type: vim['vim_type'] = account_type
+ if description: vim['description'] = description
+ if config: vim['config'] = config
+ ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='vim-delete', short_help='deletes a VIM account')
+@cli_osm.command(name='vim-delete', short_help='deletes a VIM account')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.option('--wait',
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def vim_delete(ctx, name, force, wait):
"""deletes a VIM account
NAME: name or ID of the VIM account to be deleted
"""
- try:
- if not force:
- ctx.obj.vim.delete(name, wait=wait)
- else:
- check_client_version(ctx.obj, '--force')
- ctx.obj.vim.delete(name, force, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ if not force:
+ ctx.obj.vim.delete(name, wait=wait)
+ else:
+ check_client_version(ctx.obj, '--force')
+ ctx.obj.vim.delete(name, force, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='vim-list', short_help='list all VIM accounts')
+@cli_osm.command(name='vim-list', short_help='list all VIM accounts')
#@click.option('--ro_update/--no_ro_update',
# default=False,
# help='update list from RO')
@@ -1895,6 +2149,7 @@
@click.pass_context
def vim_list(ctx, filter):
"""list all VIM accounts"""
+ logger.debug("")
if filter:
check_client_version(ctx.obj, '--filter')
# if ro_update:
@@ -1911,7 +2166,7 @@
print(table)
-@cli.command(name='vim-show', short_help='shows the details of a VIM account')
+@cli_osm.command(name='vim-show', short_help='shows the details of a VIM account')
@click.argument('name')
@click.pass_context
def vim_show(ctx, name):
@@ -1919,13 +2174,14 @@
NAME: name or ID of the VIM account
"""
- try:
- resp = ctx.obj.vim.get(name)
- if 'vim_password' in resp:
- resp['vim_password']='********'
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ resp = ctx.obj.vim.get(name)
+ if 'vim_password' in resp:
+ resp['vim_password']='********'
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['key', 'attribute'])
for k, v in list(resp.items()):
@@ -1938,7 +2194,7 @@
# WIM operations
####################
-@cli.command(name='wim-create', short_help='creates a new WIM account')
+@cli_osm.command(name='wim-create', short_help='creates a new WIM account')
@click.option('--name',
prompt=True,
help='Name for the WIM account')
@@ -1959,13 +2215,15 @@
@click.option('--description',
default='no description',
help='human readable description')
-@click.option('--wim_port_mapping', default=None, help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge (WAN service endpoint id and info)")
+@click.option('--wim_port_mapping', default=None,
+ help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
+ "(WAN service endpoint id and info)")
@click.option('--wait',
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it '
+ 'until the operation is completed, or timeout')
@click.pass_context
def wim_create(ctx,
name,
@@ -1979,27 +2237,28 @@
wim_port_mapping,
wait):
"""creates a new WIM account"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- # if sdn_controller:
- # check_client_version(ctx.obj, '--sdn_controller')
- # if sdn_port_mapping:
- # check_client_version(ctx.obj, '--sdn_port_mapping')
- wim = {}
- if user: wim['user'] = user
- if password: wim['password'] = password
- if url: wim['wim_url'] = url
- # if tenant: wim['tenant'] = tenant
- wim['wim_type'] = wim_type
- if description: wim['description'] = description
- if config: wim['config'] = config
- ctx.obj.wim.create(name, wim, wim_port_mapping, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ # if sdn_controller:
+ # check_client_version(ctx.obj, '--sdn_controller')
+ # if sdn_port_mapping:
+ # check_client_version(ctx.obj, '--sdn_port_mapping')
+ wim = {}
+ if user: wim['user'] = user
+ if password: wim['password'] = password
+ if url: wim['wim_url'] = url
+ # if tenant: wim['tenant'] = tenant
+ wim['wim_type'] = wim_type
+ if description: wim['description'] = description
+ if config: wim['config'] = config
+ ctx.obj.wim.create(name, wim, wim_port_mapping, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='wim-update', short_help='updates a WIM account')
+@cli_osm.command(name='wim-update', short_help='updates a WIM account')
@click.argument('name')
@click.option('--newname', help='New name for the WIM account')
@click.option('--user', help='WIM username')
@@ -2008,13 +2267,14 @@
@click.option('--config', help='WIM specific config parameters')
@click.option('--wim_type', help='WIM type')
@click.option('--description', help='human readable description')
-@click.option('--wim_port_mapping', default=None, help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge (WAN service endpoint id and info)")
+@click.option('--wim_port_mapping', default=None,
+ help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge "
+ "(WAN service endpoint id and info)")
@click.option('--wait',
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def wim_update(ctx,
name,
@@ -2031,66 +2291,68 @@
NAME: name or ID of the WIM account
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- wim = {}
- if newname: wim['name'] = newname
- if user: wim['user'] = user
- if password: wim['password'] = password
- if url: wim['url'] = url
- # if tenant: wim['tenant'] = tenant
- if wim_type: wim['wim_type'] = wim_type
- if description: wim['description'] = description
- if config: wim['config'] = config
- ctx.obj.wim.update(name, wim, wim_port_mapping, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ wim = {}
+ if newname: wim['name'] = newname
+ if user: wim['user'] = user
+ if password: wim['password'] = password
+ if url: wim['url'] = url
+ # if tenant: wim['tenant'] = tenant
+ if wim_type: wim['wim_type'] = wim_type
+ if description: wim['description'] = description
+ if config: wim['config'] = config
+ ctx.obj.wim.update(name, wim, wim_port_mapping, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='wim-delete', short_help='deletes a WIM account')
+@cli_osm.command(name='wim-delete', short_help='deletes a WIM account')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.option('--wait',
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def wim_delete(ctx, name, force, wait):
"""deletes a WIM account
NAME: name or ID of the WIM account to be deleted
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.wim.delete(name, force, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.wim.delete(name, force, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='wim-list', short_help='list all WIM accounts')
+@cli_osm.command(name='wim-list', short_help='list all WIM accounts')
@click.option('--filter', default=None,
help='restricts the list to the WIM accounts matching the filter')
@click.pass_context
def wim_list(ctx, filter):
"""list all WIM accounts"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.wim.list(filter)
- table = PrettyTable(['wim name', 'uuid'])
- for wim in resp:
- table.add_row([wim['name'], wim['uuid']])
- table.align = 'l'
- print(table)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.wim.list(filter)
+ table = PrettyTable(['wim name', 'uuid'])
+ for wim in resp:
+ table.add_row([wim['name'], wim['uuid']])
+ table.align = 'l'
+ print(table)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='wim-show', short_help='shows the details of a WIM account')
+@cli_osm.command(name='wim-show', short_help='shows the details of a WIM account')
@click.argument('name')
@click.pass_context
def wim_show(ctx, name):
@@ -2098,14 +2360,15 @@
NAME: name or ID of the WIM account
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.wim.get(name)
- if 'password' in resp:
- resp['wim_password']='********'
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.wim.get(name)
+ if 'password' in resp:
+ resp['wim_password']='********'
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['key', 'attribute'])
for k, v in list(resp.items()):
@@ -2118,169 +2381,143 @@
# SDN controller operations
####################
-@cli.command(name='sdnc-create', short_help='creates a new SDN controller')
+@cli_osm.command(name='sdnc-create', short_help='creates a new SDN controller')
@click.option('--name',
prompt=True,
help='Name to create sdn controller')
@click.option('--type',
prompt=True,
help='SDN controller type')
-@click.option('--sdn_controller_version',
- help='SDN controller version')
-@click.option('--ip_address',
- prompt=True,
- help='SDN controller IP address')
-@click.option('--port',
- prompt=True,
- help='SDN controller port')
-@click.option('--switch_dpid',
- prompt=True,
- help='Switch DPID (Openflow Datapath ID)')
+@click.option('--sdn_controller_version', # hidden=True,
+ help='Deprecated. Use --config {version: sdn_controller_version}')
+@click.option('--url',
+ help='URL in format http[s]://HOST:IP/')
+@click.option('--ip_address', # hidden=True,
+ help='Deprecated. Use --url')
+@click.option('--port', # hidden=True,
+ help='Deprecated. Use --url')
+@click.option('--switch_dpid', # hidden=True,
+ help='Deprecated. Use --config {dpid: DPID}')
+@click.option('--config',
+ help='Extra information for SDN in yaml format, as {dpid: (Openflow Datapath ID), version: version}')
@click.option('--user',
help='SDN controller username')
@click.option('--password',
hide_input=True,
confirmation_prompt=True,
help='SDN controller password')
-#@click.option('--description',
-# default='no description',
-# help='human readable description')
+@click.option('--description', default=None, help='human readable description')
@click.option('--wait',
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help="do not return the control immediately, but keep it until the operation is completed, or timeout")
@click.pass_context
-def sdnc_create(ctx,
- name,
- type,
- sdn_controller_version,
- ip_address,
- port,
- switch_dpid,
- user,
- password,
- wait):
+def sdnc_create(ctx, **kwargs):
"""creates a new SDN controller"""
- sdncontroller = {}
- sdncontroller['name'] = name
- sdncontroller['type'] = type
- sdncontroller['ip'] = ip_address
- sdncontroller['port'] = int(port)
- sdncontroller['dpid'] = switch_dpid
- if sdn_controller_version:
- sdncontroller['version'] = sdn_controller_version
- if user:
- sdncontroller['user'] = user
- if password:
- sdncontroller['password'] = password
-# sdncontroller['description'] = description
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.sdnc.create(name, sdncontroller, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ sdncontroller = {x: kwargs[x] for x in kwargs if kwargs[x] and
+ x not in ("wait", "ip_address", "port", "switch_dpid")}
+ if kwargs.get("port"):
+ print("option '--port' is deprecated, use '-url' instead")
+ sdncontroller["port"] = int(kwargs["port"])
+ if kwargs.get("ip_address"):
+ print("option '--ip_address' is deprecated, use '-url' instead")
+ sdncontroller["ip"] = kwargs["ip_address"]
+ if kwargs.get("switch_dpid"):
+ print("option '--switch_dpid' is deprecated, use '---config={dpid: DPID}' instead")
+ sdncontroller["dpid"] = kwargs["switch_dpid"]
+ if kwargs.get("sdn_controller_version"):
+ print("option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'"
+ " instead")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.sdnc.create(kwargs["name"], sdncontroller, wait=kwargs["wait"])
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='sdnc-update', short_help='updates an SDN controller')
+@cli_osm.command(name='sdnc-update', short_help='updates an SDN controller')
@click.argument('name')
@click.option('--newname', help='New name for the SDN controller')
+@click.option('--description', default=None, help='human readable description')
@click.option('--type', help='SDN controller type')
-@click.option('--sdn_controller_version', help='SDN controller username')
-@click.option('--ip_address', help='SDN controller IP address')
-@click.option('--port', help='SDN controller port')
-@click.option('--switch_dpid', help='Switch DPID (Openflow Datapath ID)')
+@click.option('--url', help='URL in format http[s]://HOST:IP/')
+@click.option('--config', help='Extra information for SDN in yaml format, as '
+ '{dpid: (Openflow Datapath ID), version: version}')
@click.option('--user', help='SDN controller username')
@click.option('--password', help='SDN controller password')
-#@click.option('--description', default=None, help='human readable description')
-@click.option('--wait',
- required=False,
- default=False,
- is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+@click.option('--ip_address', help='Deprecated. Use --url') # hidden=True
+@click.option('--port', help='Deprecated. Use --url') # hidden=True
+@click.option('--switch_dpid', help='Deprecated. Use --config {switch_dpid: DPID}') # hidden=True
+@click.option('--sdn_controller_version', help='Deprecated. Use --config {version: VERSION}') # hidden=True
+@click.option('--wait', required=False, default=False, is_flag=True,
+ help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
-def sdnc_update(ctx,
- name,
- newname,
- type,
- sdn_controller_version,
- ip_address,
- port,
- switch_dpid,
- user,
- password,
- wait):
+def sdnc_update(ctx, **kwargs):
"""updates an SDN controller
NAME: name or ID of the SDN controller
"""
- sdncontroller = {}
- if newname: sdncontroller['name'] = newname
- if type: sdncontroller['type'] = type
- if ip_address: sdncontroller['ip'] = ip_address
- if port: sdncontroller['port'] = int(port)
- if switch_dpid: sdncontroller['dpid'] = switch_dpid
-# sdncontroller['description'] = description
- if sdn_controller_version is not None:
- if sdn_controller_version=="":
- sdncontroller['version'] = None
- else:
- sdncontroller['version'] = sdn_controller_version
- if user is not None:
- if user=="":
- sdncontroller['user'] = None
- else:
- sdncontroller['user'] = user
- if password is not None:
- if password=="":
- sdncontroller['password'] = None
- else:
- sdncontroller['password'] = user
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.sdnc.update(name, sdncontroller, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ sdncontroller = {x: kwargs[x] for x in kwargs if kwargs[x] and
+ x not in ("wait", "ip_address", "port", "switch_dpid", "new_name")}
+ if kwargs.get("newname"):
+ sdncontroller["name"] = kwargs["newname"]
+ if kwargs.get("port"):
+ print("option '--port' is deprecated, use '-url' instead")
+ sdncontroller["port"] = int(kwargs["port"])
+ if kwargs.get("ip_address"):
+ print("option '--ip_address' is deprecated, use '-url' instead")
+ sdncontroller["ip"] = kwargs["ip_address"]
+ if kwargs.get("switch_dpid"):
+ print("option '--switch_dpid' is deprecated, use '---config={dpid: DPID}' instead")
+ sdncontroller["dpid"] = kwargs["switch_dpid"]
+ if kwargs.get("sdn_controller_version"):
+ print("option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'"
+ " instead")
+
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.sdnc.update(kwargs["name"], sdncontroller, wait=kwargs["wait"])
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='sdnc-delete', short_help='deletes an SDN controller')
+@cli_osm.command(name='sdnc-delete', short_help='deletes an SDN controller')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
-@click.option('--wait',
- required=False,
- default=False,
- is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+@click.option('--wait', required=False, default=False, is_flag=True,
+ help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def sdnc_delete(ctx, name, force, wait):
"""deletes an SDN controller
NAME: name or ID of the SDN controller to be deleted
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.sdnc.delete(name, force, wait=wait)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.sdnc.delete(name, force, wait=wait)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='sdnc-list', short_help='list all SDN controllers')
+@cli_osm.command(name='sdnc-list', short_help='list all SDN controllers')
@click.option('--filter', default=None,
- help='restricts the list to the SDN controllers matching the filter')
+ help="restricts the list to the SDN controllers matching the filter with format: 'k[.k..]=v[&k[.k]=v2]'")
@click.pass_context
def sdnc_list(ctx, filter):
"""list all SDN controllers"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.sdnc.list(filter)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.sdnc.list(filter)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['sdnc name', 'id'])
for sdnc in resp:
table.add_row([sdnc['name'], sdnc['_id']])
@@ -2288,7 +2525,7 @@
print(table)
-@cli.command(name='sdnc-show', short_help='shows the details of an SDN controller')
+@cli_osm.command(name='sdnc-show', short_help='shows the details of an SDN controller')
@click.argument('name')
@click.pass_context
def sdnc_show(ctx, name):
@@ -2296,12 +2533,13 @@
NAME: name or ID of the SDN controller
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.sdnc.get(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.sdnc.get(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['key', 'attribute'])
for k, v in list(resp.items()):
@@ -2314,7 +2552,7 @@
# K8s cluster operations
###########################
-@cli.command(name='k8scluster-add')
+@cli_osm.command(name='k8scluster-add')
@click.argument('name')
@click.option('--creds',
prompt=True,
@@ -2342,8 +2580,7 @@
# help='If set, K8s cluster is assumed to be ready for its use with OSM')
#@click.option('--wait',
# is_flag=True,
-# help='do not return the control immediately, but keep it \
-# until the operation is completed, or timeout')
+# help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def k8scluster_add(ctx,
name,
@@ -2358,25 +2595,25 @@
NAME: name of the K8s cluster
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- cluster = {}
- cluster['name'] = name
- with open(creds, 'r') as cf:
- cluster['credentials'] = yaml.safe_load(cf.read())
- cluster['k8s_version'] = version
- cluster['vim_account'] = vim
- cluster['nets'] = yaml.safe_load(k8s_nets)
- cluster['description'] = description
- if namespace: cluster['namespace'] = namespace
- if cni: cluster['cni'] = yaml.safe_load(cni)
- ctx.obj.k8scluster.create(name, cluster)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ cluster = {}
+ cluster['name'] = name
+ with open(creds, 'r') as cf:
+ cluster['credentials'] = yaml.safe_load(cf.read())
+ cluster['k8s_version'] = version
+ cluster['vim_account'] = vim
+ cluster['nets'] = yaml.safe_load(k8s_nets)
+ cluster['description'] = description
+ if namespace: cluster['namespace'] = namespace
+ if cni: cluster['cni'] = yaml.safe_load(cni)
+ ctx.obj.k8scluster.create(name, cluster)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='k8scluster-update', short_help='updates a K8s cluster')
+@cli_osm.command(name='k8scluster-update', short_help='updates a K8s cluster')
@click.argument('name')
@click.option('--newname', help='New name for the K8s cluster')
@click.option('--creds', help='credentials file, i.e. a valid `.kube/config` file')
@@ -2401,47 +2638,46 @@
NAME: name or ID of the K8s cluster
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- cluster = {}
- if newname: cluster['name'] = newname
- if creds:
- with open(creds, 'r') as cf:
- cluster['credentials'] = yaml.safe_load(cf.read())
- if version: cluster['k8s_version'] = version
- if vim: cluster['vim_account'] = vim
- if k8s_nets: cluster['nets'] = yaml.safe_load(k8s_nets)
- if description: cluster['description'] = description
- if namespace: cluster['namespace'] = namespace
- if cni: cluster['cni'] = yaml.safe_load(cni)
- ctx.obj.k8scluster.update(name, cluster)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ cluster = {}
+ if newname: cluster['name'] = newname
+ if creds:
+ with open(creds, 'r') as cf:
+ cluster['credentials'] = yaml.safe_load(cf.read())
+ if version: cluster['k8s_version'] = version
+ if vim: cluster['vim_account'] = vim
+ if k8s_nets: cluster['nets'] = yaml.safe_load(k8s_nets)
+ if description: cluster['description'] = description
+ if namespace: cluster['namespace'] = namespace
+ if cni: cluster['cni'] = yaml.safe_load(cni)
+ ctx.obj.k8scluster.update(name, cluster)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='k8scluster-delete')
+@cli_osm.command(name='k8scluster-delete')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)')
#@click.option('--wait',
# is_flag=True,
-# help='do not return the control immediately, but keep it \
-# until the operation is completed, or timeout')
+# help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def k8scluster_delete(ctx, name, force):
"""deletes a K8s cluster
NAME: name or ID of the K8s cluster to be deleted
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.k8scluster.delete(name, force=force)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.k8scluster.delete(name, force=force)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='k8scluster-list')
+@cli_osm.command(name='k8scluster-list')
@click.option('--filter', default=None,
help='restricts the list to the K8s clusters matching the filter')
@click.option('--literal', is_flag=True,
@@ -2449,25 +2685,25 @@
@click.pass_context
def k8scluster_list(ctx, filter, literal):
"""list all K8s clusters"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.k8scluster.list(filter)
- if literal:
- print(yaml.safe_dump(resp))
- return
- table = PrettyTable(['Name', 'Id', 'Version', 'VIM', 'K8s-nets', 'Description'])
- for cluster in resp:
- table.add_row([cluster['name'], cluster['_id'], cluster['k8s_version'], cluster['vim_account'],
- json.dumps(cluster['nets']), trunc_text(cluster.get('description',''),40)
- ])
- table.align = 'l'
- print(table)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.k8scluster.list(filter)
+ if literal:
+ print(yaml.safe_dump(resp))
+ return
+ table = PrettyTable(['Name', 'Id', 'Version', 'VIM', 'K8s-nets', 'Operational State', 'Description'])
+ for cluster in resp:
+ table.add_row([cluster['name'], cluster['_id'], cluster['k8s_version'], cluster['vim_account'],
+ json.dumps(cluster['nets']), cluster["_admin"]["operationalState"],
+ trunc_text(cluster.get('description',''),40)])
+ table.align = 'l'
+ print(table)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='k8scluster-show')
+@cli_osm.command(name='k8scluster-show')
@click.argument('name')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@@ -2477,19 +2713,19 @@
NAME: name or ID of the K8s cluster
"""
- try:
- resp = ctx.obj.k8scluster.get(name)
- if literal:
- print(yaml.safe_dump(resp))
- return
- table = PrettyTable(['key', 'attribute'])
- for k, v in list(resp.items()):
- table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)])
- table.align = 'l'
- print(table)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ resp = ctx.obj.k8scluster.get(name)
+ if literal:
+ print(yaml.safe_dump(resp))
+ return
+ table = PrettyTable(['key', 'attribute'])
+ for k, v in list(resp.items()):
+ table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)])
+ table.align = 'l'
+ print(table)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
@@ -2497,7 +2733,7 @@
# Repo operations
###########################
-@cli.command(name='repo-add')
+@cli_osm.command(name='repo-add')
@click.argument('name')
@click.argument('uri')
@click.option('--type',
@@ -2509,8 +2745,7 @@
help='human readable description')
#@click.option('--wait',
# is_flag=True,
-# help='do not return the control immediately, but keep it \
-# until the operation is completed, or timeout')
+# help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def repo_add(ctx,
name,
@@ -2522,20 +2757,20 @@
NAME: name of the repo
URI: URI of the repo
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- repo = {}
- repo['name'] = name
- repo['url'] = uri
- repo['type'] = type
- repo['description'] = description
- ctx.obj.repo.create(name, repo)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ repo = {}
+ repo['name'] = name
+ repo['url'] = uri
+ repo['type'] = type
+ repo['description'] = description
+ ctx.obj.repo.create(name, repo)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='repo-update')
+@cli_osm.command(name='repo-update')
@click.argument('name')
@click.option('--newname', help='New name for the repo')
@click.option('--uri', help='URI of the repo')
@@ -2544,8 +2779,7 @@
@click.option('--description', help='human readable description')
#@click.option('--wait',
# is_flag=True,
-# help='do not return the control immediately, but keep it \
-# until the operation is completed, or timeout')
+# help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def repo_update(ctx,
name,
@@ -2557,41 +2791,40 @@
NAME: name of the repo
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- repo = {}
- if newname: repo['name'] = newname
- if uri: repo['uri'] = uri
- if type: repo['type'] = type
- if description: repo['description'] = description
- ctx.obj.repo.update(name, repo)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ repo = {}
+ if newname: repo['name'] = newname
+ if uri: repo['uri'] = uri
+ if type: repo['type'] = type
+ if description: repo['description'] = description
+ ctx.obj.repo.update(name, repo)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='repo-delete')
+@cli_osm.command(name='repo-delete')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)')
#@click.option('--wait',
# is_flag=True,
-# help='do not return the control immediately, but keep it \
-# until the operation is completed, or timeout')
+# help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def repo_delete(ctx, name, force):
"""deletes a repo
NAME: name or ID of the repo to be deleted
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.repo.delete(name, force=force)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.repo.delete(name, force=force)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='repo-list')
+@cli_osm.command(name='repo-list')
@click.option('--filter', default=None,
help='restricts the list to the repos matching the filter')
@click.option('--literal', is_flag=True,
@@ -2599,24 +2832,24 @@
@click.pass_context
def repo_list(ctx, filter, literal):
"""list all repos"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.repo.list(filter)
- if literal:
- print(yaml.safe_dump(resp))
- return
- table = PrettyTable(['Name', 'Id', 'Type', 'URI', 'Description'])
- for repo in resp:
- #cluster['k8s-nets'] = json.dumps(yaml.safe_load(cluster['k8s-nets']))
- table.add_row([repo['name'], repo['_id'], repo['type'], repo['url'], trunc_text(repo.get('description',''),40)])
- table.align = 'l'
- print(table)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.repo.list(filter)
+ if literal:
+ print(yaml.safe_dump(resp))
+ return
+ table = PrettyTable(['Name', 'Id', 'Type', 'URI', 'Description'])
+ for repo in resp:
+ #cluster['k8s-nets'] = json.dumps(yaml.safe_load(cluster['k8s-nets']))
+ table.add_row([repo['name'], repo['_id'], repo['type'], repo['url'], trunc_text(repo.get('description',''),40)])
+ table.align = 'l'
+ print(table)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='repo-show')
+@cli_osm.command(name='repo-show')
@click.argument('name')
@click.option('--literal', is_flag=True,
help='print literally, no pretty table')
@@ -2626,19 +2859,19 @@
NAME: name or ID of the repo
"""
- try:
- resp = ctx.obj.repo.get(name)
- if literal:
- print(yaml.safe_dump(resp))
- return
- table = PrettyTable(['key', 'attribute'])
- for k, v in list(resp.items()):
- table.add_row([k, json.dumps(v, indent=2)])
- table.align = 'l'
- print(table)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ resp = ctx.obj.repo.get(name)
+ if literal:
+ print(yaml.safe_dump(resp))
+ return
+ table = PrettyTable(['key', 'attribute'])
+ for k, v in list(resp.items()):
+ table.add_row([k, json.dumps(v, indent=2)])
+ table.align = 'l'
+ print(table)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
@@ -2646,7 +2879,7 @@
# Project mgmt operations
####################
-@cli.command(name='project-create', short_help='creates a new project')
+@cli_osm.command(name='project-create', short_help='creates a new project')
@click.argument('name')
#@click.option('--description',
# default='no description',
@@ -2657,17 +2890,18 @@
NAME: name of the project
"""
+ logger.debug("")
project = {}
project['name'] = name
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.project.create(name, project)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.project.create(name, project)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='project-delete', short_help='deletes a project')
+@cli_osm.command(name='project-delete', short_help='deletes a project')
@click.argument('name')
#@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -2676,26 +2910,28 @@
NAME: name or ID of the project to be deleted
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.project.delete(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.project.delete(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='project-list', short_help='list all projects')
+@cli_osm.command(name='project-list', short_help='list all projects')
@click.option('--filter', default=None,
help='restricts the list to the projects matching the filter')
@click.pass_context
def project_list(ctx, filter):
"""list all projects"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.project.list(filter)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.project.list(filter)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['name', 'id'])
for proj in resp:
table.add_row([proj['name'], proj['_id']])
@@ -2703,7 +2939,7 @@
print(table)
-@cli.command(name='project-show', short_help='shows the details of a project')
+@cli_osm.command(name='project-show', short_help='shows the details of a project')
@click.argument('name')
@click.pass_context
def project_show(ctx, name):
@@ -2711,12 +2947,13 @@
NAME: name or ID of the project
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.project.get(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.project.get(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['key', 'attribute'])
for k, v in resp.items():
@@ -2725,7 +2962,7 @@
print(table)
-@cli.command(name='project-update', short_help='updates a project (only the name can be updated)')
+@cli_osm.command(name='project-update', short_help='updates a project (only the name can be updated)')
@click.argument('project')
@click.option('--name',
prompt=True,
@@ -2741,22 +2978,22 @@
:param name: new name for the project
:return:
"""
-
+ logger.debug("")
project_changes = {}
project_changes['name'] = name
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.project.update(project, project_changes)
- except ClientException as e:
- print(str(e))
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.project.update(project, project_changes)
+ # except ClientException as e:
+ # print(str(e))
####################
# User mgmt operations
####################
-@cli.command(name='user-create', short_help='creates a new user')
+@cli_osm.command(name='user-create', short_help='creates a new user')
@click.argument('username')
@click.option('--password',
prompt=True,
@@ -2781,21 +3018,22 @@
PROJECTS: projects assigned to user (internal only)
PROJECT_ROLE_MAPPING: roles in projects assigned to user (keystone)
"""
+ logger.debug("")
user = {}
user['username'] = username
user['password'] = password
user['projects'] = projects
user['project_role_mappings'] = project_role_mappings
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.user.create(username, user)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.user.create(username, user)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='user-update', short_help='updates user information')
+@cli_osm.command(name='user-update', short_help='updates user information')
@click.argument('username')
@click.option('--password',
# prompt=True,
@@ -2831,6 +3069,7 @@
ADD_PROJECT_ROLE: adding mappings for project/role(s)
REMOVE_PROJECT_ROLE: removing mappings for project/role(s)
"""
+ logger.debug("")
user = {}
user['password'] = password
user['username'] = set_username
@@ -2839,15 +3078,15 @@
user['add-project-role'] = add_project_role
user['remove-project-role'] = remove_project_role
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.user.update(username, user)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.user.update(username, user)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='user-delete', short_help='deletes a user')
+@cli_osm.command(name='user-delete', short_help='deletes a user')
@click.argument('name')
#@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -2857,26 +3096,27 @@
\b
NAME: name or ID of the user to be deleted
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.user.delete(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.user.delete(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='user-list', short_help='list all users')
+@cli_osm.command(name='user-list', short_help='list all users')
@click.option('--filter', default=None,
help='restricts the list to the users matching the filter')
@click.pass_context
def user_list(ctx, filter):
"""list all users"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.user.list(filter)
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.user.list(filter)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['name', 'id'])
for user in resp:
table.add_row([user['username'], user['_id']])
@@ -2884,7 +3124,7 @@
print(table)
-@cli.command(name='user-show', short_help='shows the details of a user')
+@cli_osm.command(name='user-show', short_help='shows the details of a user')
@click.argument('name')
@click.pass_context
def user_show(ctx, name):
@@ -2892,14 +3132,15 @@
NAME: name or ID of the user
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.user.get(name)
- if 'password' in resp:
- resp['password']='********'
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.user.get(name)
+ if 'password' in resp:
+ resp['password']='********'
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['key', 'attribute'])
for k, v in resp.items():
@@ -2912,7 +3153,7 @@
# Fault Management operations
####################
-@cli.command(name='ns-alarm-create')
+@cli_osm.command(name='ns-alarm-create')
@click.argument('name')
@click.option('--ns', prompt=True, help='NS instance id or name')
@click.option('--vnf', prompt=True,
@@ -2935,27 +3176,28 @@
"""creates a new alarm for a NS instance"""
# TODO: Check how to validate threshold_value.
# Should it be an integer (1-100), percentage, or decimal (0.01-1.00)?
- try:
- ns_instance = ctx.obj.ns.get(ns)
- alarm = {}
- alarm['alarm_name'] = name
- alarm['ns_id'] = ns_instance['_id']
- alarm['correlation_id'] = ns_instance['_id']
- alarm['vnf_member_index'] = vnf
- alarm['vdu_name'] = vdu
- alarm['metric_name'] = metric
- alarm['severity'] = severity
- alarm['threshold_value'] = int(threshold_value)
- alarm['operation'] = threshold_operator
- alarm['statistic'] = statistic
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.ns.create_alarm(alarm)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ ns_instance = ctx.obj.ns.get(ns)
+ alarm = {}
+ alarm['alarm_name'] = name
+ alarm['ns_id'] = ns_instance['_id']
+ alarm['correlation_id'] = ns_instance['_id']
+ alarm['vnf_member_index'] = vnf
+ alarm['vdu_name'] = vdu
+ alarm['metric_name'] = metric
+ alarm['severity'] = severity
+ alarm['threshold_value'] = int(threshold_value)
+ alarm['operation'] = threshold_operator
+ alarm['statistic'] = statistic
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.ns.create_alarm(alarm)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-#@cli.command(name='ns-alarm-delete')
+#@cli_osm.command(name='ns-alarm-delete')
#@click.argument('name')
#@click.pass_context
#def ns_alarm_delete(ctx, name):
@@ -2975,7 +3217,7 @@
# Performance Management operations
####################
-@cli.command(name='ns-metric-export', short_help='exports a metric to the internal OSM bus, which can be read by other apps')
+@cli_osm.command(name='ns-metric-export', short_help='exports a metric to the internal OSM bus, which can be read by other apps')
@click.option('--ns', prompt=True, help='NS instance id or name')
@click.option('--vnf', prompt=True,
help='VNF name (VNF member index as declared in the NSD)')
@@ -2991,46 +3233,47 @@
"""exports a metric to the internal OSM bus, which can be read by other apps"""
# TODO: Check how to validate interval.
# Should it be an integer (seconds), or should a suffix (s,m,h,d,w) also be permitted?
- try:
- ns_instance = ctx.obj.ns.get(ns)
- metric_data = {}
- metric_data['ns_id'] = ns_instance['_id']
- metric_data['correlation_id'] = ns_instance['_id']
- metric_data['vnf_member_index'] = vnf
- metric_data['vdu_name'] = vdu
- metric_data['metric_name'] = metric
- metric_data['collection_unit'] = 'WEEK'
- metric_data['collection_period'] = 1
- check_client_version(ctx.obj, ctx.command.name)
- if not interval:
- print('{}'.format(ctx.obj.ns.export_metric(metric_data)))
- else:
- i = 1
- while True:
- print('{} {}'.format(ctx.obj.ns.export_metric(metric_data),i))
- time.sleep(int(interval))
- i+=1
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ ns_instance = ctx.obj.ns.get(ns)
+ metric_data = {}
+ metric_data['ns_id'] = ns_instance['_id']
+ metric_data['correlation_id'] = ns_instance['_id']
+ metric_data['vnf_member_index'] = vnf
+ metric_data['vdu_name'] = vdu
+ metric_data['metric_name'] = metric
+ metric_data['collection_unit'] = 'WEEK'
+ metric_data['collection_period'] = 1
+ check_client_version(ctx.obj, ctx.command.name)
+ if not interval:
+ print('{}'.format(ctx.obj.ns.export_metric(metric_data)))
+ else:
+ i = 1
+ while True:
+ print('{} {}'.format(ctx.obj.ns.export_metric(metric_data),i))
+ time.sleep(int(interval))
+ i+=1
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
####################
# Other operations
####################
-@cli.command(name='version')
+@cli_osm.command(name='version')
@click.pass_context
def get_version(ctx):
- try:
- check_client_version(ctx.obj, "version")
- print ("Server version: {}".format(ctx.obj.get_version()))
- print ("Client version: {}".format(pkg_resources.get_distribution("osmclient").version))
- except ClientException as e:
- print(str(e))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, "version")
+ print ("Server version: {}".format(ctx.obj.get_version()))
+ print ("Client version: {}".format(pkg_resources.get_distribution("osmclient").version))
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='upload-package', short_help='uploads a VNF package or NS package')
+@cli_osm.command(name='upload-package', short_help='uploads a VNF package or NS package')
@click.argument('filename')
@click.pass_context
def upload_package(ctx, filename):
@@ -3038,17 +3281,18 @@
FILENAME: VNF or NS package file (tar.gz)
"""
- try:
- ctx.obj.package.upload(filename)
- fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
- if fullclassname != 'osmclient.sol005.client.Client':
- ctx.obj.package.wait_for_upload(filename)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ ctx.obj.package.upload(filename)
+ fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
+ if fullclassname != 'osmclient.sol005.client.Client':
+ ctx.obj.package.wait_for_upload(filename)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-#@cli.command(name='ns-scaling-show')
+#@cli_osm.command(name='ns-scaling-show')
#@click.argument('ns_name')
#@click.pass_context
#def show_ns_scaling(ctx, ns_name):
@@ -3090,7 +3334,7 @@
# print(table)
-#@cli.command(name='ns-scale')
+#@cli_osm.command(name='ns-scale')
#@click.argument('ns_name')
#@click.option('--ns_scale_group', prompt=True)
#@click.option('--index', prompt=True)
@@ -3114,7 +3358,7 @@
# exit(1)
-#@cli.command(name='config-agent-list')
+#@cli_osm.command(name='config-agent-list')
#@click.pass_context
#def config_agent_list(ctx):
# """list config agents"""
@@ -3133,7 +3377,7 @@
# print(table)
-#@cli.command(name='config-agent-delete')
+#@cli_osm.command(name='config-agent-delete')
#@click.argument('name')
#@click.pass_context
#def config_agent_delete(ctx, name):
@@ -3149,7 +3393,7 @@
# exit(1)
-#@cli.command(name='config-agent-add')
+#@cli_osm.command(name='config-agent-add')
#@click.option('--name',
# prompt=True)
#@click.option('--account_type',
@@ -3173,7 +3417,7 @@
# exit(1)
-#@cli.command(name='ro-dump')
+#@cli_osm.command(name='ro-dump')
#@click.pass_context
#def ro_dump(ctx):
# """shows RO agent information"""
@@ -3186,7 +3430,7 @@
# print(table)
-#@cli.command(name='vcs-list')
+#@cli_osm.command(name='vcs-list')
#@click.pass_context
#def vcs_list(ctx):
# check_client_version(ctx.obj, ctx.command.name, 'v1')
@@ -3198,7 +3442,7 @@
# print(table)
-@cli.command(name='ns-action', short_help='executes an action/primitive over a NS instance')
+@cli_osm.command(name='ns-action', short_help='executes an action/primitive over a NS instance')
@click.argument('ns_name')
@click.option('--vnf_name', default=None, help='member-vnf-index if the target is a vnf instead of a ns)')
@click.option('--kdu_name', default=None, help='kdu-name if the target is a kdu)')
@@ -3211,8 +3455,7 @@
required=False,
default=False,
is_flag=True,
- help='do not return the control immediately, but keep it \
- until the operation is completed, or timeout')
+ help='do not return the control immediately, but keep it until the operation is completed, or timeout')
@click.pass_context
def ns_action(ctx,
ns_name,
@@ -3228,33 +3471,34 @@
NS_NAME: name or ID of the NS instance
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- op_data = {}
- if vnf_name:
- op_data['member_vnf_index'] = vnf_name
- if kdu_name:
- op_data['kdu_name'] = kdu_name
- if vdu_id:
- op_data['vdu_id'] = vdu_id
- if vdu_count:
- op_data['vdu_count_index'] = vdu_count
- op_data['primitive'] = action_name
- if params_file:
- with open(params_file, 'r') as pf:
- params = pf.read()
- if params:
- op_data['primitive_params'] = yaml.safe_load(params)
- else:
- op_data['primitive_params'] = {}
- print(ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data, wait=wait))
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ op_data = {}
+ if vnf_name:
+ op_data['member_vnf_index'] = vnf_name
+ if kdu_name:
+ op_data['kdu_name'] = kdu_name
+ if vdu_id:
+ op_data['vdu_id'] = vdu_id
+ if vdu_count:
+ op_data['vdu_count_index'] = vdu_count
+ op_data['primitive'] = action_name
+ if params_file:
+ with open(params_file, 'r') as pf:
+ params = pf.read()
+ if params:
+ op_data['primitive_params'] = yaml.safe_load(params)
+ else:
+ op_data['primitive_params'] = {}
+ print(ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data, wait=wait))
- except ClientException as e:
- print(str(e))
- exit(1)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='vnf-scale', short_help='executes a VNF scale (adding/removing VDUs)')
+@cli_osm.command(name='vnf-scale', short_help='executes a VNF scale (adding/removing VDUs)')
@click.argument('ns_name')
@click.argument('vnf_name')
@click.option('--scaling-group', prompt=True, help="scaling-group-descriptor name to use")
@@ -3274,21 +3518,22 @@
NS_NAME: name or ID of the NS instance.
VNF_NAME: member-vnf-index in the NS to be scaled.
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- if not scale_in and not scale_out:
- scale_out = True
- ctx.obj.ns.scale_vnf(ns_name, vnf_name, scaling_group, scale_in, scale_out)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ if not scale_in and not scale_out:
+ scale_out = True
+ ctx.obj.ns.scale_vnf(ns_name, vnf_name, scaling_group, scale_in, scale_out)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
##############################
# Role Management Operations #
##############################
-@cli.command(name='role-create', short_help='creates a new role')
+@cli_osm.command(name='role-create', short_help='creates a new role')
@click.argument('name')
@click.option('--permissions',
default=None,
@@ -3302,15 +3547,16 @@
NAME: Name or ID of the role.
DEFINITION: Definition of grant/denial of access to resources.
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.role.create(name, permissions)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.role.create(name, permissions)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='role-update', short_help='updates a role')
+@cli_osm.command(name='role-update', short_help='updates a role')
@click.argument('name')
@click.option('--set-name',
default=None,
@@ -3335,15 +3581,16 @@
ADD: Grant/denial of access to resource to add.
REMOVE: Grant/denial of access to resource to remove.
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.role.update(name, set_name, None, add, remove)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.role.update(name, set_name, None, add, remove)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='role-delete', short_help='deletes a role')
+@cli_osm.command(name='role-delete', short_help='deletes a role')
@click.argument('name')
# @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
@@ -3354,15 +3601,16 @@
\b
NAME: Name or ID of the role.
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.role.delete(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.role.delete(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
-@cli.command(name='role-list', short_help='list all roles')
+@cli_osm.command(name='role-list', short_help='list all roles')
@click.option('--filter', default=None,
help='restricts the list to the projects matching the filter')
@click.pass_context
@@ -3370,12 +3618,13 @@
"""
List all roles.
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.role.list(filter)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.role.list(filter)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['name', 'id'])
for role in resp:
table.add_row([role['name'], role['_id']])
@@ -3383,7 +3632,7 @@
print(table)
-@cli.command(name='role-show', short_help='show specific role')
+@cli_osm.command(name='role-show', short_help='show specific role')
@click.argument('name')
@click.pass_context
def role_show(ctx, name):
@@ -3393,12 +3642,13 @@
\b
NAME: Name or ID of the role.
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- resp = ctx.obj.role.get(name)
- except ClientException as e:
- print(str(e))
- exit(1)
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.role.get(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
table = PrettyTable(['key', 'attribute'])
for k, v in resp.items():
@@ -3407,7 +3657,7 @@
print(table)
-@cli.command(name='package-create',
+@cli_osm.command(name='package-create',
short_help='Create a package descriptor')
@click.argument('package-type')
@click.argument('package-name')
@@ -3473,29 +3723,29 @@
PACKAGE_NAME: Name of the package to create the folder with the content.
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- print("Creating the {} structure: {}/{}".format(package_type.upper(), base_directory, package_name))
- resp = ctx.obj.package_tool.create(package_type,
- base_directory,
- package_name,
- override=override,
- image=image,
- vdus=vdus,
- vcpu=vcpu,
- memory=memory,
- storage=storage,
- interfaces=interfaces,
- vendor=vendor,
- detailed=detailed,
- netslice_subnets=netslice_subnets,
- netslice_vlds=netslice_vlds)
- print(resp)
- except ClientException as inst:
- print("ERROR: {}".format(inst))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ print("Creating the {} structure: {}/{}".format(package_type.upper(), base_directory, package_name))
+ resp = ctx.obj.package_tool.create(package_type,
+ base_directory,
+ package_name,
+ override=override,
+ image=image,
+ vdus=vdus,
+ vcpu=vcpu,
+ memory=memory,
+ storage=storage,
+ interfaces=interfaces,
+ vendor=vendor,
+ detailed=detailed,
+ netslice_subnets=netslice_subnets,
+ netslice_vlds=netslice_vlds)
+ print(resp)
+ # except ClientException as inst:
+ # print("ERROR: {}".format(inst))
+ # exit(1)
-@cli.command(name='package-validate',
+@cli_osm.command(name='package-validate',
short_help='Validate a package descriptor')
@click.argument('base-directory',
default=".",
@@ -3509,24 +3759,24 @@
\b
BASE_DIRECTORY: Stub folder for NS, VNF or NST package.
"""
- try:
- check_client_version(ctx.obj, ctx.command.name)
- results = ctx.obj.package_tool.validate(base_directory)
- table = PrettyTable()
- table.field_names = ["TYPE", "PATH", "VALID", "ERROR"]
- # Print the dictionary generated by the validation function
- for result in results:
- table.add_row([result["type"], result["path"], result["valid"], result["error"]])
- table.sortby = "VALID"
- table.align["PATH"] = "l"
- table.align["TYPE"] = "l"
- table.align["ERROR"] = "l"
- print(table)
- except ClientException as inst:
- print("ERROR: {}".format(inst))
- exit(1)
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ results = ctx.obj.package_tool.validate(base_directory)
+ table = PrettyTable()
+ table.field_names = ["TYPE", "PATH", "VALID", "ERROR"]
+ # Print the dictionary generated by the validation function
+ for result in results:
+ table.add_row([result["type"], result["path"], result["valid"], result["error"]])
+ table.sortby = "VALID"
+ table.align["PATH"] = "l"
+ table.align["TYPE"] = "l"
+ table.align["ERROR"] = "l"
+ print(table)
+ # except ClientException as inst:
+ # print("ERROR: {}".format(inst))
+ # exit(1)
-@cli.command(name='package-build',
+@cli_osm.command(name='package-build',
short_help='Build the tar.gz of the package')
@click.argument('package-folder')
@click.option('--skip-validation',
@@ -3543,20 +3793,29 @@
\b
PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged
"""
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ results = ctx.obj.package_tool.build(package_folder, skip_validation)
+ print(results)
+ # except ClientException as inst:
+ # print("ERROR: {}".format(inst))
+ # exit(1)
+
+
+def cli():
try:
- check_client_version(ctx.obj, ctx.command.name)
- results = ctx.obj.package_tool.build(package_folder, skip_validation)
- print(results)
- except ClientException as inst:
- print("ERROR: {}".format(inst))
+ cli_osm()
+ except pycurl.error as exc:
+ print(exc)
+ print('Maybe "--hostname" option or OSM_HOSTNAME environment variable needs to be specified')
exit(1)
+ except ClientException as exc:
+ print("ERROR: {}".format(exc))
+ exit(1)
+ # TODO capture other controlled exceptions here
+ # TODO remove the ClientException captures from all places, unless they do something different
if __name__ == '__main__':
- try:
- cli()
- except pycurl.error as e:
- print(e)
- print('Maybe "--hostname" option or OSM_HOSTNAME' +
- 'environment variable needs to be specified')
- exit(1)
+ cli()
+
diff --git a/osmclient/sol005/client.py b/osmclient/sol005/client.py
index 2de6a4c..bf6f845 100644
--- a/osmclient/sol005/client.py
+++ b/osmclient/sol005/client.py
@@ -39,6 +39,7 @@
from osmclient.common.exceptions import ClientException
from osmclient.common import package_tool
import json
+import logging
class Client(object):
@@ -55,6 +56,7 @@
self._user = user
self._password = password
self._project = project
+ self._logger = logging.getLogger('osmclient')
self._auth_endpoint = '/admin/v1/tokens'
self._headers = {}
self._token = None
@@ -98,6 +100,7 @@
'''
def get_token(self):
+ self._logger.debug("")
if self._token is None:
postfields_dict = {'username': self._user,
'password': self._password,
diff --git a/osmclient/sol005/http.py b/osmclient/sol005/http.py
index f19a098..aca8a4b 100644
--- a/osmclient/sol005/http.py
+++ b/osmclient/sol005/http.py
@@ -17,8 +17,11 @@
from io import BytesIO
import pycurl
import json
+import logging
+import copy
from osmclient.common import http
+
class Http(http.Http):
def __init__(self, url, user='admin', password='admin'):
@@ -26,10 +29,13 @@
self._user = user
self._password = password
self._http_header = None
+ self._logger = logging.getLogger('osmclient')
def _get_curl_cmd(self, endpoint):
+ self._logger.debug("")
curl_cmd = pycurl.Curl()
- #print(self._url + endpoint)
+ if self._logger.getEffectiveLevel() == logging.DEBUG:
+ curl_cmd.setopt(pycurl.VERBOSE, True)
curl_cmd.setopt(pycurl.URL, self._url + endpoint)
curl_cmd.setopt(pycurl.SSL_VERIFYPEER, 0)
curl_cmd.setopt(pycurl.SSL_VERIFYHOST, 0)
@@ -38,16 +44,19 @@
return curl_cmd
def delete_cmd(self, endpoint):
+ self._logger.debug("")
data = BytesIO()
curl_cmd = self._get_curl_cmd(endpoint)
curl_cmd.setopt(pycurl.CUSTOMREQUEST, "DELETE")
curl_cmd.setopt(pycurl.WRITEFUNCTION, data.write)
+ self._logger.info("Request METHOD: {} URL: {}".format("DELETE",self._url + endpoint))
curl_cmd.perform()
http_code = curl_cmd.getinfo(pycurl.HTTP_CODE)
- #print('HTTP_CODE: {}'.format(http_code))
+ self._logger.info("Response HTTPCODE: {}".format(http_code))
curl_cmd.close()
# TODO 202 accepted should be returned somehow
if data.getvalue():
+ self._logger.verbose("Response DATA: {}".format(json.loads(data.getvalue().decode())))
return http_code, data.getvalue().decode()
else:
return http_code, None
@@ -55,6 +64,7 @@
def send_cmd(self, endpoint='', postfields_dict=None,
formfile=None, filename=None,
put_method=False, patch_method=False):
+ self._logger.debug("")
data = BytesIO()
curl_cmd = self._get_curl_cmd(endpoint)
if put_method:
@@ -66,6 +76,13 @@
if postfields_dict is not None:
jsondata = json.dumps(postfields_dict)
+ if 'password' in postfields_dict:
+ postfields_dict_copy = copy.deepcopy(postfields_dict)
+ postfields_dict_copy['password']='******'
+ jsondata_log = json.dumps(postfields_dict_copy)
+ else:
+ jsondata_log = jsondata
+ self._logger.verbose("Request POSTFIELDS: {}".format(jsondata_log))
curl_cmd.setopt(pycurl.POSTFIELDS, jsondata)
elif formfile is not None:
curl_cmd.setopt(
@@ -76,18 +93,28 @@
elif filename is not None:
with open(filename, 'rb') as stream:
postdata=stream.read()
+ self._logger.verbose("Request POSTFIELDS: Binary content")
curl_cmd.setopt(pycurl.POSTFIELDS, postdata)
+ if put_method:
+ self._logger.info("Request METHOD: {} URL: {}".format("PUT",self._url + endpoint))
+ elif patch_method:
+ self._logger.info("Request METHOD: {} URL: {}".format("PATCH",self._url + endpoint))
+ else:
+ self._logger.info("Request METHOD: {} URL: {}".format("POST",self._url + endpoint))
curl_cmd.perform()
http_code = curl_cmd.getinfo(pycurl.HTTP_CODE)
+ self._logger.info("Response HTTPCODE: {}".format(http_code))
curl_cmd.close()
if data.getvalue():
+ self._logger.verbose("Response DATA: {}".format(json.loads(data.getvalue().decode())))
return http_code, data.getvalue().decode()
else:
return http_code, None
def post_cmd(self, endpoint='', postfields_dict=None,
formfile=None, filename=None):
+ self._logger.debug("")
return self.send_cmd(endpoint=endpoint,
postfields_dict=postfields_dict,
formfile=formfile,
@@ -96,6 +123,7 @@
def put_cmd(self, endpoint='', postfields_dict=None,
formfile=None, filename=None):
+ self._logger.debug("")
return self.send_cmd(endpoint=endpoint,
postfields_dict=postfields_dict,
formfile=formfile,
@@ -104,6 +132,7 @@
def patch_cmd(self, endpoint='', postfields_dict=None,
formfile=None, filename=None):
+ self._logger.debug("")
return self.send_cmd(endpoint=endpoint,
postfields_dict=postfields_dict,
formfile=formfile,
@@ -111,14 +140,18 @@
put_method=False, patch_method=True)
def get2_cmd(self, endpoint):
+ self._logger.debug("")
data = BytesIO()
curl_cmd = self._get_curl_cmd(endpoint)
curl_cmd.setopt(pycurl.HTTPGET, 1)
curl_cmd.setopt(pycurl.WRITEFUNCTION, data.write)
+ self._logger.info("Request METHOD: {} URL: {}".format("GET",self._url + endpoint))
curl_cmd.perform()
http_code = curl_cmd.getinfo(pycurl.HTTP_CODE)
+ self._logger.info("Response HTTPCODE: {}".format(http_code))
curl_cmd.close()
if data.getvalue():
+ self._logger.debug("Response DATA: {}".format(json.loads(data.getvalue().decode())))
return http_code, data.getvalue().decode()
return http_code, None
diff --git a/osmclient/sol005/ns.py b/osmclient/sol005/ns.py
index e9858f4..12c5416 100644
--- a/osmclient/sol005/ns.py
+++ b/osmclient/sol005/ns.py
@@ -24,6 +24,7 @@
from osmclient.common.exceptions import NotFound
import yaml
import json
+import logging
class Ns(object):
@@ -31,6 +32,7 @@
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/nslcm'
self._apiVersion = '/v1'
self._apiResource = '/ns_instances_content'
@@ -39,6 +41,7 @@
# NS '--wait' option
def _wait(self, id, deleteFlag=False):
+ self._logger.debug("")
# Endpoint to get operation status
apiUrlStatus = '{}{}{}'.format(self._apiName, self._apiVersion, '/ns_lcm_op_occs')
# Wait for status for NS instance creation/update/deletion
@@ -53,6 +56,7 @@
def list(self, filter=None):
"""Returns a list of NS
"""
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -65,6 +69,7 @@
def get(self, name):
"""Returns an NS based on name or id
"""
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for ns in self.list():
@@ -77,6 +82,7 @@
raise NotFound("ns {} not found".format(name))
def get_individual(self, name):
+ self._logger.debug("")
self._client.get_token()
ns_id = name
if not utils.validate_uuid4(name):
@@ -92,6 +98,7 @@
raise NotFound("ns {} not found".format(name))
def delete(self, name, force=False, wait=False):
+ self._logger.debug("")
ns = self.get(name)
querystring = ''
if force:
@@ -121,6 +128,7 @@
def create(self, nsd_name, nsr_name, account, config=None,
ssh_keys=None, description='default description',
admin_status='ENABLED', wait=False):
+ self._logger.debug("")
self._client.get_token()
nsd = self._client.nsd.get(nsd_name)
@@ -128,6 +136,7 @@
wim_account_id = {}
def get_vim_account_id(vim_account):
+ self._logger.debug("")
if vim_account_id.get(vim_account):
return vim_account_id[vim_account]
@@ -138,6 +147,7 @@
return vim['_id']
def get_wim_account_id(wim_account):
+ self._logger.debug("")
if not isinstance(wim_account, str):
return wim_account
if wim_account_id.get(wim_account):
@@ -202,6 +212,8 @@
wim_account = ns_config.pop("wim_account")
if wim_account is not None:
ns['wimAccountId'] = get_wim_account_id(wim_account)
+ if "timeout_ns_deploy" in ns_config:
+ ns["timeout_ns_deploy"] = ns_config.pop("timeout_ns_deploy")
# print(yaml.safe_dump(ns))
try:
@@ -245,6 +257,7 @@
def list_op(self, name, filter=None):
"""Returns the list of operations of a NS
"""
+ self._logger.debug("")
ns = self.get(name)
try:
self._apiResource = '/ns_lcm_op_occs'
@@ -282,6 +295,7 @@
def get_op(self, operationId):
"""Returns the status of an operation
"""
+ self._logger.debug("")
self._client.get_token()
try:
self._apiResource = '/ns_lcm_op_occs'
@@ -314,6 +328,8 @@
def exec_op(self, name, op_name, op_data=None, wait=False, ):
"""Executes an operation on a NS
"""
+ self._logger.debug("")
+ ns = self.get(name)
try:
ns = self.get(name)
self._apiResource = '/ns_instances'
@@ -353,6 +369,7 @@
def scale_vnf(self, ns_name, vnf_name, scaling_group, scale_in, scale_out, wait=False):
"""Scales a VNF by adding/removing VDUs
"""
+ self._logger.debug("")
self._client.get_token()
try:
op_data={}
@@ -374,6 +391,7 @@
raise ClientException(message)
def create_alarm(self, alarm):
+ self._logger.debug("")
self._client.get_token()
data = {}
data["create_alarm_request"] = {}
@@ -402,6 +420,7 @@
raise ClientException(message)
def delete_alarm(self, name):
+ self._logger.debug("")
self._client.get_token()
data = {}
data["delete_alarm_request"] = {}
@@ -431,6 +450,7 @@
raise ClientException(message)
def export_metric(self, metric):
+ self._logger.debug("")
self._client.get_token()
data = {}
data["read_metric_data_request"] = metric
@@ -458,6 +478,7 @@
raise ClientException(message)
def get_field(self, ns_name, field):
+ self._logger.debug("")
nsr = self.get(ns_name)
print(yaml.safe_dump(nsr))
if nsr is None:
@@ -467,3 +488,4 @@
return nsr[field]
raise NotFound("failed to find {} in ns {}".format(field, ns_name))
+
diff --git a/osmclient/sol005/nsd.py b/osmclient/sol005/nsd.py
index 9adc8f7..bf91ca6 100644
--- a/osmclient/sol005/nsd.py
+++ b/osmclient/sol005/nsd.py
@@ -24,6 +24,7 @@
import json
import magic
from os.path import basename
+import logging
#from os import stat
@@ -32,6 +33,7 @@
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/nsd'
self._apiVersion = '/v1'
self._apiResource = '/ns_descriptors'
@@ -40,6 +42,7 @@
#self._apiBase='/nsds'
def list(self, filter=None):
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -51,6 +54,7 @@
return list()
def get(self, name):
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for nsd in self.list():
@@ -63,7 +67,8 @@
raise NotFound("nsd {} not found".format(name))
def get_individual(self, name):
- # Called to get_token not required, because will be implicitly called by get.
+ self._logger.debug("")
+ # Call to get_token not required, because will be implicitly called by get.
nsd = self.get(name)
# It is redundant, since the previous one already gets the whole nsdinfo
# The only difference is that a different primitive is exercised
@@ -74,6 +79,8 @@
raise NotFound("nsd {} not found".format(name))
def get_thing(self, name, thing, filename):
+ self._logger.debug("")
+ # Call to get_token not required, because will be implicitly called by get.
nsd = self.get(name)
headers = self._client._headers
headers['Accept'] = 'application/binary'
@@ -94,15 +101,19 @@
raise ClientException("failed to get {} from {} - {}".format(thing, name, msg))
def get_descriptor(self, name, filename):
+ self._logger.debug("")
self.get_thing(name, 'nsd', filename)
def get_package(self, name, filename):
+ self._logger.debug("")
self.get_thing(name, 'package_content', filename)
def get_artifact(self, name, artifact, filename):
+ self._logger.debug("")
self.get_thing(name, 'artifacts/{}'.format(artifact), filename)
def delete(self, name, force=False):
+ self._logger.debug("")
nsd = self.get(name)
querystring = ''
if force:
@@ -125,6 +136,7 @@
raise ClientException("failed to delete nsd {} - {}".format(name, msg))
def create(self, filename, overwrite=None, update_endpoint=None):
+ self._logger.debug("")
self._client.get_token()
mime_type = magic.from_file(filename, mime=True)
if mime_type is None:
@@ -182,6 +194,7 @@
raise ClientException("failed to create/update nsd - {}".format(msg))
def update(self, name, filename):
+ self._logger.debug("")
nsd = self.get(name)
endpoint = '{}/{}/nsd_content'.format(self._apiBase, nsd['_id'])
self.create(filename=filename, update_endpoint=endpoint)
diff --git a/osmclient/sol005/nsi.py b/osmclient/sol005/nsi.py
index 0fcfe1d..c01b4e9 100644
--- a/osmclient/sol005/nsi.py
+++ b/osmclient/sol005/nsi.py
@@ -24,6 +24,7 @@
from osmclient.common.exceptions import NotFound
import yaml
import json
+import logging
class Nsi(object):
@@ -31,6 +32,7 @@
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/nsilcm'
self._apiVersion = '/v1'
self._apiResource = '/netslice_instances_content'
@@ -39,6 +41,7 @@
# NSI '--wait' option
def _wait(self, id, deleteFlag=False):
+ self._logger.debug("")
self._client.get_token()
# Endpoint to get operation status
apiUrlStatus = '{}{}{}'.format(self._apiName, self._apiVersion, '/nsi_lcm_op_occs')
@@ -54,6 +57,7 @@
def list(self, filter=None):
"""Returns a list of NSI
"""
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -66,6 +70,7 @@
def get(self, name):
"""Returns an NSI based on name or id
"""
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for nsi in self.list():
@@ -78,6 +83,7 @@
raise NotFound("nsi {} not found".format(name))
def get_individual(self, name):
+ self._logger.debug("")
nsi_id = name
self._client.get_token()
if not utils.validate_uuid4(name):
@@ -93,6 +99,7 @@
raise NotFound("nsi {} not found".format(name))
def delete(self, name, force=False, wait=False):
+ self._logger.debug("")
nsi = self.get(name)
querystring = ''
if force:
@@ -124,12 +131,14 @@
ssh_keys=None, description='default description',
admin_status='ENABLED', wait=False):
+ self._logger.debug("")
self._client.get_token()
nst = self._client.nst.get(nst_name)
vim_account_id = {}
def get_vim_account_id(vim_account):
+ self._logger.debug("")
if vim_account_id.get(vim_account):
return vim_account_id[vim_account]
@@ -203,6 +212,8 @@
not additional_param_subnet.get("additionalParamsForVnf"):
raise ValueError("Error at --config 'additionalParamsForSubnet' items must contain "
"'additionalParamsForNs' and/or 'additionalParamsForVnf'")
+ if "timeout_nsi_deploy" in nsi_config:
+ nsi["timeout_nsi_deploy"] = nsi_config.pop("timeout_nsi_deploy")
# print(yaml.safe_dump(nsi))
try:
@@ -246,6 +257,7 @@
def list_op(self, name, filter=None):
"""Returns the list of operations of a NSI
"""
+ self._logger.debug("")
nsi = self.get(name)
try:
self._apiResource = '/nsi_lcm_op_occs'
@@ -283,6 +295,7 @@
def get_op(self, operationId):
"""Returns the status of an operation
"""
+ self._logger.debug("")
self._client.get_token()
try:
self._apiResource = '/nsi_lcm_op_occs'
@@ -315,6 +328,7 @@
def exec_op(self, name, op_name, op_data=None):
"""Executes an operation on a NSI
"""
+ self._logger.debug("")
nsi = self.get(name)
try:
self._apiResource = '/netslice_instances'
diff --git a/osmclient/sol005/nst.py b/osmclient/sol005/nst.py
index f0da0f5..e75c8f5 100644
--- a/osmclient/sol005/nst.py
+++ b/osmclient/sol005/nst.py
@@ -23,6 +23,7 @@
from osmclient.common import utils
import json
import magic
+import logging
#from os import stat
#from os.path import basename
@@ -31,6 +32,7 @@
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/nst'
self._apiVersion = '/v1'
self._apiResource = '/netslice_templates'
@@ -38,6 +40,7 @@
self._apiVersion, self._apiResource)
def list(self, filter=None):
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -49,6 +52,7 @@
return list()
def get(self, name):
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for nst in self.list():
@@ -61,6 +65,7 @@
raise NotFound("nst {} not found".format(name))
def get_individual(self, name):
+ self._logger.debug("")
nst = self.get(name)
# It is redundant, since the previous one already gets the whole nstinfo
# The only difference is that a different primitive is exercised
@@ -71,6 +76,7 @@
raise NotFound("nst {} not found".format(name))
def get_thing(self, name, thing, filename):
+ self._logger.debug("")
nst = self.get(name)
headers = self._client._headers
headers['Accept'] = 'application/binary'
@@ -91,15 +97,19 @@
raise ClientException("failed to get {} from {} - {}".format(thing, name, msg))
def get_descriptor(self, name, filename):
+ self._logger.debug("")
self.get_thing(name, 'nst', filename)
def get_package(self, name, filename):
+ self._logger.debug("")
self.get_thing(name, 'nst_content', filename)
def get_artifact(self, name, artifact, filename):
+ self._logger.debug("")
self.get_thing(name, 'artifacts/{}'.format(artifact), filename)
def delete(self, name, force=False):
+ self._logger.debug("")
nst = self.get(name)
querystring = ''
if force:
@@ -122,6 +132,7 @@
raise ClientException("failed to delete nst {} - {}".format(name, msg))
def create(self, filename, overwrite=None, update_endpoint=None):
+ self._logger.debug("")
self._client.get_token()
mime_type = magic.from_file(filename, mime=True)
if mime_type is None:
@@ -176,6 +187,7 @@
raise ClientException("failed to create/update nst - {}".format(msg))
def update(self, name, filename):
+ self._logger.debug("")
nst = self.get(name)
endpoint = '{}/{}/nst_content'.format(self._apiBase, nst['_id'])
self.create(filename=filename, update_endpoint=endpoint)
diff --git a/osmclient/sol005/package.py b/osmclient/sol005/package.py
index c383862..a52ba15 100644
--- a/osmclient/sol005/package.py
+++ b/osmclient/sol005/package.py
@@ -24,17 +24,21 @@
from osmclient.common.exceptions import NotFound
from osmclient.common import utils
import json
+import logging
class Package(object):
def __init__(self, http=None, client=None):
self._client = client
self._http = http
+ self._logger = logging.getLogger('osmclient')
def get_key_val_from_pkg(self, descriptor_file):
+ self._logger.debug("")
return utils.get_key_val_from_pkg(descriptor_file)
def _wait_for_package(self, pkg_type):
+ self._logger.debug("")
if 'vnfd' in pkg_type['type']:
get_method = self._client.vnfd.get
elif 'nsd' in pkg_type['type']:
@@ -44,6 +48,7 @@
# helper method to check if pkg exists
def check_exists(func):
+ self._logger.debug("")
try:
func()
except NotFound:
@@ -58,6 +63,7 @@
"""wait(block) for an upload to succeed.
The filename passed is assumed to be a descriptor tarball.
"""
+ self._logger.debug("")
self._client.get_token()
pkg_type = utils.get_key_val_from_pkg(filename)
@@ -69,6 +75,7 @@
.format(filename))
def upload(self, filename):
+ self._logger.debug("")
self._client.get_token()
pkg_type = utils.get_key_val_from_pkg(filename)
if pkg_type is None:
diff --git a/osmclient/sol005/pdud.py b/osmclient/sol005/pdud.py
index 22ca8bc..42fe40d 100644
--- a/osmclient/sol005/pdud.py
+++ b/osmclient/sol005/pdud.py
@@ -22,6 +22,7 @@
from osmclient.common.exceptions import ClientException
from osmclient.common import utils
import json
+import logging
class Pdu(object):
@@ -29,6 +30,7 @@
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/pdu'
self._apiVersion = '/v1'
self._apiResource = '/pdu_descriptors'
@@ -36,6 +38,7 @@
self._apiVersion, self._apiResource)
def list(self, filter=None):
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -46,6 +49,7 @@
return list()
def get(self, name):
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for pdud in self.list():
@@ -58,6 +62,7 @@
raise NotFound("pdud {} not found".format(name))
def get_individual(self, name):
+ self._logger.debug("")
pdud = self.get(name)
# It is redundant, since the previous one already gets the whole pdudInfo
# The only difference is that a different primitive is exercised
@@ -68,6 +73,7 @@
raise NotFound("pdu {} not found".format(name))
def delete(self, name, force=False):
+ self._logger.debug("")
pdud = self.get(name)
querystring = ''
if force:
@@ -90,6 +96,7 @@
raise ClientException("failed to delete pdu {} - {}".format(name, msg))
def create(self, pdu, update_endpoint=None):
+ self._logger.debug("")
self._client.get_token()
headers= self._client._headers
headers['Content-Type'] = 'application/yaml'
@@ -121,6 +128,7 @@
raise ClientException("failed to create/update pdu - {}".format(msg))
def update(self, name, filename):
+ self._logger.debug("")
pdud = self.get(name)
endpoint = '{}/{}'.format(self._apiBase, pdud['_id'])
self.create(filename=filename, update_endpoint=endpoint)
diff --git a/osmclient/sol005/project.py b/osmclient/sol005/project.py
index 19a27c3..8f119e8 100644
--- a/osmclient/sol005/project.py
+++ b/osmclient/sol005/project.py
@@ -23,12 +23,14 @@
from osmclient.common.exceptions import ClientException
from osmclient.common.exceptions import NotFound
import json
+import logging
class Project(object):
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/admin'
self._apiVersion = '/v1'
self._apiResource = '/projects'
@@ -38,6 +40,7 @@
def create(self, name, project):
"""Creates a new OSM project
"""
+ self._logger.debug("")
self._client.get_token()
http_code, resp = self._http.post_cmd(endpoint=self._apiBase,
postfields_dict=project)
@@ -62,6 +65,7 @@
def update(self, project, project_changes):
"""Updates an OSM project identified by name
"""
+ self._logger.debug("")
self._client.get_token()
proj = self.get(project)
http_code, resp = self._http.patch_cmd(endpoint='{}/{}'.format(self._apiBase, proj['_id']),
@@ -89,6 +93,7 @@
def delete(self, name, force=False):
"""Deletes an OSM project identified by name
"""
+ self._logger.debug("")
self._client.get_token()
project = self.get(name)
querystring = ''
@@ -116,6 +121,7 @@
def list(self, filter=None):
"""Returns the list of OSM projects
"""
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -129,6 +135,7 @@
def get(self, name):
"""Returns a specific OSM project based on name or id
"""
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for proj in self.list():
@@ -140,4 +147,3 @@
return proj
raise NotFound("Project {} not found".format(name))
-
diff --git a/osmclient/sol005/role.py b/osmclient/sol005/role.py
index 01f3bc3..404784a 100644
--- a/osmclient/sol005/role.py
+++ b/osmclient/sol005/role.py
@@ -25,12 +25,14 @@
from osmclient.common.exceptions import NotFound
import json
import yaml
+import logging
class Role(object):
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/admin'
self._apiVersion = '/v1'
self._apiResource = '/roles'
@@ -46,6 +48,7 @@
:raises ClientException: when receives an unexpected from the server.
:raises ClientException: when fails creating a role.
"""
+ self._logger.debug("")
self._client.get_token()
role = {"name": name}
@@ -95,6 +98,7 @@
:raises ClientException: when receives an unexpected response from the server.
:raises ClientException: when fails updating a role.
"""
+ self._logger.debug("")
self._client.get_token()
if new_name is None and permissions is None and add is None and remove is None:
raise ClientException('At least one option should be provided')
@@ -173,6 +177,7 @@
:param force:
:raises ClientException: when fails to delete a role.
"""
+ self._logger.debug("")
self._client.get_token()
role = self.get(name)
querystring = ''
@@ -204,6 +209,7 @@
:param filter:
:returns:
"""
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -222,6 +228,7 @@
:raises NotFound: when the role is not found.
:returns: the specified role.
"""
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for role in self.list():
@@ -232,3 +239,4 @@
if name == role['name']:
return role
raise NotFound("Role {} not found".format(name))
+
diff --git a/osmclient/sol005/sdncontroller.py b/osmclient/sol005/sdncontroller.py
index 4f3ced4..b2bbc37 100644
--- a/osmclient/sol005/sdncontroller.py
+++ b/osmclient/sol005/sdncontroller.py
@@ -23,12 +23,14 @@
from osmclient.common.exceptions import ClientException
from osmclient.common.exceptions import NotFound
import json
+import logging
class SdnController(object):
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/admin'
self._apiVersion = '/v1'
self._apiResource = '/sdns'
@@ -37,6 +39,7 @@
# SDNC '--wait' option
def _wait(self, id, deleteFlag=False):
+ self._logger.debug("")
self._client.get_token()
# Endpoint to get operation status
apiUrlStatus = '{}{}{}'.format(self._apiName, self._apiVersion, '/sdns')
@@ -50,7 +53,9 @@
deleteFlag=deleteFlag)
def _get_id_for_wait(self, name):
- # Returns id of name, or the id itself if given as argument
+ """Returns id of name, or the id itself if given as argument
+ """
+ self._logger.debug("")
for sdnc in self.list():
if name == sdnc['_id']:
return sdnc['_id']
@@ -60,17 +65,16 @@
return ''
def create(self, name, sdn_controller, wait=False):
+ self._logger.debug("")
self._client.get_token()
- http_code, resp = self._http.post_cmd(endpoint=self._apiBase,
- postfields_dict=sdn_controller)
- #print('HTTP CODE: {}'.format(http_code))
- #print('RESP: {}'.format(resp))
+ http_code, resp = self._http.post_cmd(endpoint=self._apiBase, postfields_dict=sdn_controller)
+ # print('HTTP CODE: {}'.format(http_code))
+ # print('RESP: {}'.format(resp))
if http_code in (200, 201, 202, 204):
if resp:
resp = json.loads(resp)
if not resp or 'id' not in resp:
- raise ClientException('unexpected response from server - {}'.format(
- resp))
+ raise ClientException('unexpected response from server - {}'.format(resp))
if wait:
# Wait for status for SDNC instance creation
self._wait(resp.get('id'))
@@ -85,11 +89,12 @@
raise ClientException("failed to create SDN controller {} - {}".format(name, msg))
def update(self, name, sdn_controller, wait=False):
+ self._logger.debug("")
self._client.get_token()
sdnc = self.get(name)
sdnc_id_for_wait = self._get_id_for_wait(name)
http_code, resp = self._http.patch_cmd(endpoint='{}/{}'.format(self._apiBase,sdnc['_id']),
- postfields_dict=sdn_controller)
+ postfields_dict=sdn_controller)
# print('HTTP CODE: {}'.format(http_code))
# print('RESP: {}'.format(resp))
if http_code in (200, 201, 202, 204):
@@ -111,6 +116,7 @@
raise ClientException("failed to update SDN controller {} - {}".format(name, msg))
def delete(self, name, force=False, wait=False):
+ self._logger.debug("")
self._client.get_token()
sdn_controller = self.get(name)
sdnc_id_for_wait = self._get_id_for_wait(name)
@@ -118,9 +124,9 @@
if force:
querystring = '?FORCE=True'
http_code, resp = self._http.delete_cmd('{}/{}{}'.format(self._apiBase,
- sdn_controller['_id'], querystring))
- #print('HTTP CODE: {}'.format(http_code))
- #print('RESP: {}'.format(resp))
+ sdn_controller['_id'], querystring))
+ # print('HTTP CODE: {}'.format(http_code))
+ # print('RESP: {}'.format(resp))
if http_code == 202:
if wait:
# Wait for status for SDNC instance deletion
@@ -143,12 +149,13 @@
def list(self, filter=None):
"""Returns a list of SDN controllers
"""
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
filter_string = '?{}'.format(filter)
- resp = self._http.get_cmd('{}{}'.format(self._apiBase,filter_string))
- #print('RESP: {}'.format(resp))
+ resp = self._http.get_cmd('{}{}'.format(self._apiBase, filter_string))
+ # print('RESP: {}'.format(resp))
if resp:
return resp
return list()
@@ -156,6 +163,7 @@
def get(self, name):
"""Returns an SDN controller based on name or id
"""
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for sdnc in self.list():
@@ -167,4 +175,3 @@
return sdnc
raise NotFound("SDN controller {} not found".format(name))
-
diff --git a/osmclient/sol005/user.py b/osmclient/sol005/user.py
index 64d5c69..6c10325 100644
--- a/osmclient/sol005/user.py
+++ b/osmclient/sol005/user.py
@@ -23,12 +23,14 @@
from osmclient.common.exceptions import ClientException
from osmclient.common.exceptions import NotFound
import json
+import logging
class User(object):
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/admin'
self._apiVersion = '/v1'
self._apiResource = '/users'
@@ -38,6 +40,7 @@
def create(self, name, user):
"""Creates a new OSM user
"""
+ self._logger.debug("")
self._client.get_token()
if not user["projects"] or (len(user["projects"]) == 1 and not user["projects"][0]):
del user["projects"]
@@ -84,6 +87,7 @@
def update(self, name, user):
"""Updates an existing OSM user identified by name
"""
+ self._logger.debug("")
self._client.get_token()
# print(user)
myuser = self.get(name)
@@ -165,6 +169,7 @@
def delete(self, name, force=False):
"""Deletes an existing OSM user identified by name
"""
+ self._logger.debug("")
self._client.get_token()
user = self.get(name)
querystring = ''
@@ -192,6 +197,7 @@
def list(self, filter=None):
"""Returns the list of OSM users
"""
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -205,6 +211,7 @@
def get(self, name):
"""Returns an OSM user based on name or id
"""
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for user in self.list():
@@ -216,4 +223,3 @@
return user
raise NotFound("User {} not found".format(name))
-
diff --git a/osmclient/sol005/vim.py b/osmclient/sol005/vim.py
index 1af7cc7..43911a6 100644
--- a/osmclient/sol005/vim.py
+++ b/osmclient/sol005/vim.py
@@ -24,12 +24,14 @@
from osmclient.common.exceptions import NotFound
import yaml
import json
+import logging
class Vim(object):
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/admin'
self._apiVersion = '/v1'
self._apiResource = '/vim_accounts'
@@ -38,6 +40,7 @@
# VIM '--wait' option
def _wait(self, id, deleteFlag=False):
+ self._logger.debug("")
self._client.get_token()
# Endpoint to get operation status
apiUrlStatus = '{}{}{}'.format(self._apiName, self._apiVersion, '/vim_accounts')
@@ -51,7 +54,10 @@
deleteFlag=deleteFlag)
def _get_id_for_wait(self, name):
- # Returns id of name, or the id itself if given as argument
+ """ Returns id of name, or the id itself if given as argument
+ """
+ self._logger.debug("")
+ self._client.get_token()
for vim in self.list():
if name == vim['uuid']:
return vim['uuid']
@@ -61,6 +67,7 @@
return ''
def create(self, name, vim_access, sdn_controller=None, sdn_port_mapping=None, wait=False):
+ self._logger.debug("")
self._client.get_token()
if 'vim-type' not in vim_access:
#'openstack' not in vim_access['vim-type']):
@@ -107,6 +114,7 @@
raise ClientException("failed to create vim {} - {}".format(name, msg))
def update(self, vim_name, vim_account, sdn_controller, sdn_port_mapping, wait=False):
+ self._logger.debug("")
self._client.get_token()
vim = self.get(vim_name)
vim_id_for_wait = self._get_id_for_wait(vim_name)
@@ -149,6 +157,7 @@
raise ClientException("failed to update vim {} - {}".format(vim_name, msg))
def update_vim_account_dict(self, vim_account, vim_access):
+ self._logger.debug("")
vim_account['vim_type'] = vim_access['vim-type']
vim_account['description'] = vim_access['description']
vim_account['vim_url'] = vim_access['vim-url']
@@ -160,12 +169,14 @@
def get_id(self, name):
"""Returns a VIM id from a VIM name
"""
+ self._logger.debug("")
for vim in self.list():
if name == vim['name']:
return vim['uuid']
raise NotFound("vim {} not found".format(name))
def delete(self, vim_name, force=False, wait=False):
+ self._logger.debug("")
self._client.get_token()
vim_id = vim_name
if not utils.validate_uuid4(vim_name):
@@ -203,6 +214,7 @@
def list(self, filter=None):
"""Returns a list of VIM accounts
"""
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -219,6 +231,7 @@
def get(self, name):
"""Returns a VIM account based on name or id
"""
+ self._logger.debug("")
self._client.get_token()
vim_id = name
if not utils.validate_uuid4(name):
diff --git a/osmclient/sol005/vnf.py b/osmclient/sol005/vnf.py
index b7ac856..6aa44d8 100644
--- a/osmclient/sol005/vnf.py
+++ b/osmclient/sol005/vnf.py
@@ -20,6 +20,7 @@
from osmclient.common import utils
from osmclient.common.exceptions import NotFound
+import logging
class Vnf(object):
@@ -27,6 +28,7 @@
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/nslcm'
self._apiVersion = '/v1'
self._apiResource = '/vnfrs'
@@ -36,6 +38,7 @@
def list(self, ns=None, filter=None):
"""Returns a list of VNF instances
"""
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -55,6 +58,7 @@
def get(self, name):
"""Returns a VNF instance based on name or id
"""
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for vnf in self.list():
@@ -67,6 +71,7 @@
raise NotFound("vnf {} not found".format(name))
def get_individual(self, name):
+ self._logger.debug("")
self._client.get_token()
vnf_id = name
if not utils.validate_uuid4(name):
diff --git a/osmclient/sol005/vnfd.py b/osmclient/sol005/vnfd.py
index ffa0182..ec54c95 100644
--- a/osmclient/sol005/vnfd.py
+++ b/osmclient/sol005/vnfd.py
@@ -24,6 +24,7 @@
import json
import magic
from os.path import basename
+import logging
#from os import stat
@@ -32,6 +33,7 @@
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/vnfpkgm'
self._apiVersion = '/v1'
self._apiResource = '/vnf_packages'
@@ -40,6 +42,7 @@
#self._apiBase='/vnfds'
def list(self, filter=None):
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -50,6 +53,7 @@
return list()
def get(self, name):
+ self._logger.debug("")
self._client.get_token()
if utils.validate_uuid4(name):
for vnfd in self.list():
@@ -62,6 +66,7 @@
raise NotFound("vnfd {} not found".format(name))
def get_individual(self, name):
+ self._logger.debug("")
vnfd = self.get(name)
# It is redundant, since the previous one already gets the whole vnfpkginfo
# The only difference is that a different primitive is exercised
@@ -72,6 +77,7 @@
raise NotFound("vnfd {} not found".format(name))
def get_thing(self, name, thing, filename):
+ self._logger.debug("")
vnfd = self.get(name)
headers = self._client._headers
headers['Accept'] = 'application/binary'
@@ -92,15 +98,19 @@
raise ClientException("failed to get {} from {} - {}".format(thing, name, msg))
def get_descriptor(self, name, filename):
+ self._logger.debug("")
self.get_thing(name, 'vnfd', filename)
def get_package(self, name, filename):
+ self._logger.debug("")
self.get_thing(name, 'package_content', filename)
def get_artifact(self, name, artifact, filename):
+ self._logger.debug("")
self.get_thing(name, 'artifacts/{}'.format(artifact), filename)
def delete(self, name, force=False):
+ self._logger.debug("")
self._client.get_token()
vnfd = self.get(name)
querystring = ''
@@ -124,6 +134,7 @@
raise ClientException("failed to delete vnfd {} - {}".format(name, msg))
def create(self, filename, overwrite=None, update_endpoint=None):
+ self._logger.debug("")
self._client.get_token()
mime_type = magic.from_file(filename, mime=True)
if mime_type is None:
@@ -181,6 +192,7 @@
raise ClientException("failed to create/update vnfd - {}".format(msg))
def update(self, name, filename):
+ self._logger.debug("")
self._client.get_token()
vnfd = self.get(name)
endpoint = '{}/{}/package_content'.format(self._apiBase, vnfd['_id'])
diff --git a/osmclient/sol005/wim.py b/osmclient/sol005/wim.py
index 943ceb4..61c4dda 100644
--- a/osmclient/sol005/wim.py
+++ b/osmclient/sol005/wim.py
@@ -24,12 +24,14 @@
from osmclient.common.exceptions import NotFound
import yaml
import json
+import logging
class Wim(object):
def __init__(self, http=None, client=None):
self._http = http
self._client = client
+ self._logger = logging.getLogger('osmclient')
self._apiName = '/admin'
self._apiVersion = '/v1'
self._apiResource = '/wim_accounts'
@@ -38,6 +40,7 @@
# WIM '--wait' option
def _wait(self, id, deleteFlag=False):
+ self._logger.debug("")
self._client.get_token()
# Endpoint to get operation status
apiUrlStatus = '{}{}{}'.format(self._apiName, self._apiVersion, '/wim_accounts')
@@ -51,7 +54,9 @@
deleteFlag=deleteFlag)
def _get_id_for_wait(self, name):
- # Returns id of name, or the id itself if given as argument
+ """Returns id of name, or the id itself if given as argument
+ """
+ self._logger.debug("")
for wim in self.list():
if name == wim['uuid']:
return wim['uuid']
@@ -61,6 +66,7 @@
return ''
def create(self, name, wim_input, wim_port_mapping=None, wait=False):
+ self._logger.debug("")
self._client.get_token()
if 'wim_type' not in wim_input:
raise Exception("wim type not provided")
@@ -102,6 +108,7 @@
raise ClientException("failed to create wim {} - {}".format(name, msg))
def update(self, wim_name, wim_account, wim_port_mapping=None, wait=False):
+ self._logger.debug("")
self._client.get_token()
wim = self.get(wim_name)
wim_id_for_wait = self._get_id_for_wait(wim_name)
@@ -141,7 +148,8 @@
raise ClientException("failed to update wim {} - {}".format(wim_name, msg))
def update_wim_account_dict(self, wim_account, wim_input):
- print(wim_input)
+ self._logger.debug("")
+ self._logger.debug(str(wim_input))
wim_account['wim_type'] = wim_input['wim_type']
wim_account['description'] = wim_input['description']
wim_account['wim_url'] = wim_input['url']
@@ -152,12 +160,14 @@
def get_id(self, name):
"""Returns a WIM id from a WIM name
"""
+ self._logger.debug("")
for wim in self.list():
if name == wim['name']:
return wim['uuid']
raise NotFound("wim {} not found".format(name))
def delete(self, wim_name, force=False, wait=False):
+ self._logger.debug("")
self._client.get_token()
wim_id = wim_name
wim_id_for_wait = self._get_id_for_wait(wim_name)
@@ -197,6 +207,7 @@
def list(self, filter=None):
"""Returns a list of VIM accounts
"""
+ self._logger.debug("")
self._client.get_token()
filter_string = ''
if filter:
@@ -213,6 +224,7 @@
def get(self, name):
"""Returns a VIM account based on name or id
"""
+ self._logger.debug("")
self._client.get_token()
wim_id = name
if not utils.validate_uuid4(name):
@@ -224,3 +236,4 @@
else:
return resp
raise NotFound("wim {} not found".format(name))
+
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..96b6e69
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,24 @@
+# Copyright 2019 ETSI OSM
+#
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+Click
+prettytable
+PyYAML
+pycurl
+python-magic
+jinja2
+verboselogs
+git+https://osm.etsi.org/gerrit/osm/IM.git#egg=osm-im
diff --git a/setup.py b/setup.py
index 689e926..1a60771 100644
--- a/setup.py
+++ b/setup.py
@@ -29,7 +29,7 @@
license='Apache 2',
install_requires=[
'Click', 'prettytable', 'pyyaml', 'pycurl', 'python-magic',
- 'jinja2', 'osm-im'
+ 'jinja2', 'osm-im', 'verboselogs'
],
dependency_links=[
'git+https://osm.etsi.org/gerrit/osm/IM.git#egg=osm-im',
diff --git a/test-requirements.txt b/test-requirements.txt
index 301fb43..e944b57 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -16,4 +16,3 @@
nose
mock
-git+https://osm.etsi.org/gerrit/osm/IM.git#egg=osm-im
\ No newline at end of file
diff --git a/tox.ini b/tox.ini
index a09288a..6fdc825 100644
--- a/tox.ini
+++ b/tox.ini
@@ -15,35 +15,39 @@
# under the License.
#
[tox]
-envlist = py35,flake8,pyflakes
+envlist = py36,flakes
toxworkdir={toxinidir}/.tox
[testenv]
-deps = -r{toxinidir}/test-requirements.txt
+deps = -r{toxinidir}/requirements.txt
+ -r{toxinidir}/test-requirements.txt
+install_command = python3 -m pip install -U {opts} {packages}
commands=nosetests
-install_command = python -m pip install -r test-requirements.txt -U {opts} {packages}
-[testenv:flake8]
+[testenv:flakes]
basepython = python3
deps = flake8
+ pyflakes
+ -r{toxinidir}/requirements.txt
+ -r{toxinidir}/test-requirements.txt
+install_command = python3 -m pip install -U {opts} {packages}
commands =
flake8 setup.py
-
-[testenv:pyflakes]
-basepython = python3
-deps = pyflakes
-commands =
pyflakes osmclient
[testenv:build]
basepython = python3
deps = stdeb
setuptools-version-command
-commands = python setup.py --command-packages=stdeb.command bdist_deb
+ -r{toxinidir}/requirements.txt
+install_command = python2 -m pip install -U {opts} {packages}
+commands = python2 setup.py --command-packages=stdeb.command bdist_deb
[testenv:build3]
basepython = python3
deps = stdeb
setuptools-version-command
+ -r{toxinidir}/requirements.txt
+install_command = python3 -m pip install -U {opts} {packages}
commands = python3 setup.py --command-packages=stdeb.command bdist_deb