b2bbc37d9d5104ee73dc53c0bd2ca44491c9deae
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
, postfields_dict
=sdn_controller
)
71 # print('HTTP CODE: {}'.format(http_code))
72 # print('RESP: {}'.format(resp))
73 if http_code
in (200, 201, 202, 204):
75 resp
= json
.loads(resp
)
76 if not resp
or 'id' not in resp
:
77 raise ClientException('unexpected response from server - {}'.format(resp
))
79 # Wait for status for SDNC instance creation
80 self
._wait
(resp
.get('id'))
86 msg
= json
.loads(resp
)
89 raise ClientException("failed to create SDN controller {} - {}".format(name
, msg
))
91 def update(self
, name
, sdn_controller
, wait
=False):
92 self
._logger
.debug("")
93 self
._client
.get_token()
95 sdnc_id_for_wait
= self
._get
_id
_for
_wait
(name
)
96 http_code
, resp
= self
._http
.patch_cmd(endpoint
='{}/{}'.format(self
._apiBase
,sdnc
['_id']),
97 postfields_dict
=sdn_controller
)
98 # print('HTTP CODE: {}'.format(http_code))
99 # print('RESP: {}'.format(resp))
100 if http_code
in (200, 201, 202, 204):
102 # In this case, 'resp' always returns None, so 'resp['id']' cannot be used.
103 # Use the previously obtained id instead.
104 wait_id
= sdnc_id_for_wait
105 # Wait for status for VI instance update
113 msg
= json
.loads(resp
)
116 raise ClientException("failed to update SDN controller {} - {}".format(name
, msg
))
118 def delete(self
, name
, force
=False, wait
=False):
119 self
._logger
.debug("")
120 self
._client
.get_token()
121 sdn_controller
= self
.get(name
)
122 sdnc_id_for_wait
= self
._get
_id
_for
_wait
(name
)
125 querystring
= '?FORCE=True'
126 http_code
, resp
= self
._http
.delete_cmd('{}/{}{}'.format(self
._apiBase
,
127 sdn_controller
['_id'], querystring
))
128 # print('HTTP CODE: {}'.format(http_code))
129 # print('RESP: {}'.format(resp))
132 # Wait for status for SDNC instance deletion
133 self
._wait
(sdnc_id_for_wait
, deleteFlag
=True)
135 print('Deletion in progress')
136 elif http_code
== 204:
138 elif resp
and 'result' in resp
:
144 msg
= json
.loads(resp
)
147 raise ClientException("failed to delete SDN controller {} - {}".format(name
, msg
))
149 def list(self
, filter=None):
150 """Returns a list of SDN controllers
152 self
._logger
.debug("")
153 self
._client
.get_token()
156 filter_string
= '?{}'.format(filter)
157 resp
= self
._http
.get_cmd('{}{}'.format(self
._apiBase
, filter_string
))
158 # print('RESP: {}'.format(resp))
164 """Returns an SDN controller based on name or id
166 self
._logger
.debug("")
167 self
._client
.get_token()
168 if utils
.validate_uuid4(name
):
169 for sdnc
in self
.list():
170 if name
== sdnc
['_id']:
173 for sdnc
in self
.list():
174 if name
== sdnc
['name']:
176 raise NotFound("SDN controller {} not found".format(name
))