Class: VSphereAutomation::VCenter::HostApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ HostApi

Returns a new instance of HostApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#connect(host, opts = {}) ⇒ |VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil

Connect to the host corresponding to host previously added to the vCenter server.

Parameters:

  • host —

    Identifier of the host to be reconnected. The parameter must be an identifier for the resource type: HostSystem.

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

    the optional parameters

Returns:



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

def connect(host, opts = {})
  connect_with_http_info(host, opts)
  nil
end

#connect_with_http_info(host, opts = {}) ⇒ Array<(|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>

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

Connect to the host corresponding to host previously added to the vCenter server.

Parameters:

  • host —

    Identifier of the host to be reconnected. The parameter must be an identifier for the resource type: HostSystem.

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

    the optional parameters

Returns:



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

def connect_with_http_info(host, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HostApi.connect ...'
  end
  # verify the required parameter 'host' is set
  if @api_client.config.client_side_validation && host.nil?
    fail ArgumentError, "Missing the required parameter 'host' when calling HostApi.connect"
  end
  # resource path
  local_var_path = '/vcenter/host/{host}/connect'.sub('{' + 'host' + '}', host.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create(request_body, opts = {}) ⇒ VcenterHostCreateResult|VapiStdErrorsUnsupportedError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|

Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by Host.CreateSpec.ThumbprintVerification.

Parameters:

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

    the optional parameters

Returns:



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

def create(request_body, opts = {})
  data, _status_code, _headers = create_with_http_info(request_body, opts)
  data
end

#create_with_http_info(request_body, opts = {}) ⇒ Array<(VcenterHostCreateResult|VapiStdErrorsUnsupportedError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>

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

Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by Host.CreateSpec.ThumbprintVerification.

Parameters:

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

    the optional parameters

Returns:



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

def create_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HostApi.create ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling HostApi.create"
  end
  # resource path
  local_var_path = '/vcenter/host'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'VCenter::VcenterHostCreateResult',
	  '400' => 'VCenter::VapiStdErrorsUnsupportedError',
	  '401' => 'VCenter::VapiStdErrorsUnauthenticatedError',
	  '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
	  '404' => 'VCenter::VapiStdErrorsNotFoundError',
	  '503' => 'VCenter::VapiStdErrorsServiceUnavailableError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HostApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(host, opts = {}) ⇒ |VapiStdErrorsResourceInUseError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil

Remove a standalone host from the vCenter Server.

Parameters:

  • host —

    Identifier of the host to be deleted. The parameter must be an identifier for the resource type: HostSystem.

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

    the optional parameters

Returns:



133
134
135
136
 
# File 'lib/vsphere-automation-vcenter/api/host_api.rb', line 133

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

#delete_with_http_info(host, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInUseError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>

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

Remove a standalone host from the vCenter Server.

Parameters:

  • host —

    Identifier of the host to be deleted. The parameter must be an identifier for the resource type: HostSystem.

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-vcenter/api/host_api.rb', line 143

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#disconnect(host, opts = {}) ⇒ |VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil

Disconnect the host corresponding to host from the vCenter server

Parameters:

  • host —

    Identifier of the host to be disconnected. The parameter must be an identifier for the resource type: HostSystem.

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

    the optional parameters

Returns:



183
184
185
186
 
# File 'lib/vsphere-automation-vcenter/api/host_api.rb', line 183

def disconnect(host, opts = {})
  disconnect_with_http_info(host, opts)
  nil
end

#disconnect_with_http_info(host, opts = {}) ⇒ Array<(|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>

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

Disconnect the host corresponding to host from the vCenter server

Parameters:

  • host —

    Identifier of the host to be disconnected. The parameter must be an identifier for the resource type: HostSystem.

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

    the optional parameters

Returns:



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

def disconnect_with_http_info(host, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HostApi.disconnect ...'
  end
  # verify the required parameter 'host' is set
  if @api_client.config.client_side_validation && host.nil?
    fail ArgumentError, "Missing the required parameter 'host' when calling HostApi.disconnect"
  end
  # resource path
  local_var_path = '/vcenter/host/{host}/disconnect'.sub('{' + 'host' + '}', host.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#list(opts = {}) ⇒ VcenterHostListResult|VapiStdErrorsUnableToAllocateResourceError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|

Returns information about at most 1000 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_hosts (Array<String>) —

    Identifiers of hosts that can match the filter. If unset or empty, hosts with any identifier match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

  • :filter_names (Array<String>) —

    Names that hosts must have to match the filter (see Host.Summary.name). If unset or empty, hosts with any name match the filter.

  • :filter_folders (Array<String>) —

    Folders that must contain the hosts for the hosts to match the filter. If unset or empty, hosts in any folder match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Folder. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Folder.

  • :filter_datacenters (Array<String>) —

    Datacenters that must contain the hosts for the hosts to match the filter. If unset or empty, hosts in any datacenter match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datacenter. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datacenter.

  • :filter_standalone (Boolean) —

    If true, only hosts that are not part of a cluster can match the filter, and if false, only hosts that are are part of a cluster can match the filter. If unset Hosts can match filter independent of whether they are part of a cluster or not. If this field is true and Host.FilterSpec.clusters os not empty, no hosts will match the filter.

  • :filter_clusters (Array<String>) —

    Clusters that must contain the hosts for the hosts to match the filter. If unset or empty, hosts in any cluster and hosts that are not in a cluster match the filter. If this field is not empty and Host.FilterSpec.standalone is true, no hosts will match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ClusterComputeResource.

  • :filter_connection_states (Array<String>) —

    Connection states that a host must be in to match the filter (see Host.Summary.connection-state. If unset or empty, hosts in any connection state match the filter.

Returns:



239
240
241
242
 
# File 'lib/vsphere-automation-vcenter/api/host_api.rb', line 239

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

#list_with_http_info(opts = {}) ⇒ Array<(VcenterHostListResult|VapiStdErrorsUnableToAllocateResourceError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>

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

Returns information about at most 1000 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_hosts (Array<String>) —

    Identifiers of hosts that can match the filter. If unset or empty, hosts with any identifier match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

  • :filter_names (Array<String>) —

    Names that hosts must have to match the filter (see Host.Summary.name). If unset or empty, hosts with any name match the filter.

  • :filter_folders (Array<String>) —

    Folders that must contain the hosts for the hosts to match the filter. If unset or empty, hosts in any folder match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Folder. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Folder.

  • :filter_datacenters (Array<String>) —

    Datacenters that must contain the hosts for the hosts to match the filter. If unset or empty, hosts in any datacenter match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datacenter. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datacenter.

  • :filter_standalone (Boolean) —

    If true, only hosts that are not part of a cluster can match the filter, and if false, only hosts that are are part of a cluster can match the filter. If unset Hosts can match filter independent of whether they are part of a cluster or not. If this field is true and Host.FilterSpec.clusters os not empty, no hosts will match the filter.

  • :filter_clusters (Array<String>) —

    Clusters that must contain the hosts for the hosts to match the filter. If unset or empty, hosts in any cluster and hosts that are not in a cluster match the filter. If this field is not empty and Host.FilterSpec.standalone is true, no hosts will match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ClusterComputeResource.

  • :filter_connection_states (Array<String>) —

    Connection states that a host must be in to match the filter (see Host.Summary.connection-state. If unset or empty, hosts in any connection state match the filter.

Returns:



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

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HostApi.list ...'
  end
  if @api_client.config.client_side_validation && opts[:'filter_connection_states'] && !opts[:'filter_connection_states'].all? { |item| ['CONNECTED', 'DISCONNECTED', 'NOT_RESPONDING'].include?(item) }
    fail ArgumentError, 'invalid value for "filter_connection_states", must include one of CONNECTED, DISCONNECTED, NOT_RESPONDING'
  end
  # resource path
  local_var_path = '/vcenter/host'

  # query parameters
  query_params = {}
  query_params[:'filter.hosts'] = @api_client.build_collection_param(opts[:'filter_hosts'], :multi) if !opts[:'filter_hosts'].nil?
  query_params[:'filter.names'] = @api_client.build_collection_param(opts[:'filter_names'], :multi) if !opts[:'filter_names'].nil?
  query_params[:'filter.folders'] = @api_client.build_collection_param(opts[:'filter_folders'], :multi) if !opts[:'filter_folders'].nil?
  query_params[:'filter.datacenters'] = @api_client.build_collection_param(opts[:'filter_datacenters'], :multi) if !opts[:'filter_datacenters'].nil?
  query_params[:'filter.standalone'] = opts[:'filter_standalone'] if !opts[:'filter_standalone'].nil?
  query_params[:'filter.clusters'] = @api_client.build_collection_param(opts[:'filter_clusters'], :multi) if !opts[:'filter_clusters'].nil?
  query_params[:'filter.connection_states'] = @api_client.build_collection_param(opts[:'filter_connection_states'], :multi) if !opts[:'filter_connection_states'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'VCenter::VcenterHostListResult',
	  '400' => 'VCenter::VapiStdErrorsUnableToAllocateResourceError',
	  '401' => 'VCenter::VapiStdErrorsUnauthenticatedError',
	  '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
	  '503' => 'VCenter::VapiStdErrorsServiceUnavailableError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HostApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end