1 # Copyright 2018 Telefonica
5 # Licensed under the Apache License, Version 2.0 (the "License"); you may
6 # not use this file except in compliance with the License. You may obtain
7 # a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 # License for the specific language governing permissions and limitations
18 OSM SDN controller API handling
21 from osmclient
.common
import utils
22 from osmclient
.common
import wait
as WaitForStatus
23 from osmclient
.common
.exceptions
import ClientException
24 from osmclient
.common
.exceptions
import NotFound
30 class SdnController(object):
31 def __init__(self
, http
=None, client
=None):
34 self
._logger
= logging
.getLogger("osmclient")
35 self
._apiName
= "/admin"
36 self
._apiVersion
= "/v1"
37 self
._apiResource
= "/sdns"
38 self
._apiBase
= "{}{}{}".format(
39 self
._apiName
, self
._apiVersion
, self
._apiResource
42 # SDNC '--wait' option
43 def _wait(self
, id, wait_time
, deleteFlag
=False):
44 self
._logger
.debug("")
45 self
._client
.get_token()
46 # Endpoint to get operation status
47 apiUrlStatus
= "{}{}{}".format(self
._apiName
, self
._apiVersion
, "/sdns")
48 # Wait for status for SDN instance creation/update/deletion
49 if isinstance(wait_time
, bool):
50 wait_time
= WaitForStatus
.TIMEOUT_SDNC_OPERATION
51 WaitForStatus
.wait_for_status(
57 deleteFlag
=deleteFlag
,
60 def _get_id_for_wait(self
, name
):
61 """Returns id of name, or the id itself if given as argument"""
62 self
._logger
.debug("")
63 for sdnc
in self
.list():
64 if name
== sdnc
["_id"] or name
== sdnc
["name"]:
68 def create(self
, name
, sdn_controller
, wait
=False):
69 self
._logger
.debug("")
70 if "config" in sdn_controller
and isinstance(sdn_controller
["config"], str):
71 sdn_controller
["config"] = yaml
.safe_load(sdn_controller
["config"])
72 self
._client
.get_token()
73 http_code
, resp
= self
._http
.post_cmd(
74 endpoint
=self
._apiBase
, postfields_dict
=sdn_controller
76 # print('HTTP CODE: {}'.format(http_code))
77 # print('RESP: {}'.format(resp))
78 # if http_code in (200, 201, 202, 204):
80 resp
= json
.loads(resp
)
81 if not resp
or "id" not in resp
:
82 raise ClientException("unexpected response from server - {}".format(resp
))
84 # Wait for status for SDNC instance creation
85 self
._wait
(resp
.get("id"), wait
)
91 # msg = json.loads(resp)
94 # raise ClientException("failed to create SDN controller {} - {}".format(name, msg))
96 def update(self
, name
, sdn_controller
, wait
=False):
97 self
._logger
.debug("")
98 if "config" in sdn_controller
and isinstance(sdn_controller
["config"], str):
99 sdn_controller
["config"] = yaml
.safe_load(sdn_controller
["config"])
100 self
._client
.get_token()
101 sdnc
= self
.get(name
)
102 sdnc_id_for_wait
= self
._get
_id
_for
_wait
(name
)
103 http_code
, resp
= self
._http
.patch_cmd(
104 endpoint
="{}/{}".format(self
._apiBase
, sdnc
["_id"]),
105 postfields_dict
=sdn_controller
,
107 # print('HTTP CODE: {}'.format(http_code))
108 # print('RESP: {}'.format(resp))
109 # if http_code in (200, 201, 202, 204):
111 # In this case, 'resp' always returns None, so 'resp['id']' cannot be used.
112 # Use the previously obtained id instead.
113 wait_id
= sdnc_id_for_wait
114 # Wait for status for VI instance update
115 self
._wait
(wait_id
, wait
)
122 # msg = json.loads(resp)
125 # raise ClientException("failed to update SDN controller {} - {}".format(name, msg))
127 def delete(self
, name
, force
=False, wait
=False):
128 self
._logger
.debug("")
129 self
._client
.get_token()
130 sdn_controller
= self
.get(name
)
131 sdnc_id_for_wait
= self
._get
_id
_for
_wait
(name
)
134 querystring
= "?FORCE=True"
135 http_code
, resp
= self
._http
.delete_cmd(
136 "{}/{}{}".format(self
._apiBase
, sdn_controller
["_id"], querystring
)
138 # print('HTTP CODE: {}'.format(http_code))
139 # print('RESP: {}'.format(resp))
142 # Wait for status for SDNC instance deletion
143 self
._wait
(sdnc_id_for_wait
, wait
, deleteFlag
=True)
145 print("Deletion in progress")
146 elif http_code
== 204:
148 elif resp
and "result" in resp
:
154 # msg = json.loads(resp)
157 raise ClientException(
158 "failed to delete SDN controller {} - {}".format(name
, msg
)
161 def list(self
, filter=None):
162 """Returns a list of SDN controllers"""
163 self
._logger
.debug("")
164 self
._client
.get_token()
167 filter_string
= "?{}".format(filter)
168 _
, resp
= self
._http
.get2_cmd("{}{}".format(self
._apiBase
, filter_string
))
169 # print('RESP: {}'.format(resp))
171 return json
.loads(resp
)
175 """Returns an SDN controller based on name or id"""
176 self
._logger
.debug("")
177 self
._client
.get_token()
178 if utils
.validate_uuid4(name
):
179 for sdnc
in self
.list():
180 if name
== sdnc
["_id"]:
183 for sdnc
in self
.list():
184 if name
== sdnc
["name"]:
186 raise NotFound("SDN controller {} not found".format(name
))