class VSphereAutomation::Appliance::NetworkingProxyApi
Attributes
Public Class Methods
# File lib/vsphere-automation-appliance/api/networking_proxy_api.rb, line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Deletes a proxy configuration for a specific protocol. @param protocol ID whose proxy is to be deleted. @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]
# File lib/vsphere-automation-appliance/api/networking_proxy_api.rb, line 23 def delete(protocol, opts = {}) delete_with_http_info(protocol, opts) nil end
Deletes a proxy configuration for a specific protocol. @api private @param protocol ID whose proxy is to be deleted. @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>] nil, response status code and response headers
# 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
Gets the proxy configuration for a specific protocol. @param protocol The protocol whose proxy configuration is requested. @param [Hash] opts the optional parameters @return [ApplianceNetworkingProxyResult|VapiStdErrorsErrorError|]
# 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
Gets the proxy configuration for a specific protocol. @api private @param protocol The protocol whose proxy configuration is requested. @param [Hash] opts the optional parameters @return [Array<(ApplianceNetworkingProxyResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers
# 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
Gets proxy configuration for all configured protocols. @param [Hash] opts the optional parameters @return [ApplianceNetworkingProxyListResult|VapiStdErrorsErrorError|]
# 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
Gets proxy configuration for all configured protocols. @api private @param [Hash] opts the optional parameters @return [Array<(ApplianceNetworkingProxyListResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers
# 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
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. @param protocol The protocol for which proxy should be set. @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|nil]
# 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
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. @api private @param protocol The protocol for which proxy should be set. @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|nil, Fixnum, Hash)>] nil, response status code and response headers
# 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
Tests a proxy configuration by testing the connection to the proxy server and test host. @param protocol Protocol whose proxy is to be tested. @param request_body @param [Hash] opts the optional parameters @return [ApplianceNetworkingProxyTestResult|VapiStdErrorsErrorError|]
# File lib/vsphere-automation-appliance/api/networking_proxy_api.rb, line 234 def test(protocol, request_body, opts = {}) data, _status_code, _headers = test_with_http_info(protocol, request_body, opts) data end
Tests a proxy configuration by testing the connection to the proxy server and test host. @api private @param protocol Protocol whose proxy is to be tested. @param request_body @param [Hash] opts the optional parameters @return [Array<(ApplianceNetworkingProxyTestResult|VapiStdErrorsErrorError|, Fixnum, Hash)>] data, response status code and response headers
# File lib/vsphere-automation-appliance/api/networking_proxy_api.rb, line 245 def test_with_http_info(protocol, 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 '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}?action=test'.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(: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