Class: LinodeOpenapiClient::NodeBalancersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/api/node_balancers_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NodeBalancersApi

Returns a new instance of NodeBalancersApi.



19
20
21
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_node_balancer(api_version, node_balancer_id, opts = {}) ⇒ Object

Delete a NodeBalancer Deletes a NodeBalancer. __This is a destructive action and cannot be undone.__ Deleting a NodeBalancer will also delete all associated Configs and Nodes, although the backend servers represented by the Nodes will not be changed or removed. Deleting a NodeBalancer will cause you to lose access to the IP Addresses assigned to this NodeBalancer. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers delete 12345 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Returns:

  • (Object) 


28
29
30
31
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 28

def delete_node_balancer(api_version, node_balancer_id, opts = {})
  data, _status_code, _headers = delete_node_balancer_with_http_info(api_version, node_balancer_id, opts)
  data
end

#delete_node_balancer_config(api_version, node_balancer_id, config_id, opts = {}) ⇒ Object

Delete a config Deletes the Config for a port of this NodeBalancer. __This cannot be undone.__ Once completed, this NodeBalancer will no longer respond to requests on the given port. This also deletes all associated NodeBalancerNodes, but the Linodes they were routing traffic to will be unchanged and will not be removed. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers config-delete \ 12345 4567 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

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

    the optional parameters

Returns:

  • (Object) 


103
104
105
106
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 103

def delete_node_balancer_config(api_version, node_balancer_id, config_id, opts = {})
  data, _status_code, _headers = delete_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, opts)
  data
end

#delete_node_balancer_config_node(api_version, node_balancer_id, config_id, node_id, opts = {}) ⇒ Object

Delete a node balancer’s node Deletes a Node from this Config. This backend will no longer receive traffic for the configured port of this NodeBalancer. This does not change or remove the Linode whose address was used in the creation of this Node. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers node-delete \ 12345 4567 54321 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • node_id (Integer) —

    The ID of the Node to access.

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

    the optional parameters

Returns:

  • (Object) 


184
185
186
187
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 184

def delete_node_balancer_config_node(api_version, node_balancer_id, config_id, node_id, opts = {})
  data, _status_code, _headers = delete_node_balancer_config_node_with_http_info(api_version, node_balancer_id, config_id, node_id, opts)
  data
end

#delete_node_balancer_config_node_with_http_info(api_version, node_balancer_id, config_id, node_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a node balancer&#39;s node Deletes a Node from this Config. This backend will no longer receive traffic for the configured port of this NodeBalancer. This does not change or remove the Linode whose address was used in the creation of this Node. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers node-delete \ 12345 4567 54321 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • node_id (Integer) —

    The ID of the Node to access.

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 197

def delete_node_balancer_config_node_with_http_info(api_version, node_balancer_id, config_id, node_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.delete_node_balancer_config_node ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.delete_node_balancer_config_node"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.delete_node_balancer_config_node"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling NodeBalancersApi.delete_node_balancer_config_node"
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling NodeBalancersApi.delete_node_balancer_config_node"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs/{configId}/nodes/{nodeId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s)).sub('{' + 'nodeId' + '}', CGI.escape(node_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # 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] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.delete_node_balancer_config_node",
    :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: NodeBalancersApi#delete_node_balancer_config_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a config Deletes the Config for a port of this NodeBalancer. __This cannot be undone.__ Once completed, this NodeBalancer will no longer respond to requests on the given port. This also deletes all associated NodeBalancerNodes, but the Linodes they were routing traffic to will be unchanged and will not be removed. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers config-delete \ 12345 4567 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
171
172
173
174
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 115

def delete_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.delete_node_balancer_config ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.delete_node_balancer_config"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.delete_node_balancer_config"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling NodeBalancersApi.delete_node_balancer_config"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs/{configId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # 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] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.delete_node_balancer_config",
    :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: NodeBalancersApi#delete_node_balancer_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_node_balancer_with_http_info(api_version, node_balancer_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a NodeBalancer Deletes a NodeBalancer. __This is a destructive action and cannot be undone.__ Deleting a NodeBalancer will also delete all associated Configs and Nodes, although the backend servers represented by the Nodes will not be changed or removed. Deleting a NodeBalancer will cause you to lose access to the IP Addresses assigned to this NodeBalancer. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers delete 12345 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 39

def delete_node_balancer_with_http_info(api_version, node_balancer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.delete_node_balancer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.delete_node_balancer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.delete_node_balancer"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # 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] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.delete_node_balancer",
    :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: NodeBalancersApi#delete_node_balancer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_node_balancer(api_version, node_balancer_id, opts = {}) ⇒ NodeBalancer1

Get a NodeBalancer Returns a single NodeBalancer you can access. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers view 12345 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Returns:



268
269
270
271
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 268

def get_node_balancer(api_version, node_balancer_id, opts = {})
  data, _status_code, _headers = get_node_balancer_with_http_info(api_version, node_balancer_id, opts)
  data
end

#get_node_balancer_config(api_version, node_balancer_id, config_id, opts = {}) ⇒ GetNodeBalancerConfig200Response

Get a config Returns configuration information for a single port of this NodeBalancer. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers config-view \ 12345 4567 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

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

    the optional parameters

Returns:



343
344
345
346
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 343

def get_node_balancer_config(api_version, node_balancer_id, config_id, opts = {})
  data, _status_code, _headers = get_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, opts)
  data
end

#get_node_balancer_config_nodes(api_version, node_balancer_id, config_id, opts = {}) ⇒ GetNodeBalancerConfigNodes200Response

List nodes Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers nodes-list 12345 4567 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the NodeBalancer config to access.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



425
426
427
428
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 425

def get_node_balancer_config_nodes(api_version, node_balancer_id, config_id, opts = {})
  data, _status_code, _headers = get_node_balancer_config_nodes_with_http_info(api_version, node_balancer_id, config_id, opts)
  data
end

#get_node_balancer_config_nodes_with_http_info(api_version, node_balancer_id, config_id, opts = {}) ⇒ Array<(GetNodeBalancerConfigNodes200Response, Integer, Hash)>

List nodes Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers nodes-list 12345 4567 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the NodeBalancer config to access.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 439

def get_node_balancer_config_nodes_with_http_info(api_version, node_balancer_id, config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.get_node_balancer_config_nodes ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.get_node_balancer_config_nodes"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.get_node_balancer_config_nodes"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling NodeBalancersApi.get_node_balancer_config_nodes"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling NodeBalancersApi.get_node_balancer_config_nodes, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling NodeBalancersApi.get_node_balancer_config_nodes, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling NodeBalancersApi.get_node_balancer_config_nodes, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs/{configId}/nodes'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetNodeBalancerConfigNodes200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.get_node_balancer_config_nodes",
    :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: NodeBalancersApi#get_node_balancer_config_nodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, opts = {}) ⇒ Array<(GetNodeBalancerConfig200Response, Integer, Hash)>

Get a config Returns configuration information for a single port of this NodeBalancer. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers config-view \ 12345 4567 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

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

    the optional parameters

Returns:



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 355

def get_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.get_node_balancer_config ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.get_node_balancer_config"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.get_node_balancer_config"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling NodeBalancersApi.get_node_balancer_config"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs/{configId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetNodeBalancerConfig200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.get_node_balancer_config",
    :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: NodeBalancersApi#get_node_balancer_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_node_balancer_configs(api_version, node_balancer_id, opts = {}) ⇒ GetNodeBalancerConfigs200Response

List configs Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port. For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers configs-list 12345 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



522
523
524
525
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 522

def get_node_balancer_configs(api_version, node_balancer_id, opts = {})
  data, _status_code, _headers = get_node_balancer_configs_with_http_info(api_version, node_balancer_id, opts)
  data
end

#get_node_balancer_configs_with_http_info(api_version, node_balancer_id, opts = {}) ⇒ Array<(GetNodeBalancerConfigs200Response, Integer, Hash)>

List configs Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port. For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers configs-list 12345 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 535

def get_node_balancer_configs_with_http_info(api_version, node_balancer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.get_node_balancer_configs ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.get_node_balancer_configs"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.get_node_balancer_configs"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling NodeBalancersApi.get_node_balancer_configs, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling NodeBalancersApi.get_node_balancer_configs, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling NodeBalancersApi.get_node_balancer_configs, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetNodeBalancerConfigs200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.get_node_balancer_configs",
    :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: NodeBalancersApi#get_node_balancer_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_node_balancer_firewalls(api_version, node_balancer_id, opts = {}) ⇒ GetNodeBalancerFirewalls200Response

List node balancer firewalls View information for Firewalls assigned to this NodeBalancer. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers firewalls $nodeBalancerId “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Returns:



612
613
614
615
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 612

def get_node_balancer_firewalls(api_version, node_balancer_id, opts = {})
  data, _status_code, _headers = get_node_balancer_firewalls_with_http_info(api_version, node_balancer_id, opts)
  data
end

#get_node_balancer_firewalls_with_http_info(api_version, node_balancer_id, opts = {}) ⇒ Array<(GetNodeBalancerFirewalls200Response, Integer, Hash)>

List node balancer firewalls View information for Firewalls assigned to this NodeBalancer. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers firewalls $nodeBalancerId &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Returns:



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 623

def get_node_balancer_firewalls_with_http_info(api_version, node_balancer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.get_node_balancer_firewalls ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.get_node_balancer_firewalls"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.get_node_balancer_firewalls"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/firewalls'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetNodeBalancerFirewalls200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.get_node_balancer_firewalls",
    :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: NodeBalancersApi#get_node_balancer_firewalls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_node_balancer_node(api_version, node_balancer_id, config_id, node_id, opts = {}) ⇒ GetNodeBalancerNode200Response

Get a node balancer’s node Returns information about a single Node, a backend for this NodeBalancer’s configured port. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers node-view 12345 4567 54321 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • node_id (Integer) —

    The ID of the Node to access.

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

    the optional parameters

Returns:



688
689
690
691
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 688

def get_node_balancer_node(api_version, node_balancer_id, config_id, node_id, opts = {})
  data, _status_code, _headers = get_node_balancer_node_with_http_info(api_version, node_balancer_id, config_id, node_id, opts)
  data
end

#get_node_balancer_node_with_http_info(api_version, node_balancer_id, config_id, node_id, opts = {}) ⇒ Array<(GetNodeBalancerNode200Response, Integer, Hash)>

Get a node balancer&#39;s node Returns information about a single Node, a backend for this NodeBalancer&#39;s configured port. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers node-view 12345 4567 54321 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • node_id (Integer) —

    The ID of the Node to access.

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

    the optional parameters

Returns:



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 701

def get_node_balancer_node_with_http_info(api_version, node_balancer_id, config_id, node_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.get_node_balancer_node ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.get_node_balancer_node"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.get_node_balancer_node"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling NodeBalancersApi.get_node_balancer_node"
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling NodeBalancersApi.get_node_balancer_node"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs/{configId}/nodes/{nodeId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s)).sub('{' + 'nodeId' + '}', CGI.escape(node_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetNodeBalancerNode200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.get_node_balancer_node",
    :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: NodeBalancersApi#get_node_balancer_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_node_balancer_stats(api_version, node_balancer_id, opts = {}) ⇒ GetNodeBalancerStats200Response

Get node balancer statistics Returns detailed statistics about the requested NodeBalancer. <<LB>> — - __OAuth scopes__. “‘ nodebalancers:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Returns:



772
773
774
775
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 772

def get_node_balancer_stats(api_version, node_balancer_id, opts = {})
  data, _status_code, _headers = get_node_balancer_stats_with_http_info(api_version, node_balancer_id, opts)
  data
end

#get_node_balancer_stats_with_http_info(api_version, node_balancer_id, opts = {}) ⇒ Array<(GetNodeBalancerStats200Response, Integer, Hash)>

Get node balancer statistics Returns detailed statistics about the requested NodeBalancer. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Returns:



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 783

def get_node_balancer_stats_with_http_info(api_version, node_balancer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.get_node_balancer_stats ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.get_node_balancer_stats"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.get_node_balancer_stats"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/stats'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetNodeBalancerStats200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.get_node_balancer_stats",
    :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: NodeBalancersApi#get_node_balancer_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_node_balancer_with_http_info(api_version, node_balancer_id, opts = {}) ⇒ Array<(NodeBalancer1, Integer, Hash)>

Get a NodeBalancer Returns a single NodeBalancer you can access. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers view 12345 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Returns:

  • (Array<(NodeBalancer1, Integer, Hash)>) —

    NodeBalancer1 data, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 279

def get_node_balancer_with_http_info(api_version, node_balancer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.get_node_balancer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.get_node_balancer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.get_node_balancer"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NodeBalancer1'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.get_node_balancer",
    :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: NodeBalancersApi#get_node_balancer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_node_balancers(api_version, opts = {}) ⇒ GetNodeBalancers200Response

List NodeBalancers Returns a paginated list of NodeBalancers you have access to. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



847
848
849
850
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 847

def get_node_balancers(api_version, opts = {})
  data, _status_code, _headers = get_node_balancers_with_http_info(api_version, opts)
  data
end

#get_node_balancers_with_http_info(api_version, opts = {}) ⇒ Array<(GetNodeBalancers200Response, Integer, Hash)>

List NodeBalancers Returns a paginated list of NodeBalancers you have access to. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

  • (Array<(GetNodeBalancers200Response, Integer, Hash)>) —

    GetNodeBalancers200Response data, response status code and response headers



859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 859

def get_node_balancers_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.get_node_balancers ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.get_node_balancers"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling NodeBalancersApi.get_node_balancers, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling NodeBalancersApi.get_node_balancers, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling NodeBalancersApi.get_node_balancers, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/nodebalancers'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetNodeBalancers200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.get_node_balancers",
    :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: NodeBalancersApi#get_node_balancers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_node_balancer(api_version, post_node_balancer_request, opts = {}) ⇒ NodeBalancer5

Create a NodeBalancer Creates a NodeBalancer in the requested Region. Only available in [regions](techdocs.akamai.com/linode-api/reference/get-regions) with "NodeBalancers" in their ‘capabilities`. NodeBalancers require a port Config with at least one backend Node to start serving requests. When using the Linode CLI to create a NodeBalancer, first create a NodeBalancer without any Configs. Then, create Configs and Nodes for that NodeBalancer with the respective [Create a config](techdocs.akamai.com/linode-api/reference/post-node-balancer-config) and [Create a node](techdocs.akamai.com/linode-api/reference/post-node-balancer-node) operations. <<LB>> — - __CLI__. “` linode-cli nodebalancers create \ –region us-east \ –label balancer12345 \ –client_conn_throttle 0 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_node_balancer_request (PostNodeBalancerRequest) —

    Information about the NodeBalancer to create.

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

    the optional parameters

Returns:



932
933
934
935
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 932

def post_node_balancer(api_version, post_node_balancer_request, opts = {})
  data, _status_code, _headers = post_node_balancer_with_http_info(api_version, post_node_balancer_request, opts)
  data
end

#post_node_balancer_config(api_version, node_balancer_id, opts = {}) ⇒ PostNodeBalancerConfig200Response

Create a config Creates a NodeBalancer Config, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer Nodes to the new Config before it can actually serve requests. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers config-create 12345 \ –port 443 \ –protocol https \ –algorithm roundrobin \ –stickiness http_cookie \ –check http_body \ –check_interval 90 \ –check_timeout 10 \ –check_attempts 3 \ –check_path "/test" \ –check_body "it works" \ –check_passive true \ –proxy_protocol "none" \ –ssl_cert "—–BEGIN CERTIFICATE—– CERTIFICATE_INFORMATION —–END CERTIFICATE—–" \ –ssl_key "—–BEGIN PRIVATE KEY—– PRIVATE_KEY_INFORMATION —–END PRIVATE KEY—–" \ –cipher_suite recommended “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Options Hash (opts):

Returns:



1012
1013
1014
1015
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1012

def post_node_balancer_config(api_version, node_balancer_id, opts = {})
  data, _status_code, _headers = post_node_balancer_config_with_http_info(api_version, node_balancer_id, opts)
  data
end

#post_node_balancer_config_with_http_info(api_version, node_balancer_id, opts = {}) ⇒ Array<(PostNodeBalancerConfig200Response, Integer, Hash)>

Create a config Creates a NodeBalancer Config, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer Nodes to the new Config before it can actually serve requests. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers config-create 12345 \ –port 443 \ –protocol https \ –algorithm roundrobin \ –stickiness http_cookie \ –check http_body \ –check_interval 90 \ –check_timeout 10 \ –check_attempts 3 \ –check_path &quot;/test&quot; \ –check_body &quot;it works&quot; \ –check_passive true \ –proxy_protocol &quot;none&quot; \ –ssl_cert &quot;—–BEGIN CERTIFICATE—– CERTIFICATE_INFORMATION —–END CERTIFICATE—–&quot; \ –ssl_key &quot;—–BEGIN PRIVATE KEY—– PRIVATE_KEY_INFORMATION —–END PRIVATE KEY—–&quot; \ –cipher_suite recommended &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

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

    the optional parameters

Options Hash (opts):

Returns:



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1024

def post_node_balancer_config_with_http_info(api_version, node_balancer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.post_node_balancer_config ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.post_node_balancer_config"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.post_node_balancer_config"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'post_node_balancer_config_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'PostNodeBalancerConfig200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.post_node_balancer_config",
    :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: NodeBalancersApi#post_node_balancer_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_node_balancer_node(api_version, node_balancer_id, config_id, post_node_balancer_node_request, opts = {}) ⇒ PostNodeBalancerNode200Response

Create a node Creates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config. Nodes are routed requests on the configured port based on their status. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers node-create \ 12345 4567 \ –address 192.168.210.120:80 \ –label node54321 \ –weight 50 \ –mode accept “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the NodeBalancer config to access.

  • post_node_balancer_node_request (PostNodeBalancerNodeRequest) —

    Information about the Node to create.

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

    the optional parameters

Returns:



1094
1095
1096
1097
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1094

def post_node_balancer_node(api_version, node_balancer_id, config_id, post_node_balancer_node_request, opts = {})
  data, _status_code, _headers = post_node_balancer_node_with_http_info(api_version, node_balancer_id, config_id, post_node_balancer_node_request, opts)
  data
end

#post_node_balancer_node_with_http_info(api_version, node_balancer_id, config_id, post_node_balancer_node_request, opts = {}) ⇒ Array<(PostNodeBalancerNode200Response, Integer, Hash)>

Create a node Creates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config. Nodes are routed requests on the configured port based on their status. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers node-create \ 12345 4567 \ –address 192.168.210.120:80 \ –label node54321 \ –weight 50 \ –mode accept &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the NodeBalancer config to access.

  • post_node_balancer_node_request (PostNodeBalancerNodeRequest) —

    Information about the Node to create.

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

    the optional parameters

Returns:



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1107

def post_node_balancer_node_with_http_info(api_version, node_balancer_id, config_id, post_node_balancer_node_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.post_node_balancer_node ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.post_node_balancer_node"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.post_node_balancer_node"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling NodeBalancersApi.post_node_balancer_node"
  end
  # verify the required parameter 'post_node_balancer_node_request' is set
  if @api_client.config.client_side_validation && post_node_balancer_node_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_node_balancer_node_request' when calling NodeBalancersApi.post_node_balancer_node"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs/{configId}/nodes'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_node_balancer_node_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PostNodeBalancerNode200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.post_node_balancer_node",
    :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: NodeBalancersApi#post_node_balancer_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_node_balancer_with_http_info(api_version, post_node_balancer_request, opts = {}) ⇒ Array<(NodeBalancer5, Integer, Hash)>

Create a NodeBalancer Creates a NodeBalancer in the requested Region. Only available in [regions](techdocs.akamai.com/linode-api/reference/get-regions) with &quot;NodeBalancers&quot; in their &#x60;capabilities&#x60;. NodeBalancers require a port Config with at least one backend Node to start serving requests. When using the Linode CLI to create a NodeBalancer, first create a NodeBalancer without any Configs. Then, create Configs and Nodes for that NodeBalancer with the respective [Create a config](techdocs.akamai.com/linode-api/reference/post-node-balancer-config) and [Create a node](techdocs.akamai.com/linode-api/reference/post-node-balancer-node) operations. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers create \ –region us-east \ –label balancer12345 \ –client_conn_throttle 0 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_node_balancer_request (PostNodeBalancerRequest) —

    Information about the NodeBalancer to create.

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

    the optional parameters

Returns:

  • (Array<(NodeBalancer5, Integer, Hash)>) —

    NodeBalancer5 data, response status code and response headers



943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 943

def post_node_balancer_with_http_info(api_version, post_node_balancer_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.post_node_balancer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.post_node_balancer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'post_node_balancer_request' is set
  if @api_client.config.client_side_validation && post_node_balancer_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_node_balancer_request' when calling NodeBalancersApi.post_node_balancer"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_node_balancer_request)

  # return_type
  return_type = opts[:debug_return_type] || 'NodeBalancer5'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.post_node_balancer",
    :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: NodeBalancersApi#post_node_balancer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_rebuild_node_balancer_config(api_version, node_balancer_id, config_id, post_rebuild_node_balancer_config_request, opts = {}) ⇒ PostRebuildNodeBalancerConfig200Response

Rebuild a config Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify. Use this operation to update a NodeBalancer’s Config and Nodes with a single request. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers config-rebuild \ 12345 4567 \ –port 443 \ –protocol https \ –algorithm roundrobin \ –stickiness http_cookie \ –check http_body \ –check_interval 90 \ –check_timeout 10 \ –check_attempts 3 \ –check_path "/test" \ –check_body "it works" \ –check_passive true \ –proxy_protocol "none" \ –ssl_cert "—–BEGIN CERTIFICATE—– CERTIFICATE_INFORMATION —–END CERTIFICATE—–" \ –ssl_key "—–BEGIN PRIVATE KEY—– PRIVATE_KEY_INFORMATION —–END PRIVATE KEY—–" \ –cipher_suite recommended \ –nodes ’"address":"192.168.210.120:80","label":"node1","weight":50,"mode":"accept"‘ \ –nodes ’"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"‘ “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • post_rebuild_node_balancer_config_request (PostRebuildNodeBalancerConfigRequest) —

    Information about the NodeBalancer Config to rebuild.

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

    the optional parameters

Returns:



1185
1186
1187
1188
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1185

def post_rebuild_node_balancer_config(api_version, node_balancer_id, config_id, post_rebuild_node_balancer_config_request, opts = {})
  data, _status_code, _headers = post_rebuild_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, post_rebuild_node_balancer_config_request, opts)
  data
end

#post_rebuild_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, post_rebuild_node_balancer_config_request, opts = {}) ⇒ Array<(PostRebuildNodeBalancerConfig200Response, Integer, Hash)>

Rebuild a config Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify. Use this operation to update a NodeBalancer&#39;s Config and Nodes with a single request. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers config-rebuild \ 12345 4567 \ –port 443 \ –protocol https \ –algorithm roundrobin \ –stickiness http_cookie \ –check http_body \ –check_interval 90 \ –check_timeout 10 \ –check_attempts 3 \ –check_path &quot;/test&quot; \ –check_body &quot;it works&quot; \ –check_passive true \ –proxy_protocol &quot;none&quot; \ –ssl_cert &quot;—–BEGIN CERTIFICATE—– CERTIFICATE_INFORMATION —–END CERTIFICATE—–&quot; \ –ssl_key &quot;—–BEGIN PRIVATE KEY—– PRIVATE_KEY_INFORMATION —–END PRIVATE KEY—–&quot; \ –cipher_suite recommended \ –nodes &#39;&quot;address&quot;:&quot;192.168.210.120:80&quot;,&quot;label&quot;:&quot;node1&quot;,&quot;weight&quot;:50,&quot;mode&quot;:&quot;accept&quot;&#39; \ –nodes &#39;&quot;address&quot;:&quot;192.168.210.122:80&quot;,&quot;label&quot;:&quot;node2&quot;,&quot;weight&quot;:50,&quot;mode&quot;:&quot;accept&quot;&#39; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • post_rebuild_node_balancer_config_request (PostRebuildNodeBalancerConfigRequest) —

    Information about the NodeBalancer Config to rebuild.

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

    the optional parameters

Returns:



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1198

def post_rebuild_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, post_rebuild_node_balancer_config_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.post_rebuild_node_balancer_config ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.post_rebuild_node_balancer_config"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.post_rebuild_node_balancer_config"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling NodeBalancersApi.post_rebuild_node_balancer_config"
  end
  # verify the required parameter 'post_rebuild_node_balancer_config_request' is set
  if @api_client.config.client_side_validation && post_rebuild_node_balancer_config_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_rebuild_node_balancer_config_request' when calling NodeBalancersApi.post_rebuild_node_balancer_config"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs/{configId}/rebuild'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_rebuild_node_balancer_config_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PostRebuildNodeBalancerConfig200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.post_rebuild_node_balancer_config",
    :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: NodeBalancersApi#post_rebuild_node_balancer_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_node_balancer(api_version, node_balancer_id, node_balancer2, opts = {}) ⇒ NodeBalancer3

Update a NodeBalancer Updates information about a NodeBalancer you can access. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers update 12345 \ –label balancer12345 \ –client_conn_throttle 0 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • node_balancer2 (NodeBalancer2) —

    The information to update.

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

    the optional parameters

Returns:



1275
1276
1277
1278
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1275

def put_node_balancer(api_version, node_balancer_id, node_balancer2, opts = {})
  data, _status_code, _headers = put_node_balancer_with_http_info(api_version, node_balancer_id, node_balancer2, opts)
  data
end

#put_node_balancer_config(api_version, node_balancer_id, config_id, put_node_balancer_config_request, opts = {}) ⇒ PutNodeBalancerConfig200Response

Update a config Updates the configuration for a single port on a NodeBalancer. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers config-update \ 12345 4567 \ –port 443 \ –protocol https \ –algorithm roundrobin \ –stickiness http_cookie \ –check http_body \ –check_interval 90 \ –check_timeout 10 \ –check_attempts 3 \ –check_path "/test" \ –check_body "it works" \ –check_passive true \ –proxy_protocol "none" \ –ssl_cert "—–BEGIN CERTIFICATE—– CERTIFICATE_INFORMATION —–END CERTIFICATE—–" \ –ssl_key "—–BEGIN PRIVATE KEY—– PRIVATE_KEY_INFORMATION —–END PRIVATE KEY—–" \ –cipher_suite recommended “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • put_node_balancer_config_request (PutNodeBalancerConfigRequest) —

    The fields to update.

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

    the optional parameters

Returns:



1361
1362
1363
1364
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1361

def put_node_balancer_config(api_version, node_balancer_id, config_id, put_node_balancer_config_request, opts = {})
  data, _status_code, _headers = put_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, put_node_balancer_config_request, opts)
  data
end

#put_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, put_node_balancer_config_request, opts = {}) ⇒ Array<(PutNodeBalancerConfig200Response, Integer, Hash)>

Update a config Updates the configuration for a single port on a NodeBalancer. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers config-update \ 12345 4567 \ –port 443 \ –protocol https \ –algorithm roundrobin \ –stickiness http_cookie \ –check http_body \ –check_interval 90 \ –check_timeout 10 \ –check_attempts 3 \ –check_path &quot;/test&quot; \ –check_body &quot;it works&quot; \ –check_passive true \ –proxy_protocol &quot;none&quot; \ –ssl_cert &quot;—–BEGIN CERTIFICATE—– CERTIFICATE_INFORMATION —–END CERTIFICATE—–&quot; \ –ssl_key &quot;—–BEGIN PRIVATE KEY—– PRIVATE_KEY_INFORMATION —–END PRIVATE KEY—–&quot; \ –cipher_suite recommended &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • put_node_balancer_config_request (PutNodeBalancerConfigRequest) —

    The fields to update.

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

    the optional parameters

Returns:



1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1374

def put_node_balancer_config_with_http_info(api_version, node_balancer_id, config_id, put_node_balancer_config_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.put_node_balancer_config ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.put_node_balancer_config"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.put_node_balancer_config"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling NodeBalancersApi.put_node_balancer_config"
  end
  # verify the required parameter 'put_node_balancer_config_request' is set
  if @api_client.config.client_side_validation && put_node_balancer_config_request.nil?
    fail ArgumentError, "Missing the required parameter 'put_node_balancer_config_request' when calling NodeBalancersApi.put_node_balancer_config"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs/{configId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(put_node_balancer_config_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PutNodeBalancerConfig200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.put_node_balancer_config",
    :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: NodeBalancersApi#put_node_balancer_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_node_balancer_node(api_version, node_balancer_id, config_id, node_id, put_node_balancer_node_request, opts = {}) ⇒ PutNodeBalancerNode200Response

Update a node Updates information about a Node, a backend for this NodeBalancer’s configured port. <<LB>> — - __CLI__. “‘ linode-cli nodebalancers node-update \ 12345 4567 54321 \ –address 192.168.210.120:80 \ –label node54321 \ –weight 50 \ –mode accept “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` nodebalancers:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • node_id (Integer) —

    The ID of the Node to access.

  • put_node_balancer_node_request (PutNodeBalancerNodeRequest) —

    The fields to update.

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

    the optional parameters

Returns:



1453
1454
1455
1456
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1453

def put_node_balancer_node(api_version, node_balancer_id, config_id, node_id, put_node_balancer_node_request, opts = {})
  data, _status_code, _headers = put_node_balancer_node_with_http_info(api_version, node_balancer_id, config_id, node_id, put_node_balancer_node_request, opts)
  data
end

#put_node_balancer_node_with_http_info(api_version, node_balancer_id, config_id, node_id, put_node_balancer_node_request, opts = {}) ⇒ Array<(PutNodeBalancerNode200Response, Integer, Hash)>

Update a node Updates information about a Node, a backend for this NodeBalancer&#39;s configured port. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers node-update \ 12345 4567 54321 \ –address 192.168.210.120:80 \ –label node54321 \ –weight 50 \ –mode accept &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • config_id (Integer) —

    The ID of the Config to access.

  • node_id (Integer) —

    The ID of the Node to access.

  • put_node_balancer_node_request (PutNodeBalancerNodeRequest) —

    The fields to update.

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

    the optional parameters

Returns:



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1467

def put_node_balancer_node_with_http_info(api_version, node_balancer_id, config_id, node_id, put_node_balancer_node_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.put_node_balancer_node ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.put_node_balancer_node"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.put_node_balancer_node"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling NodeBalancersApi.put_node_balancer_node"
  end
  # verify the required parameter 'node_id' is set
  if @api_client.config.client_side_validation && node_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_id' when calling NodeBalancersApi.put_node_balancer_node"
  end
  # verify the required parameter 'put_node_balancer_node_request' is set
  if @api_client.config.client_side_validation && put_node_balancer_node_request.nil?
    fail ArgumentError, "Missing the required parameter 'put_node_balancer_node_request' when calling NodeBalancersApi.put_node_balancer_node"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}/configs/{configId}/nodes/{nodeId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s)).sub('{' + 'nodeId' + '}', CGI.escape(node_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(put_node_balancer_node_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PutNodeBalancerNode200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.put_node_balancer_node",
    :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: NodeBalancersApi#put_node_balancer_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_node_balancer_with_http_info(api_version, node_balancer_id, node_balancer2, opts = {}) ⇒ Array<(NodeBalancer3, Integer, Hash)>

Update a NodeBalancer Updates information about a NodeBalancer you can access. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli nodebalancers update 12345 \ –label balancer12345 \ –client_conn_throttle 0 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; nodebalancers:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • node_balancer_id (Integer) —

    The ID of the NodeBalancer to access.

  • node_balancer2 (NodeBalancer2) —

    The information to update.

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

    the optional parameters

Returns:

  • (Array<(NodeBalancer3, Integer, Hash)>) —

    NodeBalancer3 data, response status code and response headers



1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
 
# File 'lib/linode_openapi_client/api/node_balancers_api.rb', line 1287

def put_node_balancer_with_http_info(api_version, node_balancer_id, node_balancer2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NodeBalancersApi.put_node_balancer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling NodeBalancersApi.put_node_balancer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'node_balancer_id' is set
  if @api_client.config.client_side_validation && node_balancer_id.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer_id' when calling NodeBalancersApi.put_node_balancer"
  end
  # verify the required parameter 'node_balancer2' is set
  if @api_client.config.client_side_validation && node_balancer2.nil?
    fail ArgumentError, "Missing the required parameter 'node_balancer2' when calling NodeBalancersApi.put_node_balancer"
  end
  # resource path
  local_var_path = '/{apiVersion}/nodebalancers/{nodeBalancerId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'nodeBalancerId' + '}', CGI.escape(node_balancer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(node_balancer2)

  # return_type
  return_type = opts[:debug_return_type] || 'NodeBalancer3'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"NodeBalancersApi.put_node_balancer",
    :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: NodeBalancersApi#put_node_balancer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end