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
29 class SdnController(object):
30 def __init__(self
, http
=None, client
=None):
33 self
._logger
= logging
.getLogger('osmclient')
34 self
._apiName
= '/admin'
35 self
._apiVersion
= '/v1'
36 self
._apiResource
= '/sdns'
37 self
._apiBase
= '{}{}{}'.format(self
._apiName
,
38 self
._apiVersion
, self
._apiResource
)
40 # SDNC '--wait' option
41 def _wait(self
, id, deleteFlag
=False):
42 self
._logger
.debug("")
43 self
._client
.get_token()
44 # Endpoint to get operation status
45 apiUrlStatus
= '{}{}{}'.format(self
._apiName
, self
._apiVersion
, '/sdns')
46 # Wait for status for SDN instance creation/update/deletion
47 WaitForStatus
.wait_for_status(
50 WaitForStatus
.TIMEOUT_SDNC_OPERATION
,
53 deleteFlag
=deleteFlag
)
55 def _get_id_for_wait(self
, name
):
56 """Returns id of name, or the id itself if given as argument
58 self
._logger
.debug("")
59 for sdnc
in self
.list():
60 if name
== sdnc
['_id']:
62 for sdnc
in self
.list():
63 if name
== sdnc
['name']:
67 def create(self
, name
, sdn_controller
, wait
=False):
68 self
._logger
.debug("")
69 self
._client
.get_token()
70 http_code
, resp
= self
._http
.post_cmd(endpoint
=self
._apiBase
,
71 postfields_dict
=sdn_controller
)
72 #print('HTTP CODE: {}'.format(http_code))
73 #print('RESP: {}'.format(resp))
74 #if http_code in (200, 201, 202, 204):
76 resp
= json
.loads(resp
)
77 if not resp
or 'id' not in resp
:
78 raise ClientException('unexpected response from server - {}'.format(
81 # Wait for status for SDNC instance creation
82 self
._wait
(resp
.get('id'))
88 # msg = json.loads(resp)
91 # raise ClientException("failed to create SDN controller {} - {}".format(name, msg))
93 def update(self
, name
, sdn_controller
, wait
=False):
94 self
._logger
.debug("")
95 self
._client
.get_token()
97 sdnc_id_for_wait
= self
._get
_id
_for
_wait
(name
)
98 http_code
, resp
= self
._http
.patch_cmd(endpoint
='{}/{}'.format(self
._apiBase
,sdnc
['_id']),
99 postfields_dict
=sdn_controller
)
100 # print('HTTP CODE: {}'.format(http_code))
101 # print('RESP: {}'.format(resp))
102 #if http_code in (200, 201, 202, 204):
104 # In this case, 'resp' always returns None, so 'resp['id']' cannot be used.
105 # Use the previously obtained id instead.
106 wait_id
= sdnc_id_for_wait
107 # Wait for status for VI instance update
115 # msg = json.loads(resp)
118 # raise ClientException("failed to update SDN controller {} - {}".format(name, msg))
120 def delete(self
, name
, force
=False, wait
=False):
121 self
._logger
.debug("")
122 self
._client
.get_token()
123 sdn_controller
= self
.get(name
)
124 sdnc_id_for_wait
= self
._get
_id
_for
_wait
(name
)
127 querystring
= '?FORCE=True'
128 http_code
, resp
= self
._http
.delete_cmd('{}/{}{}'.format(self
._apiBase
,
129 sdn_controller
['_id'], querystring
))
130 # print('HTTP CODE: {}'.format(http_code))
131 # print('RESP: {}'.format(resp))
134 # Wait for status for SDNC instance deletion
135 self
._wait
(sdnc_id_for_wait
, deleteFlag
=True)
137 print('Deletion in progress')
138 elif http_code
== 204:
140 elif resp
and 'result' in resp
:
146 # msg = json.loads(resp)
149 raise ClientException("failed to delete SDN controller {} - {}".format(name
, msg
))
151 def list(self
, filter=None):
152 """Returns a list of SDN controllers
154 self
._logger
.debug("")
155 self
._client
.get_token()
158 filter_string
= '?{}'.format(filter)
159 _
, resp
= self
._http
.get2_cmd('{}{}'.format(self
._apiBase
,filter_string
))
160 #print('RESP: {}'.format(resp))
162 return json
.loads(resp
)
166 """Returns an SDN controller based on name or id
168 self
._logger
.debug("")
169 self
._client
.get_token()
170 if utils
.validate_uuid4(name
):
171 for sdnc
in self
.list():
172 if name
== sdnc
['_id']:
175 for sdnc
in self
.list():
176 if name
== sdnc
['name']:
178 raise NotFound("SDN controller {} not found".format(name
))