4 cloudFPGA Resource Manager API
6 No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
8 OpenAPI spec version: 0.8
10 Generated by: https://github.com/swagger-api/swagger-codegen.git
13 from __future__
import absolute_import
20 from swagger_client.api_client
import ApiClient
24 """NOTE: This class is auto generated by the swagger code generator program.
26 Do not edit the class manually.
27 Ref: https://github.com/swagger-api/swagger-codegen
31 if api_client
is None:
36 """Deletes an existing connection to the `hw_server` of this instance # noqa: E501
38 This deletes the *connection to the* `hw_server`. This **does not imply** that the `hw_server` itself is stopped too. The `hw_server` is only stopped if there is no other open debug connection to the connected JTAG probe (some probes are connected to a JTAG chain). # noqa: E501
39 This method makes a synchronous HTTP request by default. To make an
40 asynchronous HTTP request, please pass async_req=True
41 >>> thread = api.cf_manager_rest_api_delete_debug_connection(username, password, instance_id, async_req=True)
42 >>> result = thread.get()
45 :param str username: OpenStack username (required)
46 :param str password: OpenStack password (required)
47 :param str instance_id: ROLE instance unique identifier (required)
49 If the method is called asynchronously,
50 returns the request thread.
52 kwargs[
'_return_http_data_only'] =
True
53 if kwargs.get(
'async_req'):
60 """Deletes an existing connection to the `hw_server` of this instance # noqa: E501
62 This deletes the *connection to the* `hw_server`. This **does not imply** that the `hw_server` itself is stopped too. The `hw_server` is only stopped if there is no other open debug connection to the connected JTAG probe (some probes are connected to a JTAG chain). # noqa: E501
63 This method makes a synchronous HTTP request by default. To make an
64 asynchronous HTTP request, please pass async_req=True
65 >>> thread = api.cf_manager_rest_api_delete_debug_connection_with_http_info(username, password, instance_id, async_req=True)
66 >>> result = thread.get()
69 :param str username: OpenStack username (required)
70 :param str password: OpenStack password (required)
71 :param str instance_id: ROLE instance unique identifier (required)
73 If the method is called asynchronously,
74 returns the request thread.
77 all_params = [
'username',
'password',
'instance_id']
78 all_params.append(
'async_req')
79 all_params.append(
'_return_http_data_only')
80 all_params.append(
'_preload_content')
81 all_params.append(
'_request_timeout')
84 for key, val
in six.iteritems(params[
'kwargs']):
85 if key
not in all_params:
87 "Got an unexpected keyword argument '%s'"
88 " to method cf_manager_rest_api_delete_debug_connection" % key
93 if (
'username' not in params
or
94 params[
'username']
is None):
95 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_delete_debug_connection`")
97 if (
'password' not in params
or
98 params[
'password']
is None):
99 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_delete_debug_connection`")
101 if (
'instance_id' not in params
or
102 params[
'instance_id']
is None):
103 raise ValueError(
"Missing the required parameter `instance_id` when calling `cf_manager_rest_api_delete_debug_connection`")
105 collection_formats = {}
108 if 'instance_id' in params:
109 path_params[
'instance_id'] = params[
'instance_id']
112 if 'username' in params:
113 query_params.append((
'username', params[
'username']))
114 if 'password' in params:
115 query_params.append((
'password', params[
'password']))
127 '/debug/ila_connection/{instance_id}',
'DELETE',
132 post_params=form_params,
133 files=local_var_files,
135 auth_settings=auth_settings,
136 async_req=params.get(
'async_req'),
137 _return_http_data_only=params.get(
'_return_http_data_only'),
138 _preload_content=params.get(
'_preload_content',
True),
139 _request_timeout=params.get(
'_request_timeout'),
140 collection_formats=collection_formats)
143 """Requests a list of running `hw_server`s on all instances (admin only) # noqa: E501
145 This method makes a synchronous HTTP request by default. To make an
146 asynchronous HTTP request, please pass async_req=True
147 >>> thread = api.cf_manager_rest_api_get_all_debug_connections(username, password, async_req=True)
148 >>> result = thread.get()
150 :param async_req bool
151 :param str username: OpenStack username (required)
152 :param str password: OpenStack password (required)
153 :return: list[InlineResponse2004]
154 If the method is called asynchronously,
155 returns the request thread.
157 kwargs[
'_return_http_data_only'] =
True
158 if kwargs.get(
'async_req'):
165 """Requests a list of running `hw_server`s on all instances (admin only) # noqa: E501
167 This method makes a synchronous HTTP request by default. To make an
168 asynchronous HTTP request, please pass async_req=True
169 >>> thread = api.cf_manager_rest_api_get_all_debug_connections_with_http_info(username, password, async_req=True)
170 >>> result = thread.get()
172 :param async_req bool
173 :param str username: OpenStack username (required)
174 :param str password: OpenStack password (required)
175 :return: list[InlineResponse2004]
176 If the method is called asynchronously,
177 returns the request thread.
180 all_params = [
'username',
'password']
181 all_params.append(
'async_req')
182 all_params.append(
'_return_http_data_only')
183 all_params.append(
'_preload_content')
184 all_params.append(
'_request_timeout')
187 for key, val
in six.iteritems(params[
'kwargs']):
188 if key
not in all_params:
190 "Got an unexpected keyword argument '%s'"
191 " to method cf_manager_rest_api_get_all_debug_connections" % key
196 if (
'username' not in params
or
197 params[
'username']
is None):
198 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_get_all_debug_connections`")
200 if (
'password' not in params
or
201 params[
'password']
is None):
202 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_get_all_debug_connections`")
204 collection_formats = {}
209 if 'username' in params:
210 query_params.append((
'username', params[
'username']))
211 if 'password' in params:
212 query_params.append((
'password', params[
'password']))
221 header_params[
'Accept'] = self.
api_clientapi_client.select_header_accept(
222 [
'application/json'])
228 '/debug/open_ila_connections',
'GET',
233 post_params=form_params,
234 files=local_var_files,
235 response_type=
'list[InlineResponse2004]',
236 auth_settings=auth_settings,
237 async_req=params.get(
'async_req'),
238 _return_http_data_only=params.get(
'_return_http_data_only'),
239 _preload_content=params.get(
'_preload_content',
True),
240 _request_timeout=params.get(
'_request_timeout'),
241 collection_formats=collection_formats)
244 """Returns all open `hw_server` of a user # noqa: E501
246 This method makes a synchronous HTTP request by default. To make an
247 asynchronous HTTP request, please pass async_req=True
248 >>> thread = api.cf_manager_rest_api_get_all_debug_connections_of_user(username, password, async_req=True)
249 >>> result = thread.get()
251 :param async_req bool
252 :param str username: OpenStack username (required)
253 :param str password: OpenStack password (required)
254 :return: list[InlineResponse2004]
255 If the method is called asynchronously,
256 returns the request thread.
258 kwargs[
'_return_http_data_only'] =
True
259 if kwargs.get(
'async_req'):
266 """Returns all open `hw_server` of a user # noqa: E501
268 This method makes a synchronous HTTP request by default. To make an
269 asynchronous HTTP request, please pass async_req=True
270 >>> thread = api.cf_manager_rest_api_get_all_debug_connections_of_user_with_http_info(username, password, async_req=True)
271 >>> result = thread.get()
273 :param async_req bool
274 :param str username: OpenStack username (required)
275 :param str password: OpenStack password (required)
276 :return: list[InlineResponse2004]
277 If the method is called asynchronously,
278 returns the request thread.
281 all_params = [
'username',
'password']
282 all_params.append(
'async_req')
283 all_params.append(
'_return_http_data_only')
284 all_params.append(
'_preload_content')
285 all_params.append(
'_request_timeout')
288 for key, val
in six.iteritems(params[
'kwargs']):
289 if key
not in all_params:
291 "Got an unexpected keyword argument '%s'"
292 " to method cf_manager_rest_api_get_all_debug_connections_of_user" % key
297 if (
'username' not in params
or
298 params[
'username']
is None):
299 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_get_all_debug_connections_of_user`")
301 if (
'password' not in params
or
302 params[
'password']
is None):
303 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_get_all_debug_connections_of_user`")
305 collection_formats = {}
310 if 'username' in params:
311 query_params.append((
'username', params[
'username']))
312 if 'password' in params:
313 query_params.append((
'password', params[
'password']))
322 header_params[
'Accept'] = self.
api_clientapi_client.select_header_accept(
323 [
'application/json'])
329 '/debug/ila_connections',
'GET',
334 post_params=form_params,
335 files=local_var_files,
336 response_type=
'list[InlineResponse2004]',
337 auth_settings=auth_settings,
338 async_req=params.get(
'async_req'),
339 _return_http_data_only=params.get(
'_return_http_data_only'),
340 _preload_content=params.get(
'_preload_content',
True),
341 _request_timeout=params.get(
'_request_timeout'),
342 collection_formats=collection_formats)
345 """Requests a connection to the `hw_server` of this instance # noqa: E501
347 This returns an IP-address and a TCP port to enter into the *remote debugging dialog* in `vivado_lab`. **Only the IP-address that issues this request will be allowed to connect (or the specified IP address).** If there is already an open debug connection to the specified instance, the existing data will be returned. That means, to debug the same instance on a different client, the connection must be deleted first. Due to ongoing Hardware Development it is possible that there are more than one FPGA visible in the debug connection (some FPGAs share a JTAG probe via a JTAG chain). **You are only allowed to interact with the device that is stated in the `device` value in the response from the server.** (The Resource Manager assures that the devices in a JTAG chain are only given to members of the same project, so if you interact with other devices, you will disturb your direct colleges). # noqa: E501
348 This method makes a synchronous HTTP request by default. To make an
349 asynchronous HTTP request, please pass async_req=True
350 >>> thread = api.cf_manager_rest_api_get_debug_connection(username, password, instance_id, async_req=True)
351 >>> result = thread.get()
353 :param async_req bool
354 :param str username: OpenStack username (required)
355 :param str password: OpenStack password (required)
356 :param str instance_id: ROLE instance unique identifier (required)
357 :param str ip_address: IPv4 address of the Debuging client if different from requesting client (only this addres will be allowed to connect).
358 :return: InlineResponse2003
359 If the method is called asynchronously,
360 returns the request thread.
362 kwargs[
'_return_http_data_only'] =
True
363 if kwargs.get(
'async_req'):
370 """Requests a connection to the `hw_server` of this instance # noqa: E501
372 This returns an IP-address and a TCP port to enter into the *remote debugging dialog* in `vivado_lab`. **Only the IP-address that issues this request will be allowed to connect (or the specified IP address).** If there is already an open debug connection to the specified instance, the existing data will be returned. That means, to debug the same instance on a different client, the connection must be deleted first. Due to ongoing Hardware Development it is possible that there are more than one FPGA visible in the debug connection (some FPGAs share a JTAG probe via a JTAG chain). **You are only allowed to interact with the device that is stated in the `device` value in the response from the server.** (The Resource Manager assures that the devices in a JTAG chain are only given to members of the same project, so if you interact with other devices, you will disturb your direct colleges). # noqa: E501
373 This method makes a synchronous HTTP request by default. To make an
374 asynchronous HTTP request, please pass async_req=True
375 >>> thread = api.cf_manager_rest_api_get_debug_connection_with_http_info(username, password, instance_id, async_req=True)
376 >>> result = thread.get()
378 :param async_req bool
379 :param str username: OpenStack username (required)
380 :param str password: OpenStack password (required)
381 :param str instance_id: ROLE instance unique identifier (required)
382 :param str ip_address: IPv4 address of the Debuging client if different from requesting client (only this addres will be allowed to connect).
383 :return: InlineResponse2003
384 If the method is called asynchronously,
385 returns the request thread.
388 all_params = [
'username',
'password',
'instance_id',
'ip_address']
389 all_params.append(
'async_req')
390 all_params.append(
'_return_http_data_only')
391 all_params.append(
'_preload_content')
392 all_params.append(
'_request_timeout')
395 for key, val
in six.iteritems(params[
'kwargs']):
396 if key
not in all_params:
398 "Got an unexpected keyword argument '%s'"
399 " to method cf_manager_rest_api_get_debug_connection" % key
404 if (
'username' not in params
or
405 params[
'username']
is None):
406 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_get_debug_connection`")
408 if (
'password' not in params
or
409 params[
'password']
is None):
410 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_get_debug_connection`")
412 if (
'instance_id' not in params
or
413 params[
'instance_id']
is None):
414 raise ValueError(
"Missing the required parameter `instance_id` when calling `cf_manager_rest_api_get_debug_connection`")
416 collection_formats = {}
419 if 'instance_id' in params:
420 path_params[
'instance_id'] = params[
'instance_id']
423 if 'username' in params:
424 query_params.append((
'username', params[
'username']))
425 if 'password' in params:
426 query_params.append((
'password', params[
'password']))
427 if 'ip_address' in params:
428 query_params.append((
'ip_address', params[
'ip_address']))
437 header_params[
'Accept'] = self.
api_clientapi_client.select_header_accept(
438 [
'application/json'])
444 '/debug/ila_connection/{instance_id}',
'GET',
449 post_params=form_params,
450 files=local_var_files,
451 response_type=
'InlineResponse2003',
452 auth_settings=auth_settings,
453 async_req=params.get(
'async_req'),
454 _return_http_data_only=params.get(
'_return_http_data_only'),
455 _preload_content=params.get(
'_preload_content',
True),
456 _request_timeout=params.get(
'_request_timeout'),
457 collection_formats=collection_formats)
460 """Requests network runtime information of all instances # noqa: E501
462 Requests and returns the status information of the Network Routing Core of all instances in this cluster. The call returns two lists, that contain both the same content, just differently sorted (one ascending by instance id, one ascending by rank id). `Attention:` There may be a delay of a few seconds until the counters are updated after the packets were processed. # noqa: E501
463 This method makes a synchronous HTTP request by default. To make an
464 asynchronous HTTP request, please pass async_req=True
465 >>> thread = api.cf_manager_rest_api_get_flight_recorder_cluster(username, password, cluster_id, async_req=True)
466 >>> result = thread.get()
468 :param async_req bool
469 :param str username: OpenStack username (required)
470 :param str password: OpenStack password (required)
471 :param int cluster_id: ID of a cluster (required)
472 :return: InlineResponse2002
473 If the method is called asynchronously,
474 returns the request thread.
476 kwargs[
'_return_http_data_only'] =
True
477 if kwargs.get(
'async_req'):
484 """Requests network runtime information of all instances # noqa: E501
486 Requests and returns the status information of the Network Routing Core of all instances in this cluster. The call returns two lists, that contain both the same content, just differently sorted (one ascending by instance id, one ascending by rank id). `Attention:` There may be a delay of a few seconds until the counters are updated after the packets were processed. # noqa: E501
487 This method makes a synchronous HTTP request by default. To make an
488 asynchronous HTTP request, please pass async_req=True
489 >>> thread = api.cf_manager_rest_api_get_flight_recorder_cluster_with_http_info(username, password, cluster_id, async_req=True)
490 >>> result = thread.get()
492 :param async_req bool
493 :param str username: OpenStack username (required)
494 :param str password: OpenStack password (required)
495 :param int cluster_id: ID of a cluster (required)
496 :return: InlineResponse2002
497 If the method is called asynchronously,
498 returns the request thread.
501 all_params = [
'username',
'password',
'cluster_id']
502 all_params.append(
'async_req')
503 all_params.append(
'_return_http_data_only')
504 all_params.append(
'_preload_content')
505 all_params.append(
'_request_timeout')
508 for key, val
in six.iteritems(params[
'kwargs']):
509 if key
not in all_params:
511 "Got an unexpected keyword argument '%s'"
512 " to method cf_manager_rest_api_get_flight_recorder_cluster" % key
517 if (
'username' not in params
or
518 params[
'username']
is None):
519 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_get_flight_recorder_cluster`")
521 if (
'password' not in params
or
522 params[
'password']
is None):
523 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_get_flight_recorder_cluster`")
525 if (
'cluster_id' not in params
or
526 params[
'cluster_id']
is None):
527 raise ValueError(
"Missing the required parameter `cluster_id` when calling `cf_manager_rest_api_get_flight_recorder_cluster`")
529 collection_formats = {}
532 if 'cluster_id' in params:
533 path_params[
'cluster_id'] = params[
'cluster_id']
536 if 'username' in params:
537 query_params.append((
'username', params[
'username']))
538 if 'password' in params:
539 query_params.append((
'password', params[
'password']))
548 header_params[
'Accept'] = self.
api_clientapi_client.select_header_accept(
549 [
'application/json'])
555 '/clusters/{cluster_id}/flight_recorder_data',
'GET',
560 post_params=form_params,
561 files=local_var_files,
562 response_type=
'InlineResponse2002',
563 auth_settings=auth_settings,
564 async_req=params.get(
'async_req'),
565 _return_http_data_only=params.get(
'_return_http_data_only'),
566 _preload_content=params.get(
'_preload_content',
True),
567 _request_timeout=params.get(
'_request_timeout'),
568 collection_formats=collection_formats)
571 """Requests network runtime information # noqa: E501
573 Requests and returns the status information of the Network Routing Core of this FPGA instance. `Attention:` There may be a delay of a few seconds until the counters are updated after the packets were processed. # noqa: E501
574 This method makes a synchronous HTTP request by default. To make an
575 asynchronous HTTP request, please pass async_req=True
576 >>> thread = api.cf_manager_rest_api_get_flight_recorder_instance(username, password, instance_id, async_req=True)
577 >>> result = thread.get()
579 :param async_req bool
580 :param str username: OpenStack username (required)
581 :param str password: OpenStack password (required)
582 :param str instance_id: ROLE instance unique identifier (required)
584 If the method is called asynchronously,
585 returns the request thread.
587 kwargs[
'_return_http_data_only'] =
True
588 if kwargs.get(
'async_req'):
595 """Requests network runtime information # noqa: E501
597 Requests and returns the status information of the Network Routing Core of this FPGA instance. `Attention:` There may be a delay of a few seconds until the counters are updated after the packets were processed. # noqa: E501
598 This method makes a synchronous HTTP request by default. To make an
599 asynchronous HTTP request, please pass async_req=True
600 >>> thread = api.cf_manager_rest_api_get_flight_recorder_instance_with_http_info(username, password, instance_id, async_req=True)
601 >>> result = thread.get()
603 :param async_req bool
604 :param str username: OpenStack username (required)
605 :param str password: OpenStack password (required)
606 :param str instance_id: ROLE instance unique identifier (required)
608 If the method is called asynchronously,
609 returns the request thread.
612 all_params = [
'username',
'password',
'instance_id']
613 all_params.append(
'async_req')
614 all_params.append(
'_return_http_data_only')
615 all_params.append(
'_preload_content')
616 all_params.append(
'_request_timeout')
619 for key, val
in six.iteritems(params[
'kwargs']):
620 if key
not in all_params:
622 "Got an unexpected keyword argument '%s'"
623 " to method cf_manager_rest_api_get_flight_recorder_instance" % key
628 if (
'username' not in params
or
629 params[
'username']
is None):
630 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_get_flight_recorder_instance`")
632 if (
'password' not in params
or
633 params[
'password']
is None):
634 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_get_flight_recorder_instance`")
636 if (
'instance_id' not in params
or
637 params[
'instance_id']
is None):
638 raise ValueError(
"Missing the required parameter `instance_id` when calling `cf_manager_rest_api_get_flight_recorder_instance`")
640 collection_formats = {}
643 if 'instance_id' in params:
644 path_params[
'instance_id'] = params[
'instance_id']
647 if 'username' in params:
648 query_params.append((
'username', params[
'username']))
649 if 'password' in params:
650 query_params.append((
'password', params[
'password']))
659 header_params[
'Accept'] = self.
api_clientapi_client.select_header_accept(
660 [
'application/json'])
666 '/instances/{instance_id}/flight_recorder_data',
'GET',
671 post_params=form_params,
672 files=local_var_files,
673 response_type=
'list[str]',
674 auth_settings=auth_settings,
675 async_req=params.get(
'async_req'),
676 _return_http_data_only=params.get(
'_return_http_data_only'),
677 _preload_content=params.get(
'_preload_content',
True),
678 _request_timeout=params.get(
'_request_timeout'),
679 collection_formats=collection_formats)
def __init__(self, api_client=None)
def cf_manager_rest_api_get_all_debug_connections(self, username, password, **kwargs)
def cf_manager_rest_api_get_flight_recorder_instance(self, username, password, instance_id, **kwargs)
def cf_manager_rest_api_get_flight_recorder_cluster_with_http_info(self, username, password, cluster_id, **kwargs)
def cf_manager_rest_api_delete_debug_connection_with_http_info(self, username, password, instance_id, **kwargs)
def cf_manager_rest_api_delete_debug_connection(self, username, password, instance_id, **kwargs)
def cf_manager_rest_api_get_debug_connection(self, username, password, instance_id, **kwargs)
def cf_manager_rest_api_get_flight_recorder_instance_with_http_info(self, username, password, instance_id, **kwargs)
def cf_manager_rest_api_get_all_debug_connections_of_user_with_http_info(self, username, password, **kwargs)
def cf_manager_rest_api_get_debug_connection_with_http_info(self, username, password, instance_id, **kwargs)
def cf_manager_rest_api_get_all_debug_connections_with_http_info(self, username, password, **kwargs)
def cf_manager_rest_api_get_all_debug_connections_of_user(self, username, password, **kwargs)
def cf_manager_rest_api_get_flight_recorder_cluster(self, username, password, cluster_id, **kwargs)