cloudFPGA (cF) API  1.0
The documentation of the source code of cloudFPGA (cF)
debug_api.py
Go to the documentation of this file.
1 # coding: utf-8
2 
3 """
4  cloudFPGA Resource Manager API
5 
6  No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
7 
8  OpenAPI spec version: 0.8
9 
10  Generated by: https://github.com/swagger-api/swagger-codegen.git
11 """
12 
13 from __future__ import absolute_import
14 
15 import re # noqa: F401
16 
17 # python 2 and python 3 compatibility library
18 import six
19 
20 from swagger_client.api_client import ApiClient
21 
22 
23 class DebugApi(object):
24  """NOTE: This class is auto generated by the swagger code generator program.
25 
26  Do not edit the class manually.
27  Ref: https://github.com/swagger-api/swagger-codegen
28  """
29 
30  def __init__(self, api_client=None):
31  if api_client is None:
32  api_client = ApiClient()
33  self.api_clientapi_client = api_client
34 
35  def cf_manager_rest_api_delete_debug_connection(self, username, password, instance_id, **kwargs): # noqa: E501
36  """Deletes an existing connection to the `hw_server` of this instance # noqa: E501
37 
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()
43 
44  :param async_req bool
45  :param str username: OpenStack username (required)
46  :param str password: OpenStack password (required)
47  :param str instance_id: ROLE instance unique identifier (required)
48  :return: None
49  If the method is called asynchronously,
50  returns the request thread.
51  """
52  kwargs['_return_http_data_only'] = True
53  if kwargs.get('async_req'):
54  return self.cf_manager_rest_api_delete_debug_connection_with_http_infocf_manager_rest_api_delete_debug_connection_with_http_info(username, password, instance_id, **kwargs) # noqa: E501
55  else:
56  (data) = self.cf_manager_rest_api_delete_debug_connection_with_http_infocf_manager_rest_api_delete_debug_connection_with_http_info(username, password, instance_id, **kwargs) # noqa: E501
57  return data
58 
59  def cf_manager_rest_api_delete_debug_connection_with_http_info(self, username, password, instance_id, **kwargs): # noqa: E501
60  """Deletes an existing connection to the `hw_server` of this instance # noqa: E501
61 
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()
67 
68  :param async_req bool
69  :param str username: OpenStack username (required)
70  :param str password: OpenStack password (required)
71  :param str instance_id: ROLE instance unique identifier (required)
72  :return: None
73  If the method is called asynchronously,
74  returns the request thread.
75  """
76 
77  all_params = ['username', 'password', 'instance_id'] # noqa: E501
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')
82 
83  params = locals()
84  for key, val in six.iteritems(params['kwargs']):
85  if key not in all_params:
86  raise TypeError(
87  "Got an unexpected keyword argument '%s'"
88  " to method cf_manager_rest_api_delete_debug_connection" % key
89  )
90  params[key] = val
91  del params['kwargs']
92  # verify the required parameter 'username' is set
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`") # noqa: E501
96  # verify the required parameter 'password' is set
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`") # noqa: E501
100  # verify the required parameter 'instance_id' is set
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`") # noqa: E501
104 
105  collection_formats = {}
106 
107  path_params = {}
108  if 'instance_id' in params:
109  path_params['instance_id'] = params['instance_id'] # noqa: E501
110 
111  query_params = []
112  if 'username' in params:
113  query_params.append(('username', params['username'])) # noqa: E501
114  if 'password' in params:
115  query_params.append(('password', params['password'])) # noqa: E501
116 
117  header_params = {}
118 
119  form_params = []
120  local_var_files = {}
121 
122  body_params = None
123  # Authentication setting
124  auth_settings = [] # noqa: E501
125 
126  return self.api_clientapi_client.call_api(
127  '/debug/ila_connection/{instance_id}', 'DELETE',
128  path_params,
129  query_params,
130  header_params,
131  body=body_params,
132  post_params=form_params,
133  files=local_var_files,
134  response_type=None, # noqa: E501
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)
141 
142  def cf_manager_rest_api_get_all_debug_connections(self, username, password, **kwargs): # noqa: E501
143  """Requests a list of running `hw_server`s on all instances (admin only) # noqa: E501
144 
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()
149 
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.
156  """
157  kwargs['_return_http_data_only'] = True
158  if kwargs.get('async_req'):
159  return self.cf_manager_rest_api_get_all_debug_connections_with_http_infocf_manager_rest_api_get_all_debug_connections_with_http_info(username, password, **kwargs) # noqa: E501
160  else:
161  (data) = self.cf_manager_rest_api_get_all_debug_connections_with_http_infocf_manager_rest_api_get_all_debug_connections_with_http_info(username, password, **kwargs) # noqa: E501
162  return data
163 
164  def cf_manager_rest_api_get_all_debug_connections_with_http_info(self, username, password, **kwargs): # noqa: E501
165  """Requests a list of running `hw_server`s on all instances (admin only) # noqa: E501
166 
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()
171 
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.
178  """
179 
180  all_params = ['username', 'password'] # noqa: E501
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')
185 
186  params = locals()
187  for key, val in six.iteritems(params['kwargs']):
188  if key not in all_params:
189  raise TypeError(
190  "Got an unexpected keyword argument '%s'"
191  " to method cf_manager_rest_api_get_all_debug_connections" % key
192  )
193  params[key] = val
194  del params['kwargs']
195  # verify the required parameter 'username' is set
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`") # noqa: E501
199  # verify the required parameter 'password' is set
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`") # noqa: E501
203 
204  collection_formats = {}
205 
206  path_params = {}
207 
208  query_params = []
209  if 'username' in params:
210  query_params.append(('username', params['username'])) # noqa: E501
211  if 'password' in params:
212  query_params.append(('password', params['password'])) # noqa: E501
213 
214  header_params = {}
215 
216  form_params = []
217  local_var_files = {}
218 
219  body_params = None
220  # HTTP header `Accept`
221  header_params['Accept'] = self.api_clientapi_client.select_header_accept(
222  ['application/json']) # noqa: E501
223 
224  # Authentication setting
225  auth_settings = [] # noqa: E501
226 
227  return self.api_clientapi_client.call_api(
228  '/debug/open_ila_connections', 'GET',
229  path_params,
230  query_params,
231  header_params,
232  body=body_params,
233  post_params=form_params,
234  files=local_var_files,
235  response_type='list[InlineResponse2004]', # noqa: E501
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)
242 
243  def cf_manager_rest_api_get_all_debug_connections_of_user(self, username, password, **kwargs): # noqa: E501
244  """Returns all open `hw_server` of a user # noqa: E501
245 
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()
250 
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.
257  """
258  kwargs['_return_http_data_only'] = True
259  if kwargs.get('async_req'):
260  return self.cf_manager_rest_api_get_all_debug_connections_of_user_with_http_infocf_manager_rest_api_get_all_debug_connections_of_user_with_http_info(username, password, **kwargs) # noqa: E501
261  else:
262  (data) = self.cf_manager_rest_api_get_all_debug_connections_of_user_with_http_infocf_manager_rest_api_get_all_debug_connections_of_user_with_http_info(username, password, **kwargs) # noqa: E501
263  return data
264 
265  def cf_manager_rest_api_get_all_debug_connections_of_user_with_http_info(self, username, password, **kwargs): # noqa: E501
266  """Returns all open `hw_server` of a user # noqa: E501
267 
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()
272 
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.
279  """
280 
281  all_params = ['username', 'password'] # noqa: E501
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')
286 
287  params = locals()
288  for key, val in six.iteritems(params['kwargs']):
289  if key not in all_params:
290  raise TypeError(
291  "Got an unexpected keyword argument '%s'"
292  " to method cf_manager_rest_api_get_all_debug_connections_of_user" % key
293  )
294  params[key] = val
295  del params['kwargs']
296  # verify the required parameter 'username' is set
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`") # noqa: E501
300  # verify the required parameter 'password' is set
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`") # noqa: E501
304 
305  collection_formats = {}
306 
307  path_params = {}
308 
309  query_params = []
310  if 'username' in params:
311  query_params.append(('username', params['username'])) # noqa: E501
312  if 'password' in params:
313  query_params.append(('password', params['password'])) # noqa: E501
314 
315  header_params = {}
316 
317  form_params = []
318  local_var_files = {}
319 
320  body_params = None
321  # HTTP header `Accept`
322  header_params['Accept'] = self.api_clientapi_client.select_header_accept(
323  ['application/json']) # noqa: E501
324 
325  # Authentication setting
326  auth_settings = [] # noqa: E501
327 
328  return self.api_clientapi_client.call_api(
329  '/debug/ila_connections', 'GET',
330  path_params,
331  query_params,
332  header_params,
333  body=body_params,
334  post_params=form_params,
335  files=local_var_files,
336  response_type='list[InlineResponse2004]', # noqa: E501
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)
343 
344  def cf_manager_rest_api_get_debug_connection(self, username, password, instance_id, **kwargs): # noqa: E501
345  """Requests a connection to the `hw_server` of this instance # noqa: E501
346 
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()
352 
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.
361  """
362  kwargs['_return_http_data_only'] = True
363  if kwargs.get('async_req'):
364  return self.cf_manager_rest_api_get_debug_connection_with_http_infocf_manager_rest_api_get_debug_connection_with_http_info(username, password, instance_id, **kwargs) # noqa: E501
365  else:
366  (data) = self.cf_manager_rest_api_get_debug_connection_with_http_infocf_manager_rest_api_get_debug_connection_with_http_info(username, password, instance_id, **kwargs) # noqa: E501
367  return data
368 
369  def cf_manager_rest_api_get_debug_connection_with_http_info(self, username, password, instance_id, **kwargs): # noqa: E501
370  """Requests a connection to the `hw_server` of this instance # noqa: E501
371 
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()
377 
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.
386  """
387 
388  all_params = ['username', 'password', 'instance_id', 'ip_address'] # noqa: E501
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')
393 
394  params = locals()
395  for key, val in six.iteritems(params['kwargs']):
396  if key not in all_params:
397  raise TypeError(
398  "Got an unexpected keyword argument '%s'"
399  " to method cf_manager_rest_api_get_debug_connection" % key
400  )
401  params[key] = val
402  del params['kwargs']
403  # verify the required parameter 'username' is set
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`") # noqa: E501
407  # verify the required parameter 'password' is set
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`") # noqa: E501
411  # verify the required parameter 'instance_id' is set
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`") # noqa: E501
415 
416  collection_formats = {}
417 
418  path_params = {}
419  if 'instance_id' in params:
420  path_params['instance_id'] = params['instance_id'] # noqa: E501
421 
422  query_params = []
423  if 'username' in params:
424  query_params.append(('username', params['username'])) # noqa: E501
425  if 'password' in params:
426  query_params.append(('password', params['password'])) # noqa: E501
427  if 'ip_address' in params:
428  query_params.append(('ip_address', params['ip_address'])) # noqa: E501
429 
430  header_params = {}
431 
432  form_params = []
433  local_var_files = {}
434 
435  body_params = None
436  # HTTP header `Accept`
437  header_params['Accept'] = self.api_clientapi_client.select_header_accept(
438  ['application/json']) # noqa: E501
439 
440  # Authentication setting
441  auth_settings = [] # noqa: E501
442 
443  return self.api_clientapi_client.call_api(
444  '/debug/ila_connection/{instance_id}', 'GET',
445  path_params,
446  query_params,
447  header_params,
448  body=body_params,
449  post_params=form_params,
450  files=local_var_files,
451  response_type='InlineResponse2003', # noqa: E501
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)
458 
459  def cf_manager_rest_api_get_flight_recorder_cluster(self, username, password, cluster_id, **kwargs): # noqa: E501
460  """Requests network runtime information of all instances # noqa: E501
461 
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()
467 
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.
475  """
476  kwargs['_return_http_data_only'] = True
477  if kwargs.get('async_req'):
478  return self.cf_manager_rest_api_get_flight_recorder_cluster_with_http_infocf_manager_rest_api_get_flight_recorder_cluster_with_http_info(username, password, cluster_id, **kwargs) # noqa: E501
479  else:
480  (data) = self.cf_manager_rest_api_get_flight_recorder_cluster_with_http_infocf_manager_rest_api_get_flight_recorder_cluster_with_http_info(username, password, cluster_id, **kwargs) # noqa: E501
481  return data
482 
483  def cf_manager_rest_api_get_flight_recorder_cluster_with_http_info(self, username, password, cluster_id, **kwargs): # noqa: E501
484  """Requests network runtime information of all instances # noqa: E501
485 
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()
491 
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.
499  """
500 
501  all_params = ['username', 'password', 'cluster_id'] # noqa: E501
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')
506 
507  params = locals()
508  for key, val in six.iteritems(params['kwargs']):
509  if key not in all_params:
510  raise TypeError(
511  "Got an unexpected keyword argument '%s'"
512  " to method cf_manager_rest_api_get_flight_recorder_cluster" % key
513  )
514  params[key] = val
515  del params['kwargs']
516  # verify the required parameter 'username' is set
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`") # noqa: E501
520  # verify the required parameter 'password' is set
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`") # noqa: E501
524  # verify the required parameter 'cluster_id' is set
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`") # noqa: E501
528 
529  collection_formats = {}
530 
531  path_params = {}
532  if 'cluster_id' in params:
533  path_params['cluster_id'] = params['cluster_id'] # noqa: E501
534 
535  query_params = []
536  if 'username' in params:
537  query_params.append(('username', params['username'])) # noqa: E501
538  if 'password' in params:
539  query_params.append(('password', params['password'])) # noqa: E501
540 
541  header_params = {}
542 
543  form_params = []
544  local_var_files = {}
545 
546  body_params = None
547  # HTTP header `Accept`
548  header_params['Accept'] = self.api_clientapi_client.select_header_accept(
549  ['application/json']) # noqa: E501
550 
551  # Authentication setting
552  auth_settings = [] # noqa: E501
553 
554  return self.api_clientapi_client.call_api(
555  '/clusters/{cluster_id}/flight_recorder_data', 'GET',
556  path_params,
557  query_params,
558  header_params,
559  body=body_params,
560  post_params=form_params,
561  files=local_var_files,
562  response_type='InlineResponse2002', # noqa: E501
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)
569 
570  def cf_manager_rest_api_get_flight_recorder_instance(self, username, password, instance_id, **kwargs): # noqa: E501
571  """Requests network runtime information # noqa: E501
572 
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()
578 
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)
583  :return: list[str]
584  If the method is called asynchronously,
585  returns the request thread.
586  """
587  kwargs['_return_http_data_only'] = True
588  if kwargs.get('async_req'):
589  return self.cf_manager_rest_api_get_flight_recorder_instance_with_http_infocf_manager_rest_api_get_flight_recorder_instance_with_http_info(username, password, instance_id, **kwargs) # noqa: E501
590  else:
591  (data) = self.cf_manager_rest_api_get_flight_recorder_instance_with_http_infocf_manager_rest_api_get_flight_recorder_instance_with_http_info(username, password, instance_id, **kwargs) # noqa: E501
592  return data
593 
594  def cf_manager_rest_api_get_flight_recorder_instance_with_http_info(self, username, password, instance_id, **kwargs): # noqa: E501
595  """Requests network runtime information # noqa: E501
596 
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()
602 
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)
607  :return: list[str]
608  If the method is called asynchronously,
609  returns the request thread.
610  """
611 
612  all_params = ['username', 'password', 'instance_id'] # noqa: E501
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')
617 
618  params = locals()
619  for key, val in six.iteritems(params['kwargs']):
620  if key not in all_params:
621  raise TypeError(
622  "Got an unexpected keyword argument '%s'"
623  " to method cf_manager_rest_api_get_flight_recorder_instance" % key
624  )
625  params[key] = val
626  del params['kwargs']
627  # verify the required parameter 'username' is set
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`") # noqa: E501
631  # verify the required parameter 'password' is set
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`") # noqa: E501
635  # verify the required parameter 'instance_id' is set
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`") # noqa: E501
639 
640  collection_formats = {}
641 
642  path_params = {}
643  if 'instance_id' in params:
644  path_params['instance_id'] = params['instance_id'] # noqa: E501
645 
646  query_params = []
647  if 'username' in params:
648  query_params.append(('username', params['username'])) # noqa: E501
649  if 'password' in params:
650  query_params.append(('password', params['password'])) # noqa: E501
651 
652  header_params = {}
653 
654  form_params = []
655  local_var_files = {}
656 
657  body_params = None
658  # HTTP header `Accept`
659  header_params['Accept'] = self.api_clientapi_client.select_header_accept(
660  ['application/json']) # noqa: E501
661 
662  # Authentication setting
663  auth_settings = [] # noqa: E501
664 
665  return self.api_clientapi_client.call_api(
666  '/instances/{instance_id}/flight_recorder_data', 'GET',
667  path_params,
668  query_params,
669  header_params,
670  body=body_params,
671  post_params=form_params,
672  files=local_var_files,
673  response_type='list[str]', # noqa: E501
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 cf_manager_rest_api_get_all_debug_connections(self, username, password, **kwargs)
Definition: debug_api.py:142
def cf_manager_rest_api_get_flight_recorder_instance(self, username, password, instance_id, **kwargs)
Definition: debug_api.py:570
def cf_manager_rest_api_get_flight_recorder_cluster_with_http_info(self, username, password, cluster_id, **kwargs)
Definition: debug_api.py:483
def cf_manager_rest_api_delete_debug_connection_with_http_info(self, username, password, instance_id, **kwargs)
Definition: debug_api.py:59
def cf_manager_rest_api_delete_debug_connection(self, username, password, instance_id, **kwargs)
Definition: debug_api.py:35
def cf_manager_rest_api_get_debug_connection(self, username, password, instance_id, **kwargs)
Definition: debug_api.py:344
def cf_manager_rest_api_get_flight_recorder_instance_with_http_info(self, username, password, instance_id, **kwargs)
Definition: debug_api.py:594
def cf_manager_rest_api_get_all_debug_connections_of_user_with_http_info(self, username, password, **kwargs)
Definition: debug_api.py:265
def cf_manager_rest_api_get_debug_connection_with_http_info(self, username, password, instance_id, **kwargs)
Definition: debug_api.py:369
def cf_manager_rest_api_get_all_debug_connections_with_http_info(self, username, password, **kwargs)
Definition: debug_api.py:164
def cf_manager_rest_api_get_all_debug_connections_of_user(self, username, password, **kwargs)
Definition: debug_api.py:243
def cf_manager_rest_api_get_flight_recorder_cluster(self, username, password, cluster_id, **kwargs)
Definition: debug_api.py:459