Class: VSphereAutomation::Appliance::NetworkingProxyApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-appliance/api/networking_proxy_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NetworkingProxyApi

Returns a new instance of NetworkingProxyApi.



16
17
18
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#delete(protocol, opts = {}) ⇒ |VapiStdErrorsErrorError|nil

Deletes a proxy configuration for a specific protocol.

Parameters:

  • protocol —

    ID whose proxy is to be deleted.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 23

def delete(protocol, opts = {})
  delete_with_http_info(protocol, opts)
  nil
end

#delete_with_http_info(protocol, opts = {}) ⇒ Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deletes a proxy configuration for a specific protocol.

Parameters:

  • protocol —

    ID whose proxy is to be deleted.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 33

def delete_with_http_info(protocol, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingProxyApi.delete ...'
  end
  # verify the required parameter 'protocol' is set
  if @api_client.config.client_side_validation && protocol.nil?
    fail ArgumentError, "Missing the required parameter 'protocol' when calling NetworkingProxyApi.delete"
  end
  # resource path
  local_var_path = '/appliance/networking/proxy/{protocol}'.sub('{' + 'protocol' + '}', protocol.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkingProxyApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(protocol, opts = {}) ⇒ ApplianceNetworkingProxyResult|VapiStdErrorsErrorError|

Gets the proxy configuration for a specific protocol.

Parameters:

  • protocol —

    The protocol whose proxy configuration is requested.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



73
74
75
76
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 73

def get(protocol, opts = {})
  data, _status_code, _headers = get_with_http_info(protocol, opts)
  data
end

#get_with_http_info(protocol, opts = {}) ⇒ Array<(ApplianceNetworkingProxyResult|VapiStdErrorsErrorError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Gets the proxy configuration for a specific protocol.

Parameters:

  • protocol —

    The protocol whose proxy configuration is requested.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 83

def get_with_http_info(protocol, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingProxyApi.get ...'
  end
  # verify the required parameter 'protocol' is set
  if @api_client.config.client_side_validation && protocol.nil?
    fail ArgumentError, "Missing the required parameter 'protocol' when calling NetworkingProxyApi.get"
  end
  # resource path
  local_var_path = '/appliance/networking/proxy/{protocol}'.sub('{' + 'protocol' + '}', protocol.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Appliance::ApplianceNetworkingProxyResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkingProxyApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ ApplianceNetworkingProxyListResult|VapiStdErrorsErrorError|

Gets proxy configuration for all configured protocols.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



126
127
128
129
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 126

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(ApplianceNetworkingProxyListResult|VapiStdErrorsErrorError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Gets proxy configuration for all configured protocols.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 135

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingProxyApi.list ...'
  end
  # resource path
  local_var_path = '/appliance/networking/proxy'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Appliance::ApplianceNetworkingProxyListResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkingProxyApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set(protocol, request_body, opts = {}) ⇒ |VapiStdErrorsErrorError|nil

Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required.

Parameters:

  • protocol —

    The protocol for which proxy should be set.

  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



176
177
178
179
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 176

def set(protocol, request_body, opts = {})
  set_with_http_info(protocol, request_body, opts)
  nil
end

#set_with_http_info(protocol, request_body, opts = {}) ⇒ Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required.

Parameters:

  • protocol —

    The protocol for which proxy should be set.

  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 187

def set_with_http_info(protocol, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingProxyApi.set ...'
  end
  # verify the required parameter 'protocol' is set
  if @api_client.config.client_side_validation && protocol.nil?
    fail ArgumentError, "Missing the required parameter 'protocol' when calling NetworkingProxyApi.set"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling NetworkingProxyApi.set"
  end
  # resource path
  local_var_path = '/appliance/networking/proxy/{protocol}'.sub('{' + 'protocol' + '}', protocol.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkingProxyApi#set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test(protocol, action, request_body, opts = {}) ⇒ ApplianceNetworkingProxyTestResult|VapiStdErrorsErrorError|

Tests a proxy configuration by testing the connection to the proxy server and test host.

Parameters:

  • protocol —

    Protocol whose proxy is to be tested.

  • action —

    action&#x3D;test

  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



235
236
237
238
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 235

def test(protocol, action, request_body, opts = {})
  data, _status_code, _headers = test_with_http_info(protocol, action, request_body, opts)
  data
end

#test_with_http_info(protocol, action, request_body, opts = {}) ⇒ Array<(ApplianceNetworkingProxyTestResult|VapiStdErrorsErrorError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Tests a proxy configuration by testing the connection to the proxy server and test host.

Parameters:

  • protocol —

    Protocol whose proxy is to be tested.

  • action —

    action&#x3D;test

  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/vsphere-automation-appliance/api/networking_proxy_api.rb', line 247

def test_with_http_info(protocol, action, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingProxyApi.test ...'
  end
  # verify the required parameter 'protocol' is set
  if @api_client.config.client_side_validation && protocol.nil?
    fail ArgumentError, "Missing the required parameter 'protocol' when calling NetworkingProxyApi.test"
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling NetworkingProxyApi.test"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['test'].include?(action)
    fail ArgumentError, "invalid value for 'action', must be one of test"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling NetworkingProxyApi.test"
  end
  # resource path
  local_var_path = '/appliance/networking/proxy/{protocol}'.sub('{' + 'protocol' + '}', protocol.to_s)

  # query parameters
  query_params = {}
  query_params[:'action'] = action

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Appliance::ApplianceNetworkingProxyTestResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkingProxyApi#test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end