Class: LinodeOpenapiClient::LinodeInstancesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LinodeInstancesApi

Returns a new instance of LinodeInstancesApi.



19
20
21
 
# File 'lib/linode_openapi_client/api/linode_instances_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/linode_instances_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_disk(api_version, linode_id, disk_id, opts = {}) ⇒ Object

Delete a disk Deletes a Disk you have permission to ‘read_write`. __Deleting a Disk is a destructive action and cannot be undone.__ <<LB>> — - __CLI__. “` linode-cli linodes disk-delete 123 24674 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

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

    the optional parameters

Returns:

  • (Object) 


29
30
31
32
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 29

def delete_disk(api_version, linode_id, disk_id, opts = {})
  data, _status_code, _headers = delete_disk_with_http_info(api_version, linode_id, disk_id, opts)
  data
end

#delete_disk_with_http_info(api_version, linode_id, disk_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a disk Deletes a Disk you have permission to &#x60;read_write&#x60;. __Deleting a Disk is a destructive action and cannot be undone.__ &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes disk-delete 123 24674 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
95
96
97
98
99
100
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 41

def delete_disk_with_http_info(api_version, linode_id, disk_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.delete_disk ...'
  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 LinodeInstancesApi.delete_disk"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.delete_disk"
  end
  # verify the required parameter 'disk_id' is set
  if @api_client.config.client_side_validation && disk_id.nil?
    fail ArgumentError, "Missing the required parameter 'disk_id' when calling LinodeInstancesApi.delete_disk"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/disks/{diskId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'diskId' + '}', CGI.escape(disk_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 => :"LinodeInstancesApi.delete_disk",
    :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: LinodeInstancesApi#delete_disk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_linode_config(api_version, linode_id, config_id, opts = {}) ⇒ Object

Delete a config profile Deletes the specified Configuration profile from the specified Linode. <<LB>> — - __CLI__. “‘ linode-cli linodes config-delete 123 23456 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

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

    the optional parameters

Returns:

  • (Object) 


109
110
111
112
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 109

def delete_linode_config(api_version, linode_id, config_id, opts = {})
  data, _status_code, _headers = delete_linode_config_with_http_info(api_version, linode_id, config_id, opts)
  data
end

#delete_linode_config_interface(api_version, linode_id, config_id, interface_id, opts = {}) ⇒ Object

Delete a configuration profile interface Deletes an Interface from the Configuration Profile. - The User accessing this operation must have ‘read_write` grants to the Linode. - A successful request triggers a `linode_config_update` event. - Active Interfaces cannot be deleted. The associated Linode must first be shut down (or restarted using another Configuration Profile) before such Interfaces can be deleted from a Configuration Profile. <<LB>> — - __CLI__. “` linode-cli linodes config-delete $linodeId $configId $interfaceId “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • interface_id (Integer) —

    The &#x60;id&#x60; of the Linode Configuration Profile Interface.

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

    the optional parameters

Returns:

  • (Object) 


190
191
192
193
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 190

def delete_linode_config_interface(api_version, linode_id, config_id, interface_id, opts = {})
  data, _status_code, _headers = delete_linode_config_interface_with_http_info(api_version, linode_id, config_id, interface_id, opts)
  data
end

#delete_linode_config_interface_with_http_info(api_version, linode_id, config_id, interface_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a configuration profile interface Deletes an Interface from the Configuration Profile. - The User accessing this operation must have &#x60;read_write&#x60; grants to the Linode. - A successful request triggers a &#x60;linode_config_update&#x60; event. - Active Interfaces cannot be deleted. The associated Linode must first be shut down (or restarted using another Configuration Profile) before such Interfaces can be deleted from a Configuration Profile. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-delete $linodeId $configId $interfaceId &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • interface_id (Integer) —

    The &#x60;id&#x60; of the Linode Configuration Profile Interface.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
261
262
263
264
265
266
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 203

def delete_linode_config_interface_with_http_info(api_version, linode_id, config_id, interface_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.delete_linode_config_interface ...'
  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 LinodeInstancesApi.delete_linode_config_interface"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.delete_linode_config_interface"
  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 LinodeInstancesApi.delete_linode_config_interface"
  end
  # verify the required parameter 'interface_id' is set
  if @api_client.config.client_side_validation && interface_id.nil?
    fail ArgumentError, "Missing the required parameter 'interface_id' when calling LinodeInstancesApi.delete_linode_config_interface"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces/{interfaceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s)).sub('{' + 'interfaceId' + '}', CGI.escape(interface_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 => :"LinodeInstancesApi.delete_linode_config_interface",
    :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: LinodeInstancesApi#delete_linode_config_interface\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a config profile Deletes the specified Configuration profile from the specified Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-delete 123 23456 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
175
176
177
178
179
180
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 121

def delete_linode_config_with_http_info(api_version, linode_id, config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.delete_linode_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 LinodeInstancesApi.delete_linode_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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.delete_linode_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 LinodeInstancesApi.delete_linode_config"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs/{configId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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 => :"LinodeInstancesApi.delete_linode_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: LinodeInstancesApi#delete_linode_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_linode_instance(api_version, linode_id, opts = {}) ⇒ Object

Delete a Linode Deletes a Linode you have permission to ‘read_write`. __Deleting a Linode is a destructive action and cannot be undone.__ Additionally, deleting a Linode: - Gives up any IP addresses the Linode was assigned. - Deletes all Disks, Backups, Configs, etc. - Detaches any Volumes associated with the Linode. - Stops billing for the Linode and its associated services. You will be billed for time used within the billing period the Linode was active. Linodes that are in the process of [cloning](techdocs.akamai.com/linode-api/reference/post-clone-linode-instance) or [backup restoration](techdocs.akamai.com/linode-api/reference/post-restore-backup) cannot be deleted. <<LB>> — - __CLI__. “` linode-cli linodes delete 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:

  • (Object) 


274
275
276
277
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 274

def delete_linode_instance(api_version, linode_id, opts = {})
  data, _status_code, _headers = delete_linode_instance_with_http_info(api_version, linode_id, opts)
  data
end

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

Delete a Linode Deletes a Linode you have permission to &#x60;read_write&#x60;. __Deleting a Linode is a destructive action and cannot be undone.__ Additionally, deleting a Linode: - Gives up any IP addresses the Linode was assigned. - Deletes all Disks, Backups, Configs, etc. - Detaches any Volumes associated with the Linode. - Stops billing for the Linode and its associated services. You will be billed for time used within the billing period the Linode was active. Linodes that are in the process of [cloning](techdocs.akamai.com/linode-api/reference/post-clone-linode-instance) or [backup restoration](techdocs.akamai.com/linode-api/reference/post-restore-backup) cannot be deleted. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes delete 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
335
336
337
338
339
340
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 285

def delete_linode_instance_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.delete_linode_instance ...'
  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 LinodeInstancesApi.delete_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.delete_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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 => :"LinodeInstancesApi.delete_linode_instance",
    :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: LinodeInstancesApi#delete_linode_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_linode_ip(api_version, linode_id, address, opts = {}) ⇒ Object

Delete an IPv4 address Deletes a public or private IPv4 address associated with this Linode. This will fail if it is the Linode’s last remaining public IPv4 address, or if the address has a 1:1 NAT with an active VPC Subnet address. <<LB>> — - __CLI__. “‘ linode-cli linodes ip-delete 97.107.143.141 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode.

  • address (String) —

    The IP address.

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

    the optional parameters

Returns:

  • (Object) 


349
350
351
352
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 349

def delete_linode_ip(api_version, linode_id, address, opts = {})
  data, _status_code, _headers = delete_linode_ip_with_http_info(api_version, linode_id, address, opts)
  data
end

#delete_linode_ip_with_http_info(api_version, linode_id, address, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete an IPv4 address Deletes a public or private IPv4 address associated with this Linode. This will fail if it is the Linode&#39;s last remaining public IPv4 address, or if the address has a 1:1 NAT with an active VPC Subnet address. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes ip-delete 97.107.143.141 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode.

  • address (String) —

    The IP address.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
415
416
417
418
419
420
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 361

def delete_linode_ip_with_http_info(api_version, linode_id, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.delete_linode_ip ...'
  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 LinodeInstancesApi.delete_linode_ip"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.delete_linode_ip"
  end
  # verify the required parameter 'address' is set
  if @api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling LinodeInstancesApi.delete_linode_ip"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/ips/{address}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'address' + '}', CGI.escape(address.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 => :"LinodeInstancesApi.delete_linode_ip",
    :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: LinodeInstancesApi#delete_linode_ip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_backup(api_version, linode_id, backup_id, opts = {}) ⇒ GetBackup200Response

Get a backup Returns information about a Backup. <<LB>> — - __CLI__. “‘ linode-cli linodes backup-view 123 123456 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode the Backup belongs to.

  • backup_id (Integer) —

    The ID of the Backup to look up.

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

    the optional parameters

Returns:



429
430
431
432
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 429

def get_backup(api_version, linode_id, backup_id, opts = {})
  data, _status_code, _headers = get_backup_with_http_info(api_version, linode_id, backup_id, opts)
  data
end

#get_backup_with_http_info(api_version, linode_id, backup_id, opts = {}) ⇒ Array<(GetBackup200Response, Integer, Hash)>

Get a backup Returns information about a Backup. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes backup-view 123 123456 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode the Backup belongs to.

  • backup_id (Integer) —

    The ID of the Backup to look up.

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

    the optional parameters

Returns:

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

    GetBackup200Response data, response status code and response headers



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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 441

def get_backup_with_http_info(api_version, linode_id, backup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_backup ...'
  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 LinodeInstancesApi.get_backup"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_backup"
  end
  # verify the required parameter 'backup_id' is set
  if @api_client.config.client_side_validation && backup_id.nil?
    fail ArgumentError, "Missing the required parameter 'backup_id' when calling LinodeInstancesApi.get_backup"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/backups/{backupId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'backupId' + '}', CGI.escape(backup_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] || 'GetBackup200Response'

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

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

#get_backups(api_version, linode_id, opts = {}) ⇒ GetBackups200Response

List backups Returns information about this Linode’s available backups. <<LB>> — - __CLI__. “‘ linode-cli linodes backups-list 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode the backups belong to.

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

    the optional parameters

Returns:



508
509
510
511
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 508

def get_backups(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_backups_with_http_info(api_version, linode_id, opts)
  data
end

#get_backups_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(GetBackups200Response, Integer, Hash)>

List backups Returns information about this Linode&#39;s available backups. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes backups-list 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode the backups belong to.

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

    the optional parameters

Returns:

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

    GetBackups200Response data, response status code and response headers



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 519

def get_backups_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_backups ...'
  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 LinodeInstancesApi.get_backups"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_backups"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/backups'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetBackups200Response'

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

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

#get_kernel(api_version, kernel_id, opts = {}) ⇒ GetKernel200Response

Get a kernel Returns information about a single Kernel. <<LB>> — - __CLI__. “‘ linode-cli kernels view latest-64bit “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

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

  • kernel_id (String) —

    ID of the Kernel to look up.

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

    the optional parameters

Returns:



582
583
584
585
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 582

def get_kernel(api_version, kernel_id, opts = {})
  data, _status_code, _headers = get_kernel_with_http_info(api_version, kernel_id, opts)
  data
end

#get_kernel_with_http_info(api_version, kernel_id, opts = {}) ⇒ Array<(GetKernel200Response, Integer, Hash)>

Get a kernel Returns information about a single Kernel. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli kernels view latest-64bit &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

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

  • kernel_id (String) —

    ID of the Kernel to look up.

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

    the optional parameters

Returns:

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

    GetKernel200Response data, response status code and response headers



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 593

def get_kernel_with_http_info(api_version, kernel_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_kernel ...'
  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 LinodeInstancesApi.get_kernel"
  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 'kernel_id' is set
  if @api_client.config.client_side_validation && kernel_id.nil?
    fail ArgumentError, "Missing the required parameter 'kernel_id' when calling LinodeInstancesApi.get_kernel"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/kernels/{kernelId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'kernelId' + '}', CGI.escape(kernel_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] || 'GetKernel200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_kernels(api_version, opts = {}) ⇒ GetKernels200Response

List kernels Lists available Kernels. Due to the extensive list of available kernels, please keep [pagination](techdocs.akamai.com/linode-api/reference/pagination) controls in mind when managing responses to this operation. <<LB>> — - __CLI__. “‘ linode-cli kernels list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

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:



657
658
659
660
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 657

def get_kernels(api_version, opts = {})
  data, _status_code, _headers = get_kernels_with_http_info(api_version, opts)
  data
end

#get_kernels_with_http_info(api_version, opts = {}) ⇒ Array<(GetKernels200Response, Integer, Hash)>

List kernels Lists available Kernels. Due to the extensive list of available kernels, please keep [pagination](techdocs.akamai.com/linode-api/reference/pagination) controls in mind when managing responses to this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli kernels list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

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<(GetKernels200Response, Integer, Hash)>) —

    GetKernels200Response data, response status code and response headers



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 669

def get_kernels_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_kernels ...'
  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 LinodeInstancesApi.get_kernels"
  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 LinodeInstancesApi.get_kernels, 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 LinodeInstancesApi.get_kernels, 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 LinodeInstancesApi.get_kernels, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/linode/kernels'.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] || 'GetKernels200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_linode_config(api_version, linode_id, config_id, opts = {}) ⇒ GetLinodeConfig200Response

Get a config profile Returns information about a specific Configuration profile. <<LB>> — - __CLI__. “‘ linode-cli linodes config-view 123 23456 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

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

    the optional parameters

Returns:



743
744
745
746
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 743

def get_linode_config(api_version, linode_id, config_id, opts = {})
  data, _status_code, _headers = get_linode_config_with_http_info(api_version, linode_id, config_id, opts)
  data
end

#get_linode_config_interface(api_version, linode_id, config_id, interface_id, opts = {}) ⇒ GetLinodeConfigInterface200Response

Get a configuration profile interface Returns a single Configuration Profile Interface. - The User accessing this operation must have at least ‘read_only` grants to the Linode. <<LB>> — - __CLI__. “` linode-cli linodes config-interface-view $linodeId $configId $interfaceId “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • interface_id (Integer) —

    The &#x60;id&#x60; of the Linode Configuration Profile Interface.

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

    the optional parameters

Returns:



824
825
826
827
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 824

def get_linode_config_interface(api_version, linode_id, config_id, interface_id, opts = {})
  data, _status_code, _headers = get_linode_config_interface_with_http_info(api_version, linode_id, config_id, interface_id, opts)
  data
end

#get_linode_config_interface_with_http_info(api_version, linode_id, config_id, interface_id, opts = {}) ⇒ Array<(GetLinodeConfigInterface200Response, Integer, Hash)>

Get a configuration profile interface Returns a single Configuration Profile Interface. - The User accessing this operation must have at least &#x60;read_only&#x60; grants to the Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-interface-view $linodeId $configId $interfaceId &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • interface_id (Integer) —

    The &#x60;id&#x60; of the Linode Configuration Profile Interface.

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

    the optional parameters

Returns:



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 837

def get_linode_config_interface_with_http_info(api_version, linode_id, config_id, interface_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_config_interface ...'
  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 LinodeInstancesApi.get_linode_config_interface"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_config_interface"
  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 LinodeInstancesApi.get_linode_config_interface"
  end
  # verify the required parameter 'interface_id' is set
  if @api_client.config.client_side_validation && interface_id.nil?
    fail ArgumentError, "Missing the required parameter 'interface_id' when calling LinodeInstancesApi.get_linode_config_interface"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces/{interfaceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s)).sub('{' + 'interfaceId' + '}', CGI.escape(interface_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] || 'GetLinodeConfigInterface200Response'

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

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

#get_linode_config_interfaces(api_version, linode_id, config_id, opts = {}) ⇒ Array<GetLinodeConfigInterfaces200ResponseInner>

List configuration profile interfaces Returns an ordered array of all Interfaces associated with this Configuration Profile. - The User accessing this operation must have at least ‘read_only` grants to the Linode. <<LB>> — - __CLI__. “` linode-cli linodes config-interfaces-list $linodeId $configId “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

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

    the optional parameters

Returns:



909
910
911
912
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 909

def get_linode_config_interfaces(api_version, linode_id, config_id, opts = {})
  data, _status_code, _headers = get_linode_config_interfaces_with_http_info(api_version, linode_id, config_id, opts)
  data
end

#get_linode_config_interfaces_with_http_info(api_version, linode_id, config_id, opts = {}) ⇒ Array<(Array<GetLinodeConfigInterfaces200ResponseInner>, Integer, Hash)>

List configuration profile interfaces Returns an ordered array of all Interfaces associated with this Configuration Profile. - The User accessing this operation must have at least &#x60;read_only&#x60; grants to the Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-interfaces-list $linodeId $configId &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

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

    the optional parameters

Returns:



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 921

def get_linode_config_interfaces_with_http_info(api_version, linode_id, config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_config_interfaces ...'
  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 LinodeInstancesApi.get_linode_config_interfaces"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_config_interfaces"
  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 LinodeInstancesApi.get_linode_config_interfaces"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'Array<GetLinodeConfigInterfaces200ResponseInner>'

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

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

#get_linode_config_with_http_info(api_version, linode_id, config_id, opts = {}) ⇒ Array<(GetLinodeConfig200Response, Integer, Hash)>

Get a config profile Returns information about a specific Configuration profile. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-view 123 23456 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

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

    the optional parameters

Returns:

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

    GetLinodeConfig200Response data, response status code and response headers



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 755

def get_linode_config_with_http_info(api_version, linode_id, config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_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 LinodeInstancesApi.get_linode_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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_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 LinodeInstancesApi.get_linode_config"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs/{configId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetLinodeConfig200Response'

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

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

#get_linode_configs(api_version, linode_id, opts = {}) ⇒ GetLinodeConfigs200Response

List config profiles Lists Configuration profiles associated with a Linode. <<LB>> — - __CLI__. “‘ linode-cli linodes configs-list 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up Configuration profiles for.

  • 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:



990
991
992
993
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 990

def get_linode_configs(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_linode_configs_with_http_info(api_version, linode_id, opts)
  data
end

#get_linode_configs_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(GetLinodeConfigs200Response, Integer, Hash)>

List config profiles Lists Configuration profiles associated with a Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes configs-list 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up Configuration profiles for.

  • 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<(GetLinodeConfigs200Response, Integer, Hash)>) —

    GetLinodeConfigs200Response data, response status code and response headers



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1003

def get_linode_configs_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_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 LinodeInstancesApi.get_linode_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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_configs"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling LinodeInstancesApi.get_linode_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 LinodeInstancesApi.get_linode_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 LinodeInstancesApi.get_linode_configs, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetLinodeConfigs200Response'

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

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

#get_linode_disk(api_version, linode_id, disk_id, opts = {}) ⇒ GetLinodeDisk200Response

Get a disk View Disk information for a Disk associated with this Linode. <<LB>> — - __CLI__. “‘ linode-cli linodes disk-view 123 25674 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

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

    the optional parameters

Returns:



1081
1082
1083
1084
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1081

def get_linode_disk(api_version, linode_id, disk_id, opts = {})
  data, _status_code, _headers = get_linode_disk_with_http_info(api_version, linode_id, disk_id, opts)
  data
end

#get_linode_disk_with_http_info(api_version, linode_id, disk_id, opts = {}) ⇒ Array<(GetLinodeDisk200Response, Integer, Hash)>

Get a disk View Disk information for a Disk associated with this Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes disk-view 123 25674 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

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

    the optional parameters

Returns:

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

    GetLinodeDisk200Response data, response status code and response headers



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1093

def get_linode_disk_with_http_info(api_version, linode_id, disk_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_disk ...'
  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 LinodeInstancesApi.get_linode_disk"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_disk"
  end
  # verify the required parameter 'disk_id' is set
  if @api_client.config.client_side_validation && disk_id.nil?
    fail ArgumentError, "Missing the required parameter 'disk_id' when calling LinodeInstancesApi.get_linode_disk"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/disks/{diskId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'diskId' + '}', CGI.escape(disk_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] || 'GetLinodeDisk200Response'

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

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

#get_linode_disks(api_version, linode_id, opts = {}) ⇒ GetLinodeDisks200Response

List disks View Disk information for Disks associated with this Linode. <<LB>> — - __CLI__. “‘ linode-cli linodes disks-list 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • 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:



1162
1163
1164
1165
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1162

def get_linode_disks(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_linode_disks_with_http_info(api_version, linode_id, opts)
  data
end

#get_linode_disks_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(GetLinodeDisks200Response, Integer, Hash)>

List disks View Disk information for Disks associated with this Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes disks-list 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • 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<(GetLinodeDisks200Response, Integer, Hash)>) —

    GetLinodeDisks200Response data, response status code and response headers



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1175

def get_linode_disks_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_disks ...'
  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 LinodeInstancesApi.get_linode_disks"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_disks"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling LinodeInstancesApi.get_linode_disks, 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 LinodeInstancesApi.get_linode_disks, 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 LinodeInstancesApi.get_linode_disks, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/disks'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetLinodeDisks200Response'

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

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

#get_linode_firewalls(api_version, linode_id, opts = {}) ⇒ GetLinodeFirewalls200Response

List a Linode’s firewalls View Firewall information for Firewalls assigned to this Linode. <<LB>> — - __CLI__. “‘ linode-cli linodes firewalls-list 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode 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:



1254
1255
1256
1257
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1254

def get_linode_firewalls(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_linode_firewalls_with_http_info(api_version, linode_id, opts)
  data
end

#get_linode_firewalls_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(GetLinodeFirewalls200Response, Integer, Hash)>

List a Linode&#39;s firewalls View Firewall information for Firewalls assigned to this Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes firewalls-list 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode 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:



1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1267

def get_linode_firewalls_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_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 LinodeInstancesApi.get_linode_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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_firewalls"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling LinodeInstancesApi.get_linode_firewalls, 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 LinodeInstancesApi.get_linode_firewalls, 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 LinodeInstancesApi.get_linode_firewalls, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/firewalls'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetLinodeFirewalls200Response'

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

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

#get_linode_instance(api_version, linode_id, opts = {}) ⇒ Linode4

Get a Linode Get a specific Linode by ID. <<LB>> — - __CLI__. “‘ linode-cli linodes view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:



1344
1345
1346
1347
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1344

def get_linode_instance(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_linode_instance_with_http_info(api_version, linode_id, opts)
  data
end

#get_linode_instance_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(Linode4, Integer, Hash)>

Get a Linode Get a specific Linode by ID. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:

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

    Linode4 data, response status code and response headers



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1355

def get_linode_instance_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_instance ...'
  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 LinodeInstancesApi.get_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'Linode4'

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

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

#get_linode_instances(api_version, opts = {}) ⇒ GetLinodeInstances200Response

List Linodes Returns a paginated list of Linodes you have permission to view. <<LB>> — - __CLI__. “‘ linode-cli linodes list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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):

  • :x_filter (GetLinodeInstancesXFilterParameter) —

    Specifies a JSON object to filter down the results. See [Filtering and sorting](filtering-and-sorting) for details.

  • :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:



1420
1421
1422
1423
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1420

def get_linode_instances(api_version, opts = {})
  data, _status_code, _headers = get_linode_instances_with_http_info(api_version, opts)
  data
end

#get_linode_instances_with_http_info(api_version, opts = {}) ⇒ Array<(GetLinodeInstances200Response, Integer, Hash)>

List Linodes Returns a paginated list of Linodes you have permission to view. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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):

  • :x_filter (GetLinodeInstancesXFilterParameter) —

    Specifies a JSON object to filter down the results. See [Filtering and sorting](filtering-and-sorting) for details.

  • :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:



1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
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
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1433

def get_linode_instances_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_instances ...'
  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 LinodeInstancesApi.get_linode_instances"
  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 LinodeInstancesApi.get_linode_instances, 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 LinodeInstancesApi.get_linode_instances, 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 LinodeInstancesApi.get_linode_instances, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/linode/instances'.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']
  header_params[:'X-Filter'] = opts[:'x_filter'] if !opts[:'x_filter'].nil?

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

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

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

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

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

#get_linode_ip(api_version, linode_id, address, opts = {}) ⇒ GetLinodeIp200Response

Get a Linode’s IP address View information about the specified IP address associated with the specified Linode. <<LB>> — - __CLI__. “‘ linode-cli linodes ip-view 123 97.107.143.141 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode.

  • address (String) —

    The IP address.

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

    the optional parameters

Returns:



1508
1509
1510
1511
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1508

def get_linode_ip(api_version, linode_id, address, opts = {})
  data, _status_code, _headers = get_linode_ip_with_http_info(api_version, linode_id, address, opts)
  data
end

#get_linode_ip_with_http_info(api_version, linode_id, address, opts = {}) ⇒ Array<(GetLinodeIp200Response, Integer, Hash)>

Get a Linode&#39;s IP address View information about the specified IP address associated with the specified Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes ip-view 123 97.107.143.141 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode.

  • address (String) —

    The IP address.

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

    the optional parameters

Returns:

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

    GetLinodeIp200Response data, response status code and response headers



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1520

def get_linode_ip_with_http_info(api_version, linode_id, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_ip ...'
  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 LinodeInstancesApi.get_linode_ip"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_ip"
  end
  # verify the required parameter 'address' is set
  if @api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling LinodeInstancesApi.get_linode_ip"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/ips/{address}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'address' + '}', CGI.escape(address.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] || 'GetLinodeIp200Response'

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

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

#get_linode_ips(api_version, linode_id, opts = {}) ⇒ GetLinodeIps200Response

Get networking information Returns networking information for a single Linode. __Note__. If the target Linode has several configuration profiles that include a Virtual Private Cloud (VPC) interface, address information for all of VPCs will be listed in the response. <<LB>> — - __CLI__. “‘ linode-cli linodes ips-list 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:



1587
1588
1589
1590
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1587

def get_linode_ips(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_linode_ips_with_http_info(api_version, linode_id, opts)
  data
end

#get_linode_ips_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(GetLinodeIps200Response, Integer, Hash)>

Get networking information Returns networking information for a single Linode. __Note__. If the target Linode has several configuration profiles that include a Virtual Private Cloud (VPC) interface, address information for all of VPCs will be listed in the response. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes ips-list 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:

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

    GetLinodeIps200Response data, response status code and response headers



1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1598

def get_linode_ips_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_ips ...'
  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 LinodeInstancesApi.get_linode_ips"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_ips"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/ips'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetLinodeIps200Response'

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

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

#get_linode_node_balancers(api_version, linode_id, opts = {}) ⇒ GetLinodeNodeBalancers200Response

List Linode NodeBalancers Returns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User. Read permission to a NodeBalancer can be given to a User by accessing the [Update a user’s grants](techdocs.akamai.com/linode-api/reference/put-user-grants) operation. <<LB>> — - __CLI__. “‘ linode-cli linodes nodebalancers 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:



1661
1662
1663
1664
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1661

def get_linode_node_balancers(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_linode_node_balancers_with_http_info(api_version, linode_id, opts)
  data
end

#get_linode_node_balancers_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(GetLinodeNodeBalancers200Response, Integer, Hash)>

List Linode NodeBalancers Returns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User. Read permission to a NodeBalancer can be given to a User by accessing the [Update a user&#39;s grants](techdocs.akamai.com/linode-api/reference/put-user-grants) operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes nodebalancers 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:



1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1672

def get_linode_node_balancers_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_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 LinodeInstancesApi.get_linode_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
  # verify the required parameter 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_node_balancers"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/nodebalancers'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetLinodeNodeBalancers200Response'

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

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

#get_linode_stats(api_version, linode_id, opts = {}) ⇒ GetLinodeStats200Response

Get Linode statistics Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours. <<LB>> — - __OAuth scopes__. “‘ linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:



1735
1736
1737
1738
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1735

def get_linode_stats(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_linode_stats_with_http_info(api_version, linode_id, opts)
  data
end

#get_linode_stats_by_year_month(api_version, linode_id, year, month, opts = {}) ⇒ GetLinodeStatsByYearMonth200Response

Get monthly statistics Returns statistics for a specific month. The year/month values must be either a date in the past, or the current month. If the current month, statistics will be retrieved for the past 30 days. <<LB>> — - __OAuth scopes__. “‘ linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • year (Integer) —

    Numeric value representing the year to look up.

  • month (Integer) —

    Numeric value representing the month to look up.

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

    the optional parameters

Returns:



1811
1812
1813
1814
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1811

def get_linode_stats_by_year_month(api_version, linode_id, year, month, opts = {})
  data, _status_code, _headers = get_linode_stats_by_year_month_with_http_info(api_version, linode_id, year, month, opts)
  data
end

#get_linode_stats_by_year_month_with_http_info(api_version, linode_id, year, month, opts = {}) ⇒ Array<(GetLinodeStatsByYearMonth200Response, Integer, Hash)>

Get monthly statistics Returns statistics for a specific month. The year/month values must be either a date in the past, or the current month. If the current month, statistics will be retrieved for the past 30 days. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • year (Integer) —

    Numeric value representing the year to look up.

  • month (Integer) —

    Numeric value representing the month to look up.

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

    the optional parameters

Returns:



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1824

def get_linode_stats_by_year_month_with_http_info(api_version, linode_id, year, month, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_stats_by_year_month ...'
  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 LinodeInstancesApi.get_linode_stats_by_year_month"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_stats_by_year_month"
  end
  # verify the required parameter 'year' is set
  if @api_client.config.client_side_validation && year.nil?
    fail ArgumentError, "Missing the required parameter 'year' when calling LinodeInstancesApi.get_linode_stats_by_year_month"
  end
  # verify the required parameter 'month' is set
  if @api_client.config.client_side_validation && month.nil?
    fail ArgumentError, "Missing the required parameter 'month' when calling LinodeInstancesApi.get_linode_stats_by_year_month"
  end
  if @api_client.config.client_side_validation && month > 12
    fail ArgumentError, 'invalid value for "month" when calling LinodeInstancesApi.get_linode_stats_by_year_month, must be smaller than or equal to 12.'
  end

  if @api_client.config.client_side_validation && month < 1
    fail ArgumentError, 'invalid value for "month" when calling LinodeInstancesApi.get_linode_stats_by_year_month, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/stats/{year}/{month}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'year' + '}', CGI.escape(year.to_s)).sub('{' + 'month' + '}', CGI.escape(month.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] || 'GetLinodeStatsByYearMonth200Response'

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

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

#get_linode_stats_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(GetLinodeStats200Response, Integer, Hash)>

Get Linode statistics Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:

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

    GetLinodeStats200Response data, response status code and response headers



1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1746

def get_linode_stats_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_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 LinodeInstancesApi.get_linode_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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_stats"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/stats'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetLinodeStats200Response'

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

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

#get_linode_transfer(api_version, linode_id, opts = {}) ⇒ GetLinodeTransfer200Response

Get a network transfer Returns a Linode’s network transfer pool statistics for the current month. <<LB>> — - __CLI__. “‘ linode-cli linodes transfer-view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:



1903
1904
1905
1906
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1903

def get_linode_transfer(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_linode_transfer_with_http_info(api_version, linode_id, opts)
  data
end

#get_linode_transfer_by_year_month(api_version, linode_id, year, month, opts = {}) ⇒ GetLinodeTransferByYearMonth200Response

Get monthly network transfer stats Returns a Linode’s network transfer statistics for a specific month. The year/month values must be either a date in the past, or the current month. <<LB>> — - __OAuth scopes__. “‘ linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • year (Integer) —

    Numeric value representing the year to look up.

  • month (Integer) —

    Numeric value representing the month to look up.

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

    the optional parameters

Returns:



1979
1980
1981
1982
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1979

def get_linode_transfer_by_year_month(api_version, linode_id, year, month, opts = {})
  data, _status_code, _headers = get_linode_transfer_by_year_month_with_http_info(api_version, linode_id, year, month, opts)
  data
end

#get_linode_transfer_by_year_month_with_http_info(api_version, linode_id, year, month, opts = {}) ⇒ Array<(GetLinodeTransferByYearMonth200Response, Integer, Hash)>

Get monthly network transfer stats Returns a Linode&#39;s network transfer statistics for a specific month. The year/month values must be either a date in the past, or the current month. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • year (Integer) —

    Numeric value representing the year to look up.

  • month (Integer) —

    Numeric value representing the month to look up.

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

    the optional parameters

Returns:



1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1992

def get_linode_transfer_by_year_month_with_http_info(api_version, linode_id, year, month, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_transfer_by_year_month ...'
  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 LinodeInstancesApi.get_linode_transfer_by_year_month"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_transfer_by_year_month"
  end
  # verify the required parameter 'year' is set
  if @api_client.config.client_side_validation && year.nil?
    fail ArgumentError, "Missing the required parameter 'year' when calling LinodeInstancesApi.get_linode_transfer_by_year_month"
  end
  if @api_client.config.client_side_validation && year > 2037
    fail ArgumentError, 'invalid value for "year" when calling LinodeInstancesApi.get_linode_transfer_by_year_month, must be smaller than or equal to 2037.'
  end

  if @api_client.config.client_side_validation && year < 2000
    fail ArgumentError, 'invalid value for "year" when calling LinodeInstancesApi.get_linode_transfer_by_year_month, must be greater than or equal to 2000.'
  end

  # verify the required parameter 'month' is set
  if @api_client.config.client_side_validation && month.nil?
    fail ArgumentError, "Missing the required parameter 'month' when calling LinodeInstancesApi.get_linode_transfer_by_year_month"
  end
  if @api_client.config.client_side_validation && month > 12
    fail ArgumentError, 'invalid value for "month" when calling LinodeInstancesApi.get_linode_transfer_by_year_month, must be smaller than or equal to 12.'
  end

  if @api_client.config.client_side_validation && month < 1
    fail ArgumentError, 'invalid value for "month" when calling LinodeInstancesApi.get_linode_transfer_by_year_month, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/transfer/{year}/{month}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'year' + '}', CGI.escape(year.to_s)).sub('{' + 'month' + '}', CGI.escape(month.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] || 'GetLinodeTransferByYearMonth200Response'

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

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

#get_linode_transfer_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(GetLinodeTransfer200Response, Integer, Hash)>

Get a network transfer Returns a Linode&#39;s network transfer pool statistics for the current month. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes transfer-view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

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

    the optional parameters

Returns:



1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 1914

def get_linode_transfer_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_transfer ...'
  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 LinodeInstancesApi.get_linode_transfer"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_transfer"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/transfer'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetLinodeTransfer200Response'

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

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

#get_linode_type(api_version, type_id, opts = {}) ⇒ GetLinodeType200Response

Get a type Returns information about a specific Linode Type, including pricing and specifications. This is used when [creating](techdocs.akamai.com/linode-api/reference/post-linode-instance) or [resizing](techdocs.akamai.com/linode-api/reference/post-resize-linode-instance) Linodes. <<LB>> — - __CLI__. “‘ linode-cli linodes type-view g6-standard-2 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

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

  • type_id (String) —

    The ID of the Linode Type to look up.

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

    the optional parameters

Returns:



2079
2080
2081
2082
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2079

def get_linode_type(api_version, type_id, opts = {})
  data, _status_code, _headers = get_linode_type_with_http_info(api_version, type_id, opts)
  data
end

#get_linode_type_with_http_info(api_version, type_id, opts = {}) ⇒ Array<(GetLinodeType200Response, Integer, Hash)>

Get a type Returns information about a specific Linode Type, including pricing and specifications. This is used when [creating](techdocs.akamai.com/linode-api/reference/post-linode-instance) or [resizing](techdocs.akamai.com/linode-api/reference/post-resize-linode-instance) Linodes. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes type-view g6-standard-2 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

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

  • type_id (String) —

    The ID of the Linode Type to look up.

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

    the optional parameters

Returns:

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

    GetLinodeType200Response data, response status code and response headers



2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2090

def get_linode_type_with_http_info(api_version, type_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_type ...'
  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 LinodeInstancesApi.get_linode_type"
  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 'type_id' is set
  if @api_client.config.client_side_validation && type_id.nil?
    fail ArgumentError, "Missing the required parameter 'type_id' when calling LinodeInstancesApi.get_linode_type"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/types/{typeId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'typeId' + '}', CGI.escape(type_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] || 'GetLinodeType200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_linode_types(api_version, opts = {}) ⇒ GetLinodeTypes200Response

List types Returns collection of Linode Types, including pricing and specifications for each Type. These are used when [creating](techdocs.akamai.com/linode-api/reference/post-linode-instance) or [resizing](techdocs.akamai.com/linode-api/reference/post-resize-linode-instance) Linodes. <<LB>> — - __CLI__. “‘ linode-cli linodes types “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

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

Returns:



2152
2153
2154
2155
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2152

def get_linode_types(api_version, opts = {})
  data, _status_code, _headers = get_linode_types_with_http_info(api_version, opts)
  data
end

#get_linode_types_with_http_info(api_version, opts = {}) ⇒ Array<(GetLinodeTypes200Response, Integer, Hash)>

List types Returns collection of Linode Types, including pricing and specifications for each Type. These are used when [creating](techdocs.akamai.com/linode-api/reference/post-linode-instance) or [resizing](techdocs.akamai.com/linode-api/reference/post-resize-linode-instance) Linodes. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes types &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

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

Returns:

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

    GetLinodeTypes200Response data, response status code and response headers



2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2162

def get_linode_types_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_types ...'
  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 LinodeInstancesApi.get_linode_types"
  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
  # resource path
  local_var_path = '/{apiVersion}/linode/types'.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']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#get_linode_volumes(api_version, linode_id, opts = {}) ⇒ GetLinodeVolumes200Response

List a Linode’s volumes View Block Storage Volumes attached to this Linode. <<LB>> — - __CLI__. “‘ linode-cli linodes volumes 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • 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:



2223
2224
2225
2226
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2223

def get_linode_volumes(api_version, linode_id, opts = {})
  data, _status_code, _headers = get_linode_volumes_with_http_info(api_version, linode_id, opts)
  data
end

#get_linode_volumes_with_http_info(api_version, linode_id, opts = {}) ⇒ Array<(GetLinodeVolumes200Response, Integer, Hash)>

List a Linode&#39;s volumes View Block Storage Volumes attached to this Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes volumes 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • 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<(GetLinodeVolumes200Response, Integer, Hash)>) —

    GetLinodeVolumes200Response data, response status code and response headers



2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2236

def get_linode_volumes_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.get_linode_volumes ...'
  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 LinodeInstancesApi.get_linode_volumes"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.get_linode_volumes"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling LinodeInstancesApi.get_linode_volumes, 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 LinodeInstancesApi.get_linode_volumes, 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 LinodeInstancesApi.get_linode_volumes, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/volumes'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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] || 'GetLinodeVolumes200Response'

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

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

#post_add_linode_config(api_version, linode_id, post_add_linode_config_request, opts = {}) ⇒ PostAddLinodeConfig200Response

Create a config profile Adds a new Configuration profile to a Linode. <<LB>> — - __CLI__. “‘ linode-cli linodes config-create 7590910 \ –label "My Config" \ –devices.sda.disk_id 123456 \ –devices.sdb.disk_id 123457 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up Configuration profiles for.

  • post_add_linode_config_request (PostAddLinodeConfigRequest) —

    The parameters to set when creating the Configuration profile. This determines which kernel, devices, how much memory, etc. a Linode boots with.

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

    the optional parameters

Returns:



2314
2315
2316
2317
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2314

def post_add_linode_config(api_version, linode_id, post_add_linode_config_request, opts = {})
  data, _status_code, _headers = post_add_linode_config_with_http_info(api_version, linode_id, post_add_linode_config_request, opts)
  data
end

#post_add_linode_config_with_http_info(api_version, linode_id, post_add_linode_config_request, opts = {}) ⇒ Array<(PostAddLinodeConfig200Response, Integer, Hash)>

Create a config profile Adds a new Configuration profile to a Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-create 7590910 \ –label &quot;My Config&quot; \ –devices.sda.disk_id 123456 \ –devices.sdb.disk_id 123457 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up Configuration profiles for.

  • post_add_linode_config_request (PostAddLinodeConfigRequest) —

    The parameters to set when creating the Configuration profile. This determines which kernel, devices, how much memory, etc. a Linode boots with.

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

    the optional parameters

Returns:



2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2326

def post_add_linode_config_with_http_info(api_version, linode_id, post_add_linode_config_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_add_linode_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 LinodeInstancesApi.post_add_linode_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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_add_linode_config"
  end
  # verify the required parameter 'post_add_linode_config_request' is set
  if @api_client.config.client_side_validation && post_add_linode_config_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_add_linode_config_request' when calling LinodeInstancesApi.post_add_linode_config"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_add_linode_config_request)

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

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

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

#post_add_linode_disk(api_version, linode_id, post_add_linode_disk_request, opts = {}) ⇒ PostAddLinodeDisk200Response

Create a disk Adds a new Disk to a Linode. - You can optionally create a Disk from an Image or an Empty Disk if no Image is provided with a request. - When creating an Empty Disk, providing a ‘label` is required. - If no `label` is provided, an `image` is required instead. - When creating a Disk from an Image, `root_pass` is required. - The default filesystem for new Disks is `ext4`. If creating a Disk from an Image, the filesystem of the Image is used unless otherwise specified. - When deploying a StackScript on a Disk: - Run [List StackScripts](techdocs.akamai.com/linode-api/reference/get-stack-scripts) for a list of available StackScripts. - Requires a compatible Image to be supplied. - Run [Get a StackScript](techdocs.akamai.com/linode-api/reference/get-stack-script) for compatible Images. - It is recommended to supply SSH keys for the root User using the `authorized_keys` field. - You may also supply a list of usernames via the `authorized_users` field. - These users must have an SSH Key associated with their Profiles first. See [Add an SSH key](techdocs.akamai.com/linode-api/reference/post-add-ssh-key) for more information. <<LB>> — - __CLI__. “` linode-cli linodes disk-create 123 \ –size 1300 \ –authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \ –authorized_users "myUser" \ –authorized_users "secondaryUser" \ –root_pass aComplex@Password \ –image "linode/debian9" \ –stackscript_id 10079 \ –stackscript_data ’"linode"‘ “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • post_add_linode_disk_request (PostAddLinodeDiskRequest) —

    The parameters to set when creating the Disk.

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

    the optional parameters

Returns:



2399
2400
2401
2402
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2399

def post_add_linode_disk(api_version, linode_id, post_add_linode_disk_request, opts = {})
  data, _status_code, _headers = post_add_linode_disk_with_http_info(api_version, linode_id, post_add_linode_disk_request, opts)
  data
end

#post_add_linode_disk_with_http_info(api_version, linode_id, post_add_linode_disk_request, opts = {}) ⇒ Array<(PostAddLinodeDisk200Response, Integer, Hash)>

Create a disk Adds a new Disk to a Linode. - You can optionally create a Disk from an Image or an Empty Disk if no Image is provided with a request. - When creating an Empty Disk, providing a &#x60;label&#x60; is required. - If no &#x60;label&#x60; is provided, an &#x60;image&#x60; is required instead. - When creating a Disk from an Image, &#x60;root_pass&#x60; is required. - The default filesystem for new Disks is &#x60;ext4&#x60;. If creating a Disk from an Image, the filesystem of the Image is used unless otherwise specified. - When deploying a StackScript on a Disk: - Run [List StackScripts](techdocs.akamai.com/linode-api/reference/get-stack-scripts) for a list of available StackScripts. - Requires a compatible Image to be supplied. - Run [Get a StackScript](techdocs.akamai.com/linode-api/reference/get-stack-script) for compatible Images. - It is recommended to supply SSH keys for the root User using the &#x60;authorized_keys&#x60; field. - You may also supply a list of usernames via the &#x60;authorized_users&#x60; field. - These users must have an SSH Key associated with their Profiles first. See [Add an SSH key](techdocs.akamai.com/linode-api/reference/post-add-ssh-key) for more information. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes disk-create 123 \ –size 1300 \ –authorized_keys &quot;ssh-rsa AAAA_valid_public_ssh_key_123456785&#x3D;&#x3D; user@their-computer&quot; \ –authorized_users &quot;myUser&quot; \ –authorized_users &quot;secondaryUser&quot; \ –root_pass aComplex@Password \ –image &quot;linode/debian9&quot; \ –stackscript_id 10079 \ –stackscript_data &#39;&quot;linode&quot;&#39; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • post_add_linode_disk_request (PostAddLinodeDiskRequest) —

    The parameters to set when creating the Disk.

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

    the optional parameters

Returns:



2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2411

def post_add_linode_disk_with_http_info(api_version, linode_id, post_add_linode_disk_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_add_linode_disk ...'
  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 LinodeInstancesApi.post_add_linode_disk"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_add_linode_disk"
  end
  # verify the required parameter 'post_add_linode_disk_request' is set
  if @api_client.config.client_side_validation && post_add_linode_disk_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_add_linode_disk_request' when calling LinodeInstancesApi.post_add_linode_disk"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/disks'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_add_linode_disk_request)

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

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

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

#post_add_linode_ip(api_version, linode_id, post_add_linode_ip_request, opts = {}) ⇒ PostAddLinodeIp200Response

Allocate an IPv4 address Allocates a public or private IPv4 address to a Linode. Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please [Open a support ticket](techdocs.akamai.com/linode-api/reference/post-ticket). You may not add more than one private IPv4 address to a single Linode. <<LB>> — - __CLI__. “‘ linode-cli linodes ip-add 123 \ –type ipv4 \ –public true “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • post_add_linode_ip_request (PostAddLinodeIpRequest) —

    Information about the address you are creating.

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

    the optional parameters

Returns:



2484
2485
2486
2487
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2484

def post_add_linode_ip(api_version, linode_id, post_add_linode_ip_request, opts = {})
  data, _status_code, _headers = post_add_linode_ip_with_http_info(api_version, linode_id, post_add_linode_ip_request, opts)
  data
end

#post_add_linode_ip_with_http_info(api_version, linode_id, post_add_linode_ip_request, opts = {}) ⇒ Array<(PostAddLinodeIp200Response, Integer, Hash)>

Allocate an IPv4 address Allocates a public or private IPv4 address to a Linode. Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please [Open a support ticket](techdocs.akamai.com/linode-api/reference/post-ticket). You may not add more than one private IPv4 address to a single Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes ip-add 123 \ –type ipv4 \ –public true &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • post_add_linode_ip_request (PostAddLinodeIpRequest) —

    Information about the address you are creating.

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

    the optional parameters

Returns:

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

    PostAddLinodeIp200Response data, response status code and response headers



2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2496

def post_add_linode_ip_with_http_info(api_version, linode_id, post_add_linode_ip_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_add_linode_ip ...'
  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 LinodeInstancesApi.post_add_linode_ip"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_add_linode_ip"
  end
  # verify the required parameter 'post_add_linode_ip_request' is set
  if @api_client.config.client_side_validation && post_add_linode_ip_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_add_linode_ip_request' when calling LinodeInstancesApi.post_add_linode_ip"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/ips'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_add_linode_ip_request)

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

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

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

#post_boot_linode_instance(api_version, linode_id, opts = {}) ⇒ Object

Boot a Linode Boots a Linode you have permission to modify. If no parameters are given, a Config profile will be chosen for this boot based on the following criteria: - If there is only one Config profile for this Linode, it will be used. - If there is more than one Config profile, the last booted config will be used. - If there is more than one Config profile and none were the last to be booted (because the Linode was never booted or the last booted config was deleted) an error will be returned. <<LB>> — - __CLI__. “‘ linode-cli linodes boot 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode to boot.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


2569
2570
2571
2572
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2569

def post_boot_linode_instance(api_version, linode_id, opts = {})
  data, _status_code, _headers = post_boot_linode_instance_with_http_info(api_version, linode_id, opts)
  data
end

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

Boot a Linode Boots a Linode you have permission to modify. If no parameters are given, a Config profile will be chosen for this boot based on the following criteria: - If there is only one Config profile for this Linode, it will be used. - If there is more than one Config profile, the last booted config will be used. - If there is more than one Config profile and none were the last to be booted (because the Linode was never booted or the last booted config was deleted) an error will be returned. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes boot 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode to boot.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2581

def post_boot_linode_instance_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_boot_linode_instance ...'
  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 LinodeInstancesApi.post_boot_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_boot_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/boot'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_boot_linode_instance_request'])

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

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

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

#post_cancel_backups(api_version, linode_id, opts = {}) ⇒ Object

Cancel backups Cancels the Backup service on the given Linode. Deletes all of this Linode’s existing backups forever. <<LB>> — - __CLI__. “‘ linode-cli linodes backups-cancel 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode to cancel backup service for.

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

    the optional parameters

Returns:

  • (Object) 


2649
2650
2651
2652
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2649

def post_cancel_backups(api_version, linode_id, opts = {})
  data, _status_code, _headers = post_cancel_backups_with_http_info(api_version, linode_id, opts)
  data
end

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

Cancel backups Cancels the Backup service on the given Linode. Deletes all of this Linode&#39;s existing backups forever. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes backups-cancel 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode to cancel backup service for.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2660

def post_cancel_backups_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_cancel_backups ...'
  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 LinodeInstancesApi.post_cancel_backups"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_cancel_backups"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/backups/cancel'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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 => :"LinodeInstancesApi.post_cancel_backups",
    :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: LinodeInstancesApi#post_cancel_backups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_clone_linode_disk(api_version, linode_id, disk_id, opts = {}) ⇒ PostCloneLinodeDisk200Response

Clone a disk Copies a disk, byte-for-byte, into a new Disk belonging to the same Linode. The Linode must have enough storage space available to accept a new Disk of the same size as this one or this operation will fail. <<LB>> — - __CLI__. “‘ linode-cli linodes disk-clone “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to clone.

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

    the optional parameters

Returns:



2724
2725
2726
2727
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2724

def post_clone_linode_disk(api_version, linode_id, disk_id, opts = {})
  data, _status_code, _headers = post_clone_linode_disk_with_http_info(api_version, linode_id, disk_id, opts)
  data
end

#post_clone_linode_disk_with_http_info(api_version, linode_id, disk_id, opts = {}) ⇒ Array<(PostCloneLinodeDisk200Response, Integer, Hash)>

Clone a disk Copies a disk, byte-for-byte, into a new Disk belonging to the same Linode. The Linode must have enough storage space available to accept a new Disk of the same size as this one or this operation will fail. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes disk-clone &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to clone.

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

    the optional parameters

Returns:



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2736

def post_clone_linode_disk_with_http_info(api_version, linode_id, disk_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_clone_linode_disk ...'
  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 LinodeInstancesApi.post_clone_linode_disk"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_clone_linode_disk"
  end
  # verify the required parameter 'disk_id' is set
  if @api_client.config.client_side_validation && disk_id.nil?
    fail ArgumentError, "Missing the required parameter 'disk_id' when calling LinodeInstancesApi.post_clone_linode_disk"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/disks/{diskId}/clone'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'diskId' + '}', CGI.escape(disk_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] || 'PostCloneLinodeDisk200Response'

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

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

#post_clone_linode_instance(api_version, linode_id, post_clone_linode_instance_request, opts = {}) ⇒ Linode2

Clone a Linode You can clone your Linode’s existing Disks or Configuration profiles to another Linode on your Account. In order for this request to complete successfully, your User must have the ‘add_linodes` grant. Cloning to a new Linode will incur a charge on your Account. If cloning to an existing Linode, any actions currently running or queued must be completed first before you can clone to it. Up to five clone operations from any given source Linode can be run concurrently. If more concurrent clones are attempted, an HTTP 400 error will be returned by this operation. Any [tags](techdocs.akamai.com/linode-api/reference/get-tags) existing on the source Linode will be cloned to the target Linode. Linodes utilizing Metadata (`"has_user_data": true`) must be cloned to a new Linode with `metadata.user_data` included with the clone request. `vpc` details - If the Linode you are cloning has a `vpc` purpose Interface on its active Configuration Profile that includes a 1:1 NAT, the resulting clone is configured with an `any` 1:1 NAT. - See the [VPC documentation](www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. `vlan` details - Only Next Generation Network (NGN) data centers support VLANs. If a VLAN is attached to your Linode and you attempt clone it to a non-NGN data center, the cloning will not initiate. If a Linode cannot be cloned because of an incompatibility, you will be prompted to select a different data center or contact support. - See the [VLANs Overview](www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations. <<LB>> — - __CLI__. “` linode-cli linodes clone 123 \ –linode_id 124 \ –region us-east \ –type g6-standard-2 \ –label cloned-linode \ –backups_enabled true \ –placement_group.id 528 \ –disks 25674 \ –configs 23456 \ –private_ip true \ –metadata.user_data I2Nsb3VkLWNvbmZpZw== “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to clone.

  • post_clone_linode_instance_request (PostCloneLinodeInstanceRequest) —

    The requested state your Linode will be cloned into.

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

    the optional parameters

Returns:



2804
2805
2806
2807
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2804

def post_clone_linode_instance(api_version, linode_id, post_clone_linode_instance_request, opts = {})
  data, _status_code, _headers = post_clone_linode_instance_with_http_info(api_version, linode_id, post_clone_linode_instance_request, opts)
  data
end

#post_clone_linode_instance_with_http_info(api_version, linode_id, post_clone_linode_instance_request, opts = {}) ⇒ Array<(Linode2, Integer, Hash)>

Clone a Linode You can clone your Linode&#39;s existing Disks or Configuration profiles to another Linode on your Account. In order for this request to complete successfully, your User must have the &#x60;add_linodes&#x60; grant. Cloning to a new Linode will incur a charge on your Account. If cloning to an existing Linode, any actions currently running or queued must be completed first before you can clone to it. Up to five clone operations from any given source Linode can be run concurrently. If more concurrent clones are attempted, an HTTP 400 error will be returned by this operation. Any [tags](techdocs.akamai.com/linode-api/reference/get-tags) existing on the source Linode will be cloned to the target Linode. Linodes utilizing Metadata (&#x60;&quot;has_user_data&quot;: true&#x60;) must be cloned to a new Linode with &#x60;metadata.user_data&#x60; included with the clone request. &#x60;vpc&#x60; details - If the Linode you are cloning has a &#x60;vpc&#x60; purpose Interface on its active Configuration Profile that includes a 1:1 NAT, the resulting clone is configured with an &#x60;any&#x60; 1:1 NAT. - See the [VPC documentation](www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. &#x60;vlan&#x60; details - Only Next Generation Network (NGN) data centers support VLANs. If a VLAN is attached to your Linode and you attempt clone it to a non-NGN data center, the cloning will not initiate. If a Linode cannot be cloned because of an incompatibility, you will be prompted to select a different data center or contact support. - See the [VLANs Overview](www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes clone 123 \ –linode_id 124 \ –region us-east \ –type g6-standard-2 \ –label cloned-linode \ –backups_enabled true \ –placement_group.id 528 \ –disks 25674 \ –configs 23456 \ –private_ip true \ –metadata.user_data I2Nsb3VkLWNvbmZpZw&#x3D;&#x3D; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to clone.

  • post_clone_linode_instance_request (PostCloneLinodeInstanceRequest) —

    The requested state your Linode will be cloned into.

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

    the optional parameters

Returns:

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

    Linode2 data, response status code and response headers



2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2816

def post_clone_linode_instance_with_http_info(api_version, linode_id, post_clone_linode_instance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_clone_linode_instance ...'
  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 LinodeInstancesApi.post_clone_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_clone_linode_instance"
  end
  # verify the required parameter 'post_clone_linode_instance_request' is set
  if @api_client.config.client_side_validation && post_clone_linode_instance_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_clone_linode_instance_request' when calling LinodeInstancesApi.post_clone_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/clone'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_clone_linode_instance_request)

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

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

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

#post_enable_backups(api_version, linode_id, opts = {}) ⇒ Object

Enable backups Enables backups for the specified Linode. __Note__. Backups are not encrypted even when they are taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again. <<LB>> — - __CLI__. “‘ linode-cli linodes backups-enable 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode to enable backup service for.

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

    the optional parameters

Returns:

  • (Object) 


2888
2889
2890
2891
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2888

def post_enable_backups(api_version, linode_id, opts = {})
  data, _status_code, _headers = post_enable_backups_with_http_info(api_version, linode_id, opts)
  data
end

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

Enable backups Enables backups for the specified Linode. __Note__. Backups are not encrypted even when they are taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes backups-enable 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode to enable backup service for.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2899

def post_enable_backups_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_enable_backups ...'
  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 LinodeInstancesApi.post_enable_backups"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_enable_backups"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/backups/enable'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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 => :"LinodeInstancesApi.post_enable_backups",
    :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: LinodeInstancesApi#post_enable_backups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_linode_config_interface(api_version, linode_id, config_id, post_linode_config_interface_request, opts = {}) ⇒ PostLinodeConfigInterface200Response

Add a configuration profile interface Creates and appends a single Interface to the end of the ‘interfaces` array for an existing Configuration Profile. - The User accessing this operation must have `read_write` grants to the Linode. - A successful request triggers a `linode_config_update` event. - If the new Interface is added with `"primary": true`, then any existing primary Interface is changed to `"primary": false`. Reboot the Linode with this Configuration Profile to activate an Interface that was added with this operation. <<LB>> — - __CLI__. “` linode-cli linodes config-interface-add $linodeId $configId \ –purpose vpc \ –primary false \ –subnet_id 101 \ –ipv4.vpc "10.0.1.2" \ –ipv4.nat_1_1 "203.0.113.2" “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • post_linode_config_interface_request (PostLinodeConfigInterfaceRequest) —

    The Interface to add to the Configuration Profile.

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

    the optional parameters

Returns:



2964
2965
2966
2967
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2964

def post_linode_config_interface(api_version, linode_id, config_id, post_linode_config_interface_request, opts = {})
  data, _status_code, _headers = post_linode_config_interface_with_http_info(api_version, linode_id, config_id, post_linode_config_interface_request, opts)
  data
end

#post_linode_config_interface_with_http_info(api_version, linode_id, config_id, post_linode_config_interface_request, opts = {}) ⇒ Array<(PostLinodeConfigInterface200Response, Integer, Hash)>

Add a configuration profile interface Creates and appends a single Interface to the end of the &#x60;interfaces&#x60; array for an existing Configuration Profile. - The User accessing this operation must have &#x60;read_write&#x60; grants to the Linode. - A successful request triggers a &#x60;linode_config_update&#x60; event. - If the new Interface is added with &#x60;&quot;primary&quot;: true&#x60;, then any existing primary Interface is changed to &#x60;&quot;primary&quot;: false&#x60;. Reboot the Linode with this Configuration Profile to activate an Interface that was added with this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-interface-add $linodeId $configId \ –purpose vpc \ –primary false \ –subnet_id 101 \ –ipv4.vpc &quot;10.0.1.2&quot; \ –ipv4.nat_1_1 &quot;203.0.113.2&quot; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • post_linode_config_interface_request (PostLinodeConfigInterfaceRequest) —

    The Interface to add to the Configuration Profile.

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

    the optional parameters

Returns:



2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 2977

def post_linode_config_interface_with_http_info(api_version, linode_id, config_id, post_linode_config_interface_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_linode_config_interface ...'
  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 LinodeInstancesApi.post_linode_config_interface"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_linode_config_interface"
  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 LinodeInstancesApi.post_linode_config_interface"
  end
  # verify the required parameter 'post_linode_config_interface_request' is set
  if @api_client.config.client_side_validation && post_linode_config_interface_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_linode_config_interface_request' when calling LinodeInstancesApi.post_linode_config_interface"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_linode_config_interface_request)

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

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

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

#post_linode_config_interfaces(api_version, linode_id, config_id, post_linode_config_interfaces_request, opts = {}) ⇒ Object

Reorder configuration profile interfaces Reorders the existing Interfaces of a Configuration Profile. - The User accessing this operation must have ‘read_write` grants to the Linode. <<LB>> — - __CLI__. “` linode-cli linodes config-interfaces-order $linodeId $configId \ –ids 101 –ids 102 –ids 103 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • post_linode_config_interfaces_request (PostLinodeConfigInterfacesRequest) —

    The desired Interface order for the Configuration Profile.

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

    the optional parameters

Returns:

  • (Object) 


3055
3056
3057
3058
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3055

def post_linode_config_interfaces(api_version, linode_id, config_id, post_linode_config_interfaces_request, opts = {})
  data, _status_code, _headers = post_linode_config_interfaces_with_http_info(api_version, linode_id, config_id, post_linode_config_interfaces_request, opts)
  data
end

#post_linode_config_interfaces_with_http_info(api_version, linode_id, config_id, post_linode_config_interfaces_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Reorder configuration profile interfaces Reorders the existing Interfaces of a Configuration Profile. - The User accessing this operation must have &#x60;read_write&#x60; grants to the Linode. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-interfaces-order $linodeId $configId \ –ids 101 –ids 102 –ids 103 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • post_linode_config_interfaces_request (PostLinodeConfigInterfacesRequest) —

    The desired Interface order for the Configuration Profile.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3068

def post_linode_config_interfaces_with_http_info(api_version, linode_id, config_id, post_linode_config_interfaces_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_linode_config_interfaces ...'
  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 LinodeInstancesApi.post_linode_config_interfaces"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_linode_config_interfaces"
  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 LinodeInstancesApi.post_linode_config_interfaces"
  end
  # verify the required parameter 'post_linode_config_interfaces_request' is set
  if @api_client.config.client_side_validation && post_linode_config_interfaces_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_linode_config_interfaces_request' when calling LinodeInstancesApi.post_linode_config_interfaces"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces/order'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_linode_config_interfaces_request)

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

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

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

#post_linode_instance(api_version, post_linode_instance_request, opts = {}) ⇒ Linode1

Create a Linode Creates a Linode Instance on your Account. In order for this request to complete successfully, your User must have the ‘add_linodes` grant. Creating a new Linode will incur a charge on your Account. Linodes can be created using one of the available Types. Run [List Linode types](techdocs.akamai.com/linode-api/reference/get-linode-types) to get more information about each Type’s specs and cost. Linodes can be created in any one of our available Regions, which are accessible from the [List regions](techdocs.akamai.com/linode-api/reference/get-regions) operation. In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587 on all Linodes for new accounts created after November 5th, 2019. For more information, see our guide on [Running a Mail Server](www.linode.com/docs/guides/running-a-mail-server/). __Important__. You must be an unrestricted User in order to add or modify tags on Linodes. Linodes can be created in a number of ways: - Using a Linode Public Image distribution or a Private Image you created based on another Linode. - Run the [List images](techdocs.akamai.com/linode-api/reference/get-images) operation with authentication to view all available Images. - The Linode will be ‘running` after it completes `provisioning`. - A default config with two Disks, one being a 512 swap disk, is created. - `swap_size` can be used to customize the swap disk size. - Requires a `root_pass` be supplied to use for the root User’s Account. - It is recommended to supply SSH keys for the root User using the ‘authorized_keys` field. - You may also supply a list of usernames via the `authorized_users` field. - These users must have an SSH Key associated with your Profile first. See the [Add an SSH key](techdocs.akamai.com/linode-api/reference/post-add-ssh-key)) operation for more information. - Using cloud-init with [Metadata](www.linode.com/docs/products/compute/compute-instances/guides/metadata/). - Automate system configuration and software installation by providing a base-64 encoded [cloud-config](www.linode.com/docs/products/compute/compute-instances/guides/metadata-cloud-config/) file. - Requires a compatible Image. You can determine compatible Images by checking for `cloud-init` under `capabilities` when running [List images](techdocs.akamai.com/linode-api/reference/get-images). - Requires a compatible Region. You can determine compatible Regions by checking for `Metadata` under `capabilities` when running [List regions](techdocs.akamai.com/linode-api/reference/get-regions). - Using a StackScript. - Run [List StackScripts](techdocs.akamai.com/linode-api/reference/get-stack-scripts) for a list of available StackScripts. - The Linode will be `running` after it completes `provisioning`. - Requires a compatible Image to be supplied. - Run [Get a StackScript](techdocs.akamai.com/linode-api/reference/get-stack-script) for compatible Images. - Requires a `root_pass` be supplied to use for the root User’s Account. - It is recommended to supply SSH keys for the root User using the ‘authorized_keys` field. - You may also supply a list of usernames via the `authorized_users` field. - These users must have an SSH Key associated with your Profile first. See [Add an SSH key](techdocs.akamai.com/linode-api/reference/post-add-ssh-key) for more information. - Using one of your other Linode’s backups. - You must create a Linode large enough to accommodate the Backup’s size. - The Disks and Config will match that of the Linode that was backed up. - The ‘root_pass` will match that of the Linode that was backed up. - Attached to a private VLAN. - Review the `interfaces` property of the [Request Body Schema](techdocs.akamai.com/linode-api/reference/post-linode-instance) for details. - For more information, see our guide on [Getting Started with VLANs](www.linode.com/docs/products/networking/vlans/get-started/). - Create an empty Linode. - The Linode will remain `offline` and must be manually started. - Run [Boot a Linode](techdocs.akamai.com/linode-api/reference/post-boot-linode-instance). - Disks and Configs must be created manually. - This is only recommended for advanced use cases. <<LB>> — - __CLI__. “` linode-cli linodes create \ –label linode123 \ –root_pass aComplex@Password \ –booted true \ –stackscript_id 10079 \ –stackscript_data ’"linode"‘ \ –region us-east \ –disk_encryption enabled\ –placement_group.id 528 \ –type g6-standard-2 \ –authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \ –authorized_users "myUser" \ –authorized_users "secondaryUser" \ –metadata.user_data "I2Nsb3VkLWNvbmZpZw==" \ –firewall_id 9000 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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_linode_instance_request (PostLinodeInstanceRequest) —

    The requested initial state of a new Linode.

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

    the optional parameters

Returns:



3144
3145
3146
3147
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3144

def post_linode_instance(api_version, post_linode_instance_request, opts = {})
  data, _status_code, _headers = post_linode_instance_with_http_info(api_version, post_linode_instance_request, opts)
  data
end

#post_linode_instance_with_http_info(api_version, post_linode_instance_request, opts = {}) ⇒ Array<(Linode1, Integer, Hash)>

Create a Linode Creates a Linode Instance on your Account. In order for this request to complete successfully, your User must have the &#x60;add_linodes&#x60; grant. Creating a new Linode will incur a charge on your Account. Linodes can be created using one of the available Types. Run [List Linode types](techdocs.akamai.com/linode-api/reference/get-linode-types) to get more information about each Type&#39;s specs and cost. Linodes can be created in any one of our available Regions, which are accessible from the [List regions](techdocs.akamai.com/linode-api/reference/get-regions) operation. In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587 on all Linodes for new accounts created after November 5th, 2019. For more information, see our guide on [Running a Mail Server](www.linode.com/docs/guides/running-a-mail-server/). __Important__. You must be an unrestricted User in order to add or modify tags on Linodes. Linodes can be created in a number of ways: - Using a Linode Public Image distribution or a Private Image you created based on another Linode. - Run the [List images](techdocs.akamai.com/linode-api/reference/get-images) operation with authentication to view all available Images. - The Linode will be &#x60;running&#x60; after it completes &#x60;provisioning&#x60;. - A default config with two Disks, one being a 512 swap disk, is created. - &#x60;swap_size&#x60; can be used to customize the swap disk size. - Requires a &#x60;root_pass&#x60; be supplied to use for the root User&#39;s Account. - It is recommended to supply SSH keys for the root User using the &#x60;authorized_keys&#x60; field. - You may also supply a list of usernames via the &#x60;authorized_users&#x60; field. - These users must have an SSH Key associated with your Profile first. See the [Add an SSH key](techdocs.akamai.com/linode-api/reference/post-add-ssh-key)) operation for more information. - Using cloud-init with [Metadata](www.linode.com/docs/products/compute/compute-instances/guides/metadata/). - Automate system configuration and software installation by providing a base-64 encoded [cloud-config](www.linode.com/docs/products/compute/compute-instances/guides/metadata-cloud-config/) file. - Requires a compatible Image. You can determine compatible Images by checking for &#x60;cloud-init&#x60; under &#x60;capabilities&#x60; when running [List images](techdocs.akamai.com/linode-api/reference/get-images). - Requires a compatible Region. You can determine compatible Regions by checking for &#x60;Metadata&#x60; under &#x60;capabilities&#x60; when running [List regions](techdocs.akamai.com/linode-api/reference/get-regions). - Using a StackScript. - Run [List StackScripts](techdocs.akamai.com/linode-api/reference/get-stack-scripts) for a list of available StackScripts. - The Linode will be &#x60;running&#x60; after it completes &#x60;provisioning&#x60;. - Requires a compatible Image to be supplied. - Run [Get a StackScript](techdocs.akamai.com/linode-api/reference/get-stack-script) for compatible Images. - Requires a &#x60;root_pass&#x60; be supplied to use for the root User&#39;s Account. - It is recommended to supply SSH keys for the root User using the &#x60;authorized_keys&#x60; field. - You may also supply a list of usernames via the &#x60;authorized_users&#x60; field. - These users must have an SSH Key associated with your Profile first. See [Add an SSH key](techdocs.akamai.com/linode-api/reference/post-add-ssh-key) for more information. - Using one of your other Linode&#39;s backups. - You must create a Linode large enough to accommodate the Backup&#39;s size. - The Disks and Config will match that of the Linode that was backed up. - The &#x60;root_pass&#x60; will match that of the Linode that was backed up. - Attached to a private VLAN. - Review the &#x60;interfaces&#x60; property of the [Request Body Schema](techdocs.akamai.com/linode-api/reference/post-linode-instance) for details. - For more information, see our guide on [Getting Started with VLANs](www.linode.com/docs/products/networking/vlans/get-started/). - Create an empty Linode. - The Linode will remain &#x60;offline&#x60; and must be manually started. - Run [Boot a Linode](techdocs.akamai.com/linode-api/reference/post-boot-linode-instance). - Disks and Configs must be created manually. - This is only recommended for advanced use cases. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes create \ –label linode123 \ –root_pass aComplex@Password \ –booted true \ –stackscript_id 10079 \ –stackscript_data &#39;&quot;linode&quot;&#39; \ –region us-east \ –disk_encryption enabled\ –placement_group.id 528 \ –type g6-standard-2 \ –authorized_keys &quot;ssh-rsa AAAA_valid_public_ssh_key_123456785&#x3D;&#x3D; user@their-computer&quot; \ –authorized_users &quot;myUser&quot; \ –authorized_users &quot;secondaryUser&quot; \ –metadata.user_data &quot;I2Nsb3VkLWNvbmZpZw&#x3D;&#x3D;&quot; \ –firewall_id 9000 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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_linode_instance_request (PostLinodeInstanceRequest) —

    The requested initial state of a new Linode.

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

    the optional parameters

Returns:

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

    Linode1 data, response status code and response headers



3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3155

def post_linode_instance_with_http_info(api_version, post_linode_instance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_linode_instance ...'
  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 LinodeInstancesApi.post_linode_instance"
  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_linode_instance_request' is set
  if @api_client.config.client_side_validation && post_linode_instance_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_linode_instance_request' when calling LinodeInstancesApi.post_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances'.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_linode_instance_request)

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

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

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

#post_migrate_linode_instance(api_version, linode_id, opts = {}) ⇒ Object

Initiate a DC migration/pending host migration Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, if any, can be accessed from [List notifications](techdocs.akamai.com/linode-api/reference/get-notifications). When the migration begins, your Linode will be shutdown if not already off. If the migration initiated the shutdown, it will reboot the Linode when completed. To initiate a cross DC migration, you must pass a ‘region` parameter to the request body specifying the target data center region. You can view a list of all available regions and their feature capabilities from [List regions](techdocs.akamai.com/linode-api/reference/get-regions). See our [Pricing Page](www.linode.com/pricing/) for Region-specific pricing, which applies after migration is complete. If your Linode has a DC migration already queued or you have initiated a previously scheduled migration, you will not be able to initiate a DC migration until it has completed. `vpc` details - Cross DC migrations are not allowed for Linodes that have a `vpc` purpose Configuration Profile Interface. Host migrations within the same DC are permitted. - See the [VPC documentation](www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. `vlan` details - Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support. - Next Generation Network (NGN) data centers do not support IPv6 `/116` pools or IP Failover. If you have these features enabled on your Linode and attempt to migrate to an NGN data center, the migration will not initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support. - See the [VLANs Overview](www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations. <<LB>> — - __CLI__. “` linode-cli linodes migrate 123 \ –region us-central \ –placement_group.id 528 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to migrate.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


3224
3225
3226
3227
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3224

def post_migrate_linode_instance(api_version, linode_id, opts = {})
  data, _status_code, _headers = post_migrate_linode_instance_with_http_info(api_version, linode_id, opts)
  data
end

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

Initiate a DC migration/pending host migration Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, if any, can be accessed from [List notifications](techdocs.akamai.com/linode-api/reference/get-notifications). When the migration begins, your Linode will be shutdown if not already off. If the migration initiated the shutdown, it will reboot the Linode when completed. To initiate a cross DC migration, you must pass a &#x60;region&#x60; parameter to the request body specifying the target data center region. You can view a list of all available regions and their feature capabilities from [List regions](techdocs.akamai.com/linode-api/reference/get-regions). See our [Pricing Page](www.linode.com/pricing/) for Region-specific pricing, which applies after migration is complete. If your Linode has a DC migration already queued or you have initiated a previously scheduled migration, you will not be able to initiate a DC migration until it has completed. &#x60;vpc&#x60; details - Cross DC migrations are not allowed for Linodes that have a &#x60;vpc&#x60; purpose Configuration Profile Interface. Host migrations within the same DC are permitted. - See the [VPC documentation](www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. &#x60;vlan&#x60; details - Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support. - Next Generation Network (NGN) data centers do not support IPv6 &#x60;/116&#x60; pools or IP Failover. If you have these features enabled on your Linode and attempt to migrate to an NGN data center, the migration will not initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support. - See the [VLANs Overview](www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes migrate 123 \ –region us-central \ –placement_group.id 528 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to migrate.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3236

def post_migrate_linode_instance_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_migrate_linode_instance ...'
  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 LinodeInstancesApi.post_migrate_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_migrate_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/migrate'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_migrate_linode_instance_request'])

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

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

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

#post_mutate_linode_instance(api_version, linode_id, opts = {}) ⇒ Object

Upgrade a Linode Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation. A mutating Linode will be allocated any new resources the upgraded Type provides, and will be subsequently restarted if it was currently running. If any actions are currently running or queued, those actions must be completed first before you can initiate a mutate. <<LB>> — - __CLI__. “‘ linode-cli linodes upgrade 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to mutate.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


3305
3306
3307
3308
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3305

def post_mutate_linode_instance(api_version, linode_id, opts = {})
  data, _status_code, _headers = post_mutate_linode_instance_with_http_info(api_version, linode_id, opts)
  data
end

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

Upgrade a Linode Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation. A mutating Linode will be allocated any new resources the upgraded Type provides, and will be subsequently restarted if it was currently running. If any actions are currently running or queued, those actions must be completed first before you can initiate a mutate. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes upgrade 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to mutate.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3317

def post_mutate_linode_instance_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_mutate_linode_instance ...'
  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 LinodeInstancesApi.post_mutate_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_mutate_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/mutate'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_mutate_linode_instance_request'])

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

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

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

#post_reboot_linode_instance(api_version, linode_id, opts = {}) ⇒ Object

Reboot a Linode Reboots a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a reboot. <<LB>> — - __CLI__. “‘ linode-cli linodes reboot 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the linode to reboot.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


3386
3387
3388
3389
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3386

def post_reboot_linode_instance(api_version, linode_id, opts = {})
  data, _status_code, _headers = post_reboot_linode_instance_with_http_info(api_version, linode_id, opts)
  data
end

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

Reboot a Linode Reboots a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a reboot. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes reboot 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the linode to reboot.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3398

def post_reboot_linode_instance_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_reboot_linode_instance ...'
  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 LinodeInstancesApi.post_reboot_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_reboot_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/reboot'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_reboot_linode_instance_request'])

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

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

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

#post_rebuild_linode_instance(api_version, linode_id, post_rebuild_linode_instance_request, opts = {}) ⇒ Linode7

Rebuild a Linode Rebuilds a Linode you have the ‘read_write` permission to modify. A rebuild will first shut down the Linode, delete all disks and configs on the Linode, and then deploy a new `image` to the Linode with the given attributes. Additionally: - Requires an `image` be supplied. - Requires a `root_pass` be supplied to use for the root User’s Account. - It is recommended to supply SSH keys for the root User using the ‘authorized_keys` field. - Linodes utilizing Metadata (`"has_user_data": true`) should include `metadata.user_data` in the rebuild request to continue using the service. During a rebuild, you can `enable` or `disable` local disk encryption. If disk encryption is not included in the request, the previous `disk_encryption` value is used. Disk encryption cannot be disabled if the compute instance is attached to a LKE nodepool. You also have the option to resize the Linode to a different plan by including the `type` parameter with your request. Note that resizing involves migrating the Linode to a new hardware host, while rebuilding without resizing maintains the same hardware host. Resizing also requires significantly more time for completion of this operation. The following additional conditions apply: - The Linode must not have a pending migration. - Your Account cannot have an outstanding balance. - The Linode must not have more disk allocation than the new Type allows. - In that situation, you must first delete or resize the disk to be smaller. <<LB>> — - __CLI__. “` linode-cli linodes rebuild 123 \ –image "linode/debian9" \ –root_pass aComplex@Password \ –disk_encryption disabled \ –authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \ –authorized_users "myUsername" \ –authorized_users "secondaryUsername" \ –booted true \ –stackscript_id 10079 \ –stackscript_data ’"linode"‘ \ –type "g6-standard-2" \ –metadata.userdata "I2Nsb3VkLWNvbmZpZw==" “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to rebuild.

  • post_rebuild_linode_instance_request (PostRebuildLinodeInstanceRequest) —

    The requested state your Linode will be rebuilt into.

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

    the optional parameters

Returns:



3467
3468
3469
3470
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3467

def post_rebuild_linode_instance(api_version, linode_id, post_rebuild_linode_instance_request, opts = {})
  data, _status_code, _headers = post_rebuild_linode_instance_with_http_info(api_version, linode_id, post_rebuild_linode_instance_request, opts)
  data
end

#post_rebuild_linode_instance_with_http_info(api_version, linode_id, post_rebuild_linode_instance_request, opts = {}) ⇒ Array<(Linode7, Integer, Hash)>

Rebuild a Linode Rebuilds a Linode you have the &#x60;read_write&#x60; permission to modify. A rebuild will first shut down the Linode, delete all disks and configs on the Linode, and then deploy a new &#x60;image&#x60; to the Linode with the given attributes. Additionally: - Requires an &#x60;image&#x60; be supplied. - Requires a &#x60;root_pass&#x60; be supplied to use for the root User&#39;s Account. - It is recommended to supply SSH keys for the root User using the &#x60;authorized_keys&#x60; field. - Linodes utilizing Metadata (&#x60;&quot;has_user_data&quot;: true&#x60;) should include &#x60;metadata.user_data&#x60; in the rebuild request to continue using the service. During a rebuild, you can &#x60;enable&#x60; or &#x60;disable&#x60; local disk encryption. If disk encryption is not included in the request, the previous &#x60;disk_encryption&#x60; value is used. Disk encryption cannot be disabled if the compute instance is attached to a LKE nodepool. You also have the option to resize the Linode to a different plan by including the &#x60;type&#x60; parameter with your request. Note that resizing involves migrating the Linode to a new hardware host, while rebuilding without resizing maintains the same hardware host. Resizing also requires significantly more time for completion of this operation. The following additional conditions apply: - The Linode must not have a pending migration. - Your Account cannot have an outstanding balance. - The Linode must not have more disk allocation than the new Type allows. - In that situation, you must first delete or resize the disk to be smaller. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes rebuild 123 \ –image &quot;linode/debian9&quot; \ –root_pass aComplex@Password \ –disk_encryption disabled \ –authorized_keys &quot;ssh-rsa AAAA_valid_public_ssh_key_123456785&#x3D;&#x3D; user@their-computer&quot; \ –authorized_users &quot;myUsername&quot; \ –authorized_users &quot;secondaryUsername&quot; \ –booted true \ –stackscript_id 10079 \ –stackscript_data &#39;&quot;linode&quot;&#39; \ –type &quot;g6-standard-2&quot; \ –metadata.userdata &quot;I2Nsb3VkLWNvbmZpZw&#x3D;&#x3D;&quot; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to rebuild.

  • post_rebuild_linode_instance_request (PostRebuildLinodeInstanceRequest) —

    The requested state your Linode will be rebuilt into.

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

    the optional parameters

Returns:

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

    Linode7 data, response status code and response headers



3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3479

def post_rebuild_linode_instance_with_http_info(api_version, linode_id, post_rebuild_linode_instance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_rebuild_linode_instance ...'
  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 LinodeInstancesApi.post_rebuild_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_rebuild_linode_instance"
  end
  # verify the required parameter 'post_rebuild_linode_instance_request' is set
  if @api_client.config.client_side_validation && post_rebuild_linode_instance_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_rebuild_linode_instance_request' when calling LinodeInstancesApi.post_rebuild_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/rebuild'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_linode_instance_request)

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

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

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

#post_rescue_linode_instance(api_version, linode_id, opts = {}) ⇒ Object

Boot a Linode into rescue mode Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution. You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems, copying data between disks, and downloading files from a disk via SSH and SFTP. - Note that ‘sdh` is reserved and unavailable during rescue. <<LB>> — - __CLI__. “` linode-cli linodes rescue 123 \ –devices.sda.disk_id 124458 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to rescue.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


3552
3553
3554
3555
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3552

def post_rescue_linode_instance(api_version, linode_id, opts = {})
  data, _status_code, _headers = post_rescue_linode_instance_with_http_info(api_version, linode_id, opts)
  data
end

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

Boot a Linode into rescue mode Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution. You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems, copying data between disks, and downloading files from a disk via SSH and SFTP. - Note that &#x60;sdh&#x60; is reserved and unavailable during rescue. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes rescue 123 \ –devices.sda.disk_id 124458 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to rescue.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3564

def post_rescue_linode_instance_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_rescue_linode_instance ...'
  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 LinodeInstancesApi.post_rescue_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_rescue_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/rescue'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_rescue_linode_instance_request'])

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

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

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

#post_reset_disk_password(api_version, linode_id, disk_id, post_reset_disk_password_request, opts = {}) ⇒ Object

Reset a disk root password Resets the password of a Disk you have permission to ‘read_write`. <<LB>> — - __CLI__. “` linode-cli linodes disk-reset-password \ 123 25674 \ –password aComplex@Password “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

  • post_reset_disk_password_request (PostResetDiskPasswordRequest) —

    The new password.

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

    the optional parameters

Returns:

  • (Object) 


3634
3635
3636
3637
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3634

def post_reset_disk_password(api_version, linode_id, disk_id, post_reset_disk_password_request, opts = {})
  data, _status_code, _headers = post_reset_disk_password_with_http_info(api_version, linode_id, disk_id, post_reset_disk_password_request, opts)
  data
end

#post_reset_disk_password_with_http_info(api_version, linode_id, disk_id, post_reset_disk_password_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Reset a disk root password Resets the password of a Disk you have permission to &#x60;read_write&#x60;. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes disk-reset-password \ 123 25674 \ –password aComplex@Password &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

  • post_reset_disk_password_request (PostResetDiskPasswordRequest) —

    The new password.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3647

def post_reset_disk_password_with_http_info(api_version, linode_id, disk_id, post_reset_disk_password_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_reset_disk_password ...'
  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 LinodeInstancesApi.post_reset_disk_password"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_reset_disk_password"
  end
  # verify the required parameter 'disk_id' is set
  if @api_client.config.client_side_validation && disk_id.nil?
    fail ArgumentError, "Missing the required parameter 'disk_id' when calling LinodeInstancesApi.post_reset_disk_password"
  end
  # verify the required parameter 'post_reset_disk_password_request' is set
  if @api_client.config.client_side_validation && post_reset_disk_password_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_reset_disk_password_request' when calling LinodeInstancesApi.post_reset_disk_password"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/disks/{diskId}/password'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'diskId' + '}', CGI.escape(disk_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_reset_disk_password_request)

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

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

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

#post_reset_linode_password(api_version, linode_id, opts = {}) ⇒ Object

Reset a Linode’s root password Resets the root password for this Linode. - Your Linode must be [shut down](techdocs.akamai.com/linode-api/reference/post-shutdown-linode-instance) for a password reset to complete. - If your Linode has more than one disk (not counting its swap disk), run the [Reset a disk root password](techdocs.akamai.com/linode-api/reference/post-reset-disk-password) operation to update a specific disk’s root password. - A ‘password_reset` event is generated when a root password reset is successful. <<LB>> — - __CLI__. “` linode-cli linodes linode-reset-password 123 a$eCure4assw0rd!43v51 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode for which to reset its root password.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


3724
3725
3726
3727
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3724

def post_reset_linode_password(api_version, linode_id, opts = {})
  data, _status_code, _headers = post_reset_linode_password_with_http_info(api_version, linode_id, opts)
  data
end

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

Reset a Linode&#39;s root password Resets the root password for this Linode. - Your Linode must be [shut down](techdocs.akamai.com/linode-api/reference/post-shutdown-linode-instance) for a password reset to complete. - If your Linode has more than one disk (not counting its swap disk), run the [Reset a disk root password](techdocs.akamai.com/linode-api/reference/post-reset-disk-password) operation to update a specific disk&#39;s root password. - A &#x60;password_reset&#x60; event is generated when a root password reset is successful. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes linode-reset-password 123 a$eCure4assw0rd!43v51 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode for which to reset its root password.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3736

def post_reset_linode_password_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_reset_linode_password ...'
  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 LinodeInstancesApi.post_reset_linode_password"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_reset_linode_password"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/password'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_reset_linode_password_request'])

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

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

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

#post_resize_disk(api_version, linode_id, disk_id, post_resize_disk_request, opts = {}) ⇒ Object

Resize a disk Resizes a Disk you have permission to ‘read_write`. The Disk must not be in use. If the Disk is in use, the request will succeed but the resize will ultimately fail. For a request to succeed, the Linode must be shut down prior to resizing the Disk, or the Disk must not be assigned to the Linode’s active Configuration Profile. If you are resizing the Disk to a smaller size, it cannot be made smaller than what is required by the total size of the files current on the Disk. <<LB>> — - __CLI__. “‘ linode-cli linodes disk-resize 123 25674 \ –size 2048 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

  • post_resize_disk_request (PostResizeDiskRequest) —

    The new size of the Disk.

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

    the optional parameters

Returns:

  • (Object) 


3806
3807
3808
3809
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3806

def post_resize_disk(api_version, linode_id, disk_id, post_resize_disk_request, opts = {})
  data, _status_code, _headers = post_resize_disk_with_http_info(api_version, linode_id, disk_id, post_resize_disk_request, opts)
  data
end

#post_resize_disk_with_http_info(api_version, linode_id, disk_id, post_resize_disk_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Resize a disk Resizes a Disk you have permission to &#x60;read_write&#x60;. The Disk must not be in use. If the Disk is in use, the request will succeed but the resize will ultimately fail. For a request to succeed, the Linode must be shut down prior to resizing the Disk, or the Disk must not be assigned to the Linode&#39;s active Configuration Profile. If you are resizing the Disk to a smaller size, it cannot be made smaller than what is required by the total size of the files current on the Disk. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes disk-resize 123 25674 \ –size 2048 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

  • post_resize_disk_request (PostResizeDiskRequest) —

    The new size of the Disk.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3819

def post_resize_disk_with_http_info(api_version, linode_id, disk_id, post_resize_disk_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_resize_disk ...'
  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 LinodeInstancesApi.post_resize_disk"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_resize_disk"
  end
  # verify the required parameter 'disk_id' is set
  if @api_client.config.client_side_validation && disk_id.nil?
    fail ArgumentError, "Missing the required parameter 'disk_id' when calling LinodeInstancesApi.post_resize_disk"
  end
  # verify the required parameter 'post_resize_disk_request' is set
  if @api_client.config.client_side_validation && post_resize_disk_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_resize_disk_request' when calling LinodeInstancesApi.post_resize_disk"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/disks/{diskId}/resize'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'diskId' + '}', CGI.escape(disk_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_resize_disk_request)

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

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

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

#post_resize_linode_instance(api_version, linode_id, post_resize_linode_instance_request, opts = {}) ⇒ Object

Resize a Linode Resizes a Linode you have the ‘read_write` permission to a different Type. If any actions are currently running or queued, those actions must be completed first before you can initiate a resize. Additionally, the following criteria must be met in order to resize a Linode: - The Linode must not have a pending migration. - Your Account cannot have an outstanding balance. - The Linode must not have more disk allocation than the new Type allows. - In that situation, you must first delete or resize the disk to be smaller. You can also resize a Linode when using the [Rebuild a Linode](techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) operation. <<LB>> — - __CLI__. “` linode-cli linodes resize 123 \ –type g6-standard-2 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to resize.

  • post_resize_linode_instance_request (PostResizeLinodeInstanceRequest) —

    The Type your current Linode will resize to, and whether to attempt to automatically resize the Linode&#39;s disks.

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

    the optional parameters

Returns:

  • (Object) 


3896
3897
3898
3899
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3896

def post_resize_linode_instance(api_version, linode_id, post_resize_linode_instance_request, opts = {})
  data, _status_code, _headers = post_resize_linode_instance_with_http_info(api_version, linode_id, post_resize_linode_instance_request, opts)
  data
end

#post_resize_linode_instance_with_http_info(api_version, linode_id, post_resize_linode_instance_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Resize a Linode Resizes a Linode you have the &#x60;read_write&#x60; permission to a different Type. If any actions are currently running or queued, those actions must be completed first before you can initiate a resize. Additionally, the following criteria must be met in order to resize a Linode: - The Linode must not have a pending migration. - Your Account cannot have an outstanding balance. - The Linode must not have more disk allocation than the new Type allows. - In that situation, you must first delete or resize the disk to be smaller. You can also resize a Linode when using the [Rebuild a Linode](techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes resize 123 \ –type g6-standard-2 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to resize.

  • post_resize_linode_instance_request (PostResizeLinodeInstanceRequest) —

    The Type your current Linode will resize to, and whether to attempt to automatically resize the Linode&#39;s disks.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3908

def post_resize_linode_instance_with_http_info(api_version, linode_id, post_resize_linode_instance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_resize_linode_instance ...'
  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 LinodeInstancesApi.post_resize_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_resize_linode_instance"
  end
  # verify the required parameter 'post_resize_linode_instance_request' is set
  if @api_client.config.client_side_validation && post_resize_linode_instance_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_resize_linode_instance_request' when calling LinodeInstancesApi.post_resize_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/resize'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_resize_linode_instance_request)

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

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

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

#post_restore_backup(api_version, linode_id, backup_id, post_restore_backup_request, opts = {}) ⇒ Object

Restore a backup Restores a Linode’s Backup to the specified Linode. The following conditions apply: - Backups may not be restored across Regions. - Only successfully completed Backups that are not undergoing maintenance can be restored. - The Linode that the Backup is being restored to must not itself be in the process of creating a Backup. __Note__. When you restore a backup, the restored disk is assigned the same [UUID](en.wikipedia.org/wiki/Universally_unique_identifier) as the original disk. In most cases, this is acceptable and does not cause issues. However, if you attempt to mount both the original disk and the corresponding restore disk at the same time (by assigning them both to devices in your Configuration Profile’s __Block Device Assignment__), you will encounter a UUID "collision". When this happens, the system selects, and mounts, only one of the disks at random. This is due to both disks sharing the same UUID, and your instance _may fail to boot_ since it will not be clear which disk is root. If your system does boot, you will not see any immediate indication if you are booted into the restored disk or the original disk, and you will be unable to access both disks at the same time. To avoid this, we recommend only restoring a backup to the same Compute Instance if you do not intend on mounting them at the same time or are comfortable modifying UUIDs. If you need access to files on both the original disk and the restored disk simultaneously (such as needing to copy files between them), we suggest either restoring the backup to a separate Compute Instance or [creating](techdocs.akamai.com/linode-api/reference/post-linode-instance) a new Compute Instance with the desired ‘backup_id`. To learn more about block device assignments and viewing your disks’ UUIDs, see our guide on [Configuration Profiles](www.linode.com/docs/products/compute/compute-instances/guides/configuration-profiles/#block-device-assignment). __Note__. Backups are not encrypted even when they are taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again. <<LB>> — - __CLI__. “‘ linode-cli linodes backup-restore 123 123456 \ –linode_id 234 \ –overwrite true “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode that the Backup belongs to.

  • backup_id (Integer) —

    The ID of the Backup to restore.

  • post_restore_backup_request (PostRestoreBackupRequest) —

    Parameters to provide when restoring the Backup.

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

    the optional parameters

Returns:

  • (Object) 


3982
3983
3984
3985
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3982

def post_restore_backup(api_version, linode_id, backup_id, post_restore_backup_request, opts = {})
  data, _status_code, _headers = post_restore_backup_with_http_info(api_version, linode_id, backup_id, post_restore_backup_request, opts)
  data
end

#post_restore_backup_with_http_info(api_version, linode_id, backup_id, post_restore_backup_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Restore a backup Restores a Linode&#39;s Backup to the specified Linode. The following conditions apply: - Backups may not be restored across Regions. - Only successfully completed Backups that are not undergoing maintenance can be restored. - The Linode that the Backup is being restored to must not itself be in the process of creating a Backup. __Note__. When you restore a backup, the restored disk is assigned the same [UUID](en.wikipedia.org/wiki/Universally_unique_identifier) as the original disk. In most cases, this is acceptable and does not cause issues. However, if you attempt to mount both the original disk and the corresponding restore disk at the same time (by assigning them both to devices in your Configuration Profile&#39;s __Block Device Assignment__), you will encounter a UUID &quot;collision&quot;. When this happens, the system selects, and mounts, only one of the disks at random. This is due to both disks sharing the same UUID, and your instance _may fail to boot_ since it will not be clear which disk is root. If your system does boot, you will not see any immediate indication if you are booted into the restored disk or the original disk, and you will be unable to access both disks at the same time. To avoid this, we recommend only restoring a backup to the same Compute Instance if you do not intend on mounting them at the same time or are comfortable modifying UUIDs. If you need access to files on both the original disk and the restored disk simultaneously (such as needing to copy files between them), we suggest either restoring the backup to a separate Compute Instance or [creating](techdocs.akamai.com/linode-api/reference/post-linode-instance) a new Compute Instance with the desired &#x60;backup_id&#x60;. To learn more about block device assignments and viewing your disks&#39; UUIDs, see our guide on [Configuration Profiles](www.linode.com/docs/products/compute/compute-instances/guides/configuration-profiles/#block-device-assignment). __Note__. Backups are not encrypted even when they are taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes backup-restore 123 123456 \ –linode_id 234 \ –overwrite true &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode that the Backup belongs to.

  • backup_id (Integer) —

    The ID of the Backup to restore.

  • post_restore_backup_request (PostRestoreBackupRequest) —

    Parameters to provide when restoring the Backup.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 3995

def post_restore_backup_with_http_info(api_version, linode_id, backup_id, post_restore_backup_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_restore_backup ...'
  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 LinodeInstancesApi.post_restore_backup"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_restore_backup"
  end
  # verify the required parameter 'backup_id' is set
  if @api_client.config.client_side_validation && backup_id.nil?
    fail ArgumentError, "Missing the required parameter 'backup_id' when calling LinodeInstancesApi.post_restore_backup"
  end
  # verify the required parameter 'post_restore_backup_request' is set
  if @api_client.config.client_side_validation && post_restore_backup_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_restore_backup_request' when calling LinodeInstancesApi.post_restore_backup"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/backups/{backupId}/restore'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'backupId' + '}', CGI.escape(backup_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_restore_backup_request)

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

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

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

#post_shutdown_linode_instance(api_version, linode_id, opts = {}) ⇒ Object

Shut down a Linode Shuts down a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a shutdown. <<LB>> — - __CLI__. “‘ linode-cli linodes shutdown 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to shutdown.

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

    the optional parameters

Returns:

  • (Object) 


4071
4072
4073
4074
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4071

def post_shutdown_linode_instance(api_version, linode_id, opts = {})
  data, _status_code, _headers = post_shutdown_linode_instance_with_http_info(api_version, linode_id, opts)
  data
end

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

Shut down a Linode Shuts down a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a shutdown. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes shutdown 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to shutdown.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4082

def post_shutdown_linode_instance_with_http_info(api_version, linode_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_shutdown_linode_instance ...'
  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 LinodeInstancesApi.post_shutdown_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_shutdown_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/shutdown'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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 => :"LinodeInstancesApi.post_shutdown_linode_instance",
    :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: LinodeInstancesApi#post_shutdown_linode_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_snapshot(api_version, linode_id, post_snapshot_request, opts = {}) ⇒ PostSnapshot200Response

Create a snapshot Creates a snapshot backup of a Linode. __Note__. Backups are not encrypted even when they are taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again. __Important__. If you already have a snapshot of this Linode, this is a destructive action. The previous snapshot will be deleted. <<LB>> — - __CLI__. “‘ linode-cli linodes snapshot 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode the backups belong to.

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

    the optional parameters

Returns:



4146
4147
4148
4149
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4146

def post_snapshot(api_version, linode_id, post_snapshot_request, opts = {})
  data, _status_code, _headers = post_snapshot_with_http_info(api_version, linode_id, post_snapshot_request, opts)
  data
end

#post_snapshot_with_http_info(api_version, linode_id, post_snapshot_request, opts = {}) ⇒ Array<(PostSnapshot200Response, Integer, Hash)>

Create a snapshot Creates a snapshot backup of a Linode. __Note__. Backups are not encrypted even when they are taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again. __Important__. If you already have a snapshot of this Linode, this is a destructive action. The previous snapshot will be deleted. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes snapshot 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode the backups belong to.

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

    the optional parameters

Returns:

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

    PostSnapshot200Response data, response status code and response headers



4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4158

def post_snapshot_with_http_info(api_version, linode_id, post_snapshot_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.post_snapshot ...'
  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 LinodeInstancesApi.post_snapshot"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.post_snapshot"
  end
  # verify the required parameter 'post_snapshot_request' is set
  if @api_client.config.client_side_validation && post_snapshot_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_snapshot_request' when calling LinodeInstancesApi.post_snapshot"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/backups'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_snapshot_request)

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

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

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

#put_disk(api_version, linode_id, disk_id, put_disk_request, opts = {}) ⇒ PutDisk200Response

Update a disk Updates a Disk that you have permission to ‘read_write`. <<LB>> — - __CLI__. “` linode-cli linodes disk-update 123 25674 \ –label "Debian 9 Disk" “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

  • put_disk_request (PutDiskRequest) —

    Updates the parameters of a single Disk.

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

    the optional parameters

Returns:



4232
4233
4234
4235
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4232

def put_disk(api_version, linode_id, disk_id, put_disk_request, opts = {})
  data, _status_code, _headers = put_disk_with_http_info(api_version, linode_id, disk_id, put_disk_request, opts)
  data
end

#put_disk_with_http_info(api_version, linode_id, disk_id, put_disk_request, opts = {}) ⇒ Array<(PutDisk200Response, Integer, Hash)>

Update a disk Updates a Disk that you have permission to &#x60;read_write&#x60;. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes disk-update 123 25674 \ –label &quot;Debian 9 Disk&quot; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • disk_id (Integer) —

    ID of the Disk to look up.

  • put_disk_request (PutDiskRequest) —

    Updates the parameters of a single Disk.

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

    the optional parameters

Returns:

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

    PutDisk200Response data, response status code and response headers



4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4245

def put_disk_with_http_info(api_version, linode_id, disk_id, put_disk_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.put_disk ...'
  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 LinodeInstancesApi.put_disk"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.put_disk"
  end
  # verify the required parameter 'disk_id' is set
  if @api_client.config.client_side_validation && disk_id.nil?
    fail ArgumentError, "Missing the required parameter 'disk_id' when calling LinodeInstancesApi.put_disk"
  end
  # verify the required parameter 'put_disk_request' is set
  if @api_client.config.client_side_validation && put_disk_request.nil?
    fail ArgumentError, "Missing the required parameter 'put_disk_request' when calling LinodeInstancesApi.put_disk"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/disks/{diskId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'diskId' + '}', CGI.escape(disk_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_disk_request)

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

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

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

#put_linode_config(api_version, linode_id, config_id, put_linode_config_request, opts = {}) ⇒ PutLinodeConfig200Response

Update a config profile Updates a Configuration profile. <<LB>> — - __CLI__. “‘ linode-cli linodes config-update 123 23456 \ –kernel "linode/latest-64bit" \ –comments "This is my main Config" \ –memory_limit 2048 \ –run_level default \ –virt_mode paravirt \ –helpers.updatedb_disabled true \ –helpers.distro true \ –helpers.modules_dep true \ –helpers.network true \ –helpers.devtmpfs_automount false \ –label "My Config" \ –devices.sda.disk_id 123456 \ –devices.sdb.disk_id 123457 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • put_linode_config_request (PutLinodeConfigRequest) —

    The Configuration profile parameters to modify.

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

    the optional parameters

Returns:



4323
4324
4325
4326
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4323

def put_linode_config(api_version, linode_id, config_id, put_linode_config_request, opts = {})
  data, _status_code, _headers = put_linode_config_with_http_info(api_version, linode_id, config_id, put_linode_config_request, opts)
  data
end

#put_linode_config_interface(api_version, linode_id, config_id, interface_id, put_linode_config_interface_request, opts = {}) ⇒ PutLinodeConfigInterface200Response

Update a configuration profile interface Updates a ‘vpc` or `public` purpose Interface for this Configuration Profile. - The User accessing this operation must have `read_write` grants to the Linode. - A successful request triggers a `linode_config_update` event. - The Interface `purpose` cannot be updated with this operation. - VPC Subnets cannot be updated on an Interface. A new `vpc` purpose Interface must be created to assign a different Subnet to a Configuration Profile. - Only `primary` can be updated for `public` purpose Interfaces. - This operation not currently allowed for `vlan` purpose Interfaces. <<LB>> — - __CLI__. “` linode-cli linodes config-interface-update $linodeId $configId $interfaceId \ –primary true \ –ipv4.vpc "10.0.1.2" \ –ipv4.nat_1_1 "203.0.113.2" “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • interface_id (Integer) —

    The &#x60;id&#x60; of the Linode Configuration Profile Interface.

  • put_linode_config_interface_request (PutLinodeConfigInterfaceRequest) —

    The updated Interface.

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

    the optional parameters

Returns:



4415
4416
4417
4418
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4415

def put_linode_config_interface(api_version, linode_id, config_id, interface_id, put_linode_config_interface_request, opts = {})
  data, _status_code, _headers = put_linode_config_interface_with_http_info(api_version, linode_id, config_id, interface_id, put_linode_config_interface_request, opts)
  data
end

#put_linode_config_interface_with_http_info(api_version, linode_id, config_id, interface_id, put_linode_config_interface_request, opts = {}) ⇒ Array<(PutLinodeConfigInterface200Response, Integer, Hash)>

Update a configuration profile interface Updates a &#x60;vpc&#x60; or &#x60;public&#x60; purpose Interface for this Configuration Profile. - The User accessing this operation must have &#x60;read_write&#x60; grants to the Linode. - A successful request triggers a &#x60;linode_config_update&#x60; event. - The Interface &#x60;purpose&#x60; cannot be updated with this operation. - VPC Subnets cannot be updated on an Interface. A new &#x60;vpc&#x60; purpose Interface must be created to assign a different Subnet to a Configuration Profile. - Only &#x60;primary&#x60; can be updated for &#x60;public&#x60; purpose Interfaces. - This operation not currently allowed for &#x60;vlan&#x60; purpose Interfaces. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-interface-update $linodeId $configId $interfaceId \ –primary true \ –ipv4.vpc &quot;10.0.1.2&quot; \ –ipv4.nat_1_1 &quot;203.0.113.2&quot; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • interface_id (Integer) —

    The &#x60;id&#x60; of the Linode Configuration Profile Interface.

  • put_linode_config_interface_request (PutLinodeConfigInterfaceRequest) —

    The updated Interface.

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

    the optional parameters

Returns:



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4429

def put_linode_config_interface_with_http_info(api_version, linode_id, config_id, interface_id, put_linode_config_interface_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.put_linode_config_interface ...'
  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 LinodeInstancesApi.put_linode_config_interface"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.put_linode_config_interface"
  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 LinodeInstancesApi.put_linode_config_interface"
  end
  # verify the required parameter 'interface_id' is set
  if @api_client.config.client_side_validation && interface_id.nil?
    fail ArgumentError, "Missing the required parameter 'interface_id' when calling LinodeInstancesApi.put_linode_config_interface"
  end
  # verify the required parameter 'put_linode_config_interface_request' is set
  if @api_client.config.client_side_validation && put_linode_config_interface_request.nil?
    fail ArgumentError, "Missing the required parameter 'put_linode_config_interface_request' when calling LinodeInstancesApi.put_linode_config_interface"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces/{interfaceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'configId' + '}', CGI.escape(config_id.to_s)).sub('{' + 'interfaceId' + '}', CGI.escape(interface_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_linode_config_interface_request)

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

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

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

#put_linode_config_with_http_info(api_version, linode_id, config_id, put_linode_config_request, opts = {}) ⇒ Array<(PutLinodeConfig200Response, Integer, Hash)>

Update a config profile Updates a Configuration profile. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes config-update 123 23456 \ –kernel &quot;linode/latest-64bit&quot; \ –comments &quot;This is my main Config&quot; \ –memory_limit 2048 \ –run_level default \ –virt_mode paravirt \ –helpers.updatedb_disabled true \ –helpers.distro true \ –helpers.modules_dep true \ –helpers.network true \ –helpers.devtmpfs_automount false \ –label &quot;My Config&quot; \ –devices.sda.disk_id 123456 \ –devices.sdb.disk_id 123457 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The &#x60;id&#x60; of the Linode.

  • config_id (Integer) —

    The &#x60;id&#x60; of the Configuration Profile.

  • put_linode_config_request (PutLinodeConfigRequest) —

    The Configuration profile parameters to modify.

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

    the optional parameters

Returns:

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

    PutLinodeConfig200Response data, response status code and response headers



4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4336

def put_linode_config_with_http_info(api_version, linode_id, config_id, put_linode_config_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.put_linode_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 LinodeInstancesApi.put_linode_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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.put_linode_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 LinodeInstancesApi.put_linode_config"
  end
  # verify the required parameter 'put_linode_config_request' is set
  if @api_client.config.client_side_validation && put_linode_config_request.nil?
    fail ArgumentError, "Missing the required parameter 'put_linode_config_request' when calling LinodeInstancesApi.put_linode_config"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/configs/{configId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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_linode_config_request)

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

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

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

#put_linode_instance(api_version, linode_id, linode5, opts = {}) ⇒ Linode6

Update a Linode Updates a Linode that you have permission to ‘read_write`. __Important__. You must be an unrestricted User in order to add or modify tags on Linodes. <<LB>> — - __CLI__. “` linode-cli linodes update 7833080 \ –label linode123 \ –backups.schedule.day "Saturday" \ –backups.schedule.window "W22" \ –alerts.cpu 180 \ –alerts.network_in 10 \ –alerts.network_out 10 \ –alerts.transfer_quota 80 \ –alerts.io 10000 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • linode5 (Linode5) —

    Any field that is not marked as &#x60;readOnly&#x60; may be updated. Fields that are marked &#x60;readOnly&#x60; will be ignored. If any updated field fails to pass validation, the Linode will not be updated.

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

    the optional parameters

Returns:



4510
4511
4512
4513
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4510

def put_linode_instance(api_version, linode_id, linode5, opts = {})
  data, _status_code, _headers = put_linode_instance_with_http_info(api_version, linode_id, linode5, opts)
  data
end

#put_linode_instance_with_http_info(api_version, linode_id, linode5, opts = {}) ⇒ Array<(Linode6, Integer, Hash)>

Update a Linode Updates a Linode that you have permission to &#x60;read_write&#x60;. __Important__. You must be an unrestricted User in order to add or modify tags on Linodes. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes update 7833080 \ –label linode123 \ –backups.schedule.day &quot;Saturday&quot; \ –backups.schedule.window &quot;W22&quot; \ –alerts.cpu 180 \ –alerts.network_in 10 \ –alerts.network_out 10 \ –alerts.transfer_quota 80 \ –alerts.io 10000 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    ID of the Linode to look up.

  • linode5 (Linode5) —

    Any field that is not marked as &#x60;readOnly&#x60; may be updated. Fields that are marked &#x60;readOnly&#x60; will be ignored. If any updated field fails to pass validation, the Linode will not be updated.

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

    the optional parameters

Returns:

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

    Linode6 data, response status code and response headers



4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4522

def put_linode_instance_with_http_info(api_version, linode_id, linode5, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.put_linode_instance ...'
  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 LinodeInstancesApi.put_linode_instance"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.put_linode_instance"
  end
  # verify the required parameter 'linode5' is set
  if @api_client.config.client_side_validation && linode5.nil?
    fail ArgumentError, "Missing the required parameter 'linode5' when calling LinodeInstancesApi.put_linode_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_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(linode5)

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

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

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

#put_linode_ip(api_version, linode_id, address, opts = {}) ⇒ PutLinodeIp200Response

Update an IP address’s RDNS for a Linode Updates the reverse DNS (RDNS) for a Linode’s IP Address. This may be done for both IPv4 and IPv6 addresses. Setting the RDNS to ‘null` for a public IPv4 address, resets it to the default `ip.linodeusercontent.com` RDNS value. <<LB>> — - __CLI__. “` linode-cli linodes ip-update 123 \ 203.0.113.1 \ –rdns test.example.org “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` linodes: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.

  • linode_id (Integer) —

    The ID of the Linode.

  • address (String) —

    The IP address.

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

    the optional parameters

Options Hash (opts):

  • :put_linode_ip_request (PutLinodeIpRequest) —

    The information to update for the IP address.

Returns:



4596
4597
4598
4599
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4596

def put_linode_ip(api_version, linode_id, address, opts = {})
  data, _status_code, _headers = put_linode_ip_with_http_info(api_version, linode_id, address, opts)
  data
end

#put_linode_ip_with_http_info(api_version, linode_id, address, opts = {}) ⇒ Array<(PutLinodeIp200Response, Integer, Hash)>

Update an IP address&#39;s RDNS for a Linode Updates the reverse DNS (RDNS) for a Linode&#39;s IP Address. This may be done for both IPv4 and IPv6 addresses. Setting the RDNS to &#x60;null&#x60; for a public IPv4 address, resets it to the default &#x60;ip.linodeusercontent.com&#x60; RDNS value. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli linodes ip-update 123 \ 203.0.113.1 \ –rdns test.example.org &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; linodes: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.

  • linode_id (Integer) —

    The ID of the Linode.

  • address (String) —

    The IP address.

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

    the optional parameters

Options Hash (opts):

  • :put_linode_ip_request (PutLinodeIpRequest) —

    The information to update for the IP address.

Returns:

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

    PutLinodeIp200Response data, response status code and response headers



4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
 
# File 'lib/linode_openapi_client/api/linode_instances_api.rb', line 4609

def put_linode_ip_with_http_info(api_version, linode_id, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinodeInstancesApi.put_linode_ip ...'
  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 LinodeInstancesApi.put_linode_ip"
  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 'linode_id' is set
  if @api_client.config.client_side_validation && linode_id.nil?
    fail ArgumentError, "Missing the required parameter 'linode_id' when calling LinodeInstancesApi.put_linode_ip"
  end
  # verify the required parameter 'address' is set
  if @api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling LinodeInstancesApi.put_linode_ip"
  end
  # resource path
  local_var_path = '/{apiVersion}/linode/instances/{linodeId}/ips/{address}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'linodeId' + '}', CGI.escape(linode_id.to_s)).sub('{' + 'address' + '}', CGI.escape(address.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[:'put_linode_ip_request'])

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

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

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