class Ionoscloud::LanApi
Attributes
Public Class Methods
# File lib/ionoscloud/api/lan_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete a Lan
. Removes the specific Lan
@param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Object]
# File lib/ionoscloud/api/lan_api.rb, line 31 def datacenters_lans_delete(datacenter_id, lan_id, opts = {}) data, _status_code, _headers = datacenters_lans_delete_with_http_info(datacenter_id, lan_id, opts) data end
Delete a Lan
. Removes the specific Lan
@param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Object
, Integer, Hash)>] Object
data, response status code and response headers
# File lib/ionoscloud/api/lan_api.rb, line 45 def datacenters_lans_delete_with_http_info(datacenter_id, lan_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_delete ...' end # verify the required parameter 'datacenter_id' is set if @api_client.config.client_side_validation && datacenter_id.nil? fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_delete" end # verify the required parameter 'lan_id' is set if @api_client.config.client_side_validation && lan_id.nil? fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_delete" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_delete, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_delete, must be greater than or equal to 0.' end # resource path local_var_path = '/datacenters/{datacenterId}/lans/{lanId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil? query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Object' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"LanApi.datacenters_lans_delete", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LanApi#datacenters_lans_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieve a Lan
Retrieves the attributes of a given LAN @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Lan]
# File lib/ionoscloud/api/lan_api.rb, line 117 def datacenters_lans_find_by_id(datacenter_id, lan_id, opts = {}) data, _status_code, _headers = datacenters_lans_find_by_id_with_http_info(datacenter_id, lan_id, opts) data end
Retrieve a Lan
Retrieves the attributes of a given LAN @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Lan
, Integer, Hash)>] Lan
data, response status code and response headers
# File lib/ionoscloud/api/lan_api.rb, line 131 def datacenters_lans_find_by_id_with_http_info(datacenter_id, lan_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_find_by_id ...' end # verify the required parameter 'datacenter_id' is set if @api_client.config.client_side_validation && datacenter_id.nil? fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_find_by_id" end # verify the required parameter 'lan_id' is set if @api_client.config.client_side_validation && lan_id.nil? fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_find_by_id" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_find_by_id, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_find_by_id, must be greater than or equal to 0.' end # resource path local_var_path = '/datacenters/{datacenterId}/lans/{lanId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil? query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Lan' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"LanApi.datacenters_lans_find_by_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LanApi#datacenters_lans_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Lans
Retrieve a list of LANs within the datacenter @param datacenter_id [String] The unique ID of the datacenter @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @option opts [Integer] :offset the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (default to 0) @option opts [Integer] :limit the maximum number of elements to return (use together with <code>offset</code> for pagination) (default to 1000) @return [Lans]
# File lib/ionoscloud/api/lan_api.rb, line 204 def datacenters_lans_get(datacenter_id, opts = {}) data, _status_code, _headers = datacenters_lans_get_with_http_info(datacenter_id, opts) data end
List Lans
Retrieve a list of LANs within the datacenter @param datacenter_id [String] The unique ID of the datacenter @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @option opts [Integer] :offset the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) @option opts [Integer] :limit the maximum number of elements to return (use together with <code>offset</code> for pagination) @return [Array<(Lans
, Integer, Hash)>] Lans
data, response status code and response headers
# File lib/ionoscloud/api/lan_api.rb, line 219 def datacenters_lans_get_with_http_info(datacenter_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_get ...' end # verify the required parameter 'datacenter_id' is set if @api_client.config.client_side_validation && datacenter_id.nil? fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_get" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_get, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_get, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0 fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling LanApi.datacenters_lans_get, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 10000 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling LanApi.datacenters_lans_get, must be smaller than or equal to 10000.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling LanApi.datacenters_lans_get, must be greater than or equal to 1.' end # resource path local_var_path = '/datacenters/{datacenterId}/lans'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil? query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Lans' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"LanApi.datacenters_lans_get", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LanApi#datacenters_lans_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieve a nic attached to lan This will retrieve the properties of an attached nic. @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param nic_id [String] The unique ID of the NIC @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Nic]
# File lib/ionoscloud/api/lan_api.rb, line 302 def datacenters_lans_nics_find_by_id(datacenter_id, lan_id, nic_id, opts = {}) data, _status_code, _headers = datacenters_lans_nics_find_by_id_with_http_info(datacenter_id, lan_id, nic_id, opts) data end
Retrieve a nic attached to lan This will retrieve the properties of an attached nic. @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param nic_id [String] The unique ID of the NIC @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Nic
, Integer, Hash)>] Nic
data, response status code and response headers
# File lib/ionoscloud/api/lan_api.rb, line 317 def datacenters_lans_nics_find_by_id_with_http_info(datacenter_id, lan_id, nic_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_nics_find_by_id ...' end # verify the required parameter 'datacenter_id' is set if @api_client.config.client_side_validation && datacenter_id.nil? fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_nics_find_by_id" end # verify the required parameter 'lan_id' is set if @api_client.config.client_side_validation && lan_id.nil? fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_nics_find_by_id" end # verify the required parameter 'nic_id' is set if @api_client.config.client_side_validation && nic_id.nil? fail ArgumentError, "Missing the required parameter 'nic_id' when calling LanApi.datacenters_lans_nics_find_by_id" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_nics_find_by_id, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_nics_find_by_id, must be greater than or equal to 0.' end # resource path local_var_path = '/datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s)).sub('{' + 'nicId' + '}', CGI.escape(nic_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil? query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Nic' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"LanApi.datacenters_lans_nics_find_by_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LanApi#datacenters_lans_nics_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Lan
Members You can retrieve a list of nics attached to a lan @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @option opts [Integer] :offset the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (default to 0) @option opts [Integer] :limit the maximum number of elements to return (use together with <code>offset</code> for pagination) (default to 1000) @return [LanNics]
# File lib/ionoscloud/api/lan_api.rb, line 395 def datacenters_lans_nics_get(datacenter_id, lan_id, opts = {}) data, _status_code, _headers = datacenters_lans_nics_get_with_http_info(datacenter_id, lan_id, opts) data end
List Lan
Members You can retrieve a list of nics attached to a lan @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @option opts [Integer] :offset the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) @option opts [Integer] :limit the maximum number of elements to return (use together with <code>offset</code> for pagination) @return [Array<(LanNics
, Integer, Hash)>] LanNics
data, response status code and response headers
# File lib/ionoscloud/api/lan_api.rb, line 411 def datacenters_lans_nics_get_with_http_info(datacenter_id, lan_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_nics_get ...' end # verify the required parameter 'datacenter_id' is set if @api_client.config.client_side_validation && datacenter_id.nil? fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_nics_get" end # verify the required parameter 'lan_id' is set if @api_client.config.client_side_validation && lan_id.nil? fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_nics_get" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_nics_get, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_nics_get, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0 fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling LanApi.datacenters_lans_nics_get, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 10000 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling LanApi.datacenters_lans_nics_get, must be smaller than or equal to 10000.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling LanApi.datacenters_lans_nics_get, must be greater than or equal to 1.' end # resource path local_var_path = '/datacenters/{datacenterId}/lans/{lanId}/nics'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil? query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'LanNics' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"LanApi.datacenters_lans_nics_get", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LanApi#datacenters_lans_nics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach a nic This will attach a pre-existing nic to a lan. @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param nic [Nic] Nic
to be attached @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Nic]
# File lib/ionoscloud/api/lan_api.rb, line 498 def datacenters_lans_nics_post(datacenter_id, lan_id, nic, opts = {}) data, _status_code, _headers = datacenters_lans_nics_post_with_http_info(datacenter_id, lan_id, nic, opts) data end
Attach a nic This will attach a pre-existing nic to a lan. @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param nic [Nic] Nic
to be attached @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Nic
, Integer, Hash)>] Nic
data, response status code and response headers
# File lib/ionoscloud/api/lan_api.rb, line 513 def datacenters_lans_nics_post_with_http_info(datacenter_id, lan_id, nic, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_nics_post ...' end # verify the required parameter 'datacenter_id' is set if @api_client.config.client_side_validation && datacenter_id.nil? fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_nics_post" end # verify the required parameter 'lan_id' is set if @api_client.config.client_side_validation && lan_id.nil? fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_nics_post" end # verify the required parameter 'nic' is set if @api_client.config.client_side_validation && nic.nil? fail ArgumentError, "Missing the required parameter 'nic' when calling LanApi.datacenters_lans_nics_post" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_nics_post, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_nics_post, must be greater than or equal to 0.' end # resource path local_var_path = '/datacenters/{datacenterId}/lans/{lanId}/nics'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil? query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil? # header parameters header_params = opts[: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']) header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(nic) # return_type return_type = opts[:debug_return_type] || 'Nic' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"LanApi.datacenters_lans_nics_post", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LanApi#datacenters_lans_nics_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Partially modify a Lan
You can use update attributes of a resource @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param lan [LanProperties] Modified Lan
@param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Lan]
# File lib/ionoscloud/api/lan_api.rb, line 592 def datacenters_lans_patch(datacenter_id, lan_id, lan, opts = {}) data, _status_code, _headers = datacenters_lans_patch_with_http_info(datacenter_id, lan_id, lan, opts) data end
Partially modify a Lan
You can use update attributes of a resource @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param lan [LanProperties] Modified Lan
@param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Lan
, Integer, Hash)>] Lan
data, response status code and response headers
# File lib/ionoscloud/api/lan_api.rb, line 607 def datacenters_lans_patch_with_http_info(datacenter_id, lan_id, lan, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_patch ...' end # verify the required parameter 'datacenter_id' is set if @api_client.config.client_side_validation && datacenter_id.nil? fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_patch" end # verify the required parameter 'lan_id' is set if @api_client.config.client_side_validation && lan_id.nil? fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_patch" end # verify the required parameter 'lan' is set if @api_client.config.client_side_validation && lan.nil? fail ArgumentError, "Missing the required parameter 'lan' when calling LanApi.datacenters_lans_patch" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_patch, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_patch, must be greater than or equal to 0.' end # resource path local_var_path = '/datacenters/{datacenterId}/lans/{lanId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil? query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil? # header parameters header_params = opts[: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']) header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(lan) # return_type return_type = opts[:debug_return_type] || 'Lan' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"LanApi.datacenters_lans_patch", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LanApi#datacenters_lans_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a Lan
Creates a LAN within the datacenter @param datacenter_id [String] The unique ID of the datacenter @param lan [LanPost] Lan
to be created @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [LanPost]
# File lib/ionoscloud/api/lan_api.rb, line 685 def datacenters_lans_post(datacenter_id, lan, opts = {}) data, _status_code, _headers = datacenters_lans_post_with_http_info(datacenter_id, lan, opts) data end
Create a Lan
Creates a LAN within the datacenter @param datacenter_id [String] The unique ID of the datacenter @param lan [LanPost] Lan
to be created @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(LanPost
, Integer, Hash)>] LanPost
data, response status code and response headers
# File lib/ionoscloud/api/lan_api.rb, line 699 def datacenters_lans_post_with_http_info(datacenter_id, lan, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_post ...' end # verify the required parameter 'datacenter_id' is set if @api_client.config.client_side_validation && datacenter_id.nil? fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_post" end # verify the required parameter 'lan' is set if @api_client.config.client_side_validation && lan.nil? fail ArgumentError, "Missing the required parameter 'lan' when calling LanApi.datacenters_lans_post" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_post, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_post, must be greater than or equal to 0.' end # resource path local_var_path = '/datacenters/{datacenterId}/lans'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil? query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil? # header parameters header_params = opts[: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']) header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(lan) # return_type return_type = opts[:debug_return_type] || 'LanPost' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"LanApi.datacenters_lans_post", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LanApi#datacenters_lans_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Modify a Lan
You can use update attributes of a resource @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param lan [Lan] Modified Lan
@param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Lan]
# File lib/ionoscloud/api/lan_api.rb, line 774 def datacenters_lans_put(datacenter_id, lan_id, lan, opts = {}) data, _status_code, _headers = datacenters_lans_put_with_http_info(datacenter_id, lan_id, lan, opts) data end
Modify a Lan
You can use update attributes of a resource @param datacenter_id [String] The unique ID of the datacenter @param lan_id [String] The unique ID of the LAN @param lan [Lan] Modified Lan
@param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on @option opts [Integer] :x_contract_number Users
having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Lan
, Integer, Hash)>] Lan
data, response status code and response headers
# File lib/ionoscloud/api/lan_api.rb, line 789 def datacenters_lans_put_with_http_info(datacenter_id, lan_id, lan, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LanApi.datacenters_lans_put ...' end # verify the required parameter 'datacenter_id' is set if @api_client.config.client_side_validation && datacenter_id.nil? fail ArgumentError, "Missing the required parameter 'datacenter_id' when calling LanApi.datacenters_lans_put" end # verify the required parameter 'lan_id' is set if @api_client.config.client_side_validation && lan_id.nil? fail ArgumentError, "Missing the required parameter 'lan_id' when calling LanApi.datacenters_lans_put" end # verify the required parameter 'lan' is set if @api_client.config.client_side_validation && lan.nil? fail ArgumentError, "Missing the required parameter 'lan' when calling LanApi.datacenters_lans_put" end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_put, must be smaller than or equal to 10.' end if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0 fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LanApi.datacenters_lans_put, must be greater than or equal to 0.' end # resource path local_var_path = '/datacenters/{datacenterId}/lans/{lanId}'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'lanId' + '}', CGI.escape(lan_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil? query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil? # header parameters header_params = opts[: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']) header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(lan) # return_type return_type = opts[:debug_return_type] || 'Lan' # auth_names auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication'] new_options = opts.merge( :operation => :"LanApi.datacenters_lans_put", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LanApi#datacenters_lans_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end