Class: VSphereAutomation::Appliance::ServicesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ServicesApi

Returns a new instance of ServicesApi.



16
17
18
 
# File 'lib/vsphere-automation-appliance/api/services_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-appliance/api/services_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get(service, opts = {}) ⇒ ApplianceServicesResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|

Returns the state of a service.

Parameters:

  • service —

    identifier of the service whose state is being queried.

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

    the optional parameters

Returns:



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

def get(service, opts = {})
  data, _status_code, _headers = get_with_http_info(service, opts)
  data
end

#get_with_http_info(service, opts = {}) ⇒ Array<(ApplianceServicesResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|, 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 the state of a service.

Parameters:

  • service —

    identifier of the service whose state is being queried.

  • 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
69
70
71
72
73
 
# File 'lib/vsphere-automation-appliance/api/services_api.rb', line 33

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Appliance::ApplianceServicesResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	  '404' => 'Appliance::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServicesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ ApplianceServicesListResult|VapiStdErrorsErrorError|

Lists details of vCenter services.

Parameters:

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/vsphere-automation-appliance/api/services_api.rb', line 77

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

#list_with_http_info(opts = {}) ⇒ Array<(ApplianceServicesListResult|VapiStdErrorsErrorError|, 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.

Lists details of vCenter services.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-appliance/api/services_api.rb', line 86

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServicesApi.list ...'
  end
  # resource path
  local_var_path = '/appliance/services'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Appliance::ApplianceServicesListResult',
	  '400' => 'Appliance::VapiStdErrorsErrorError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServicesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#restart(service, opts = {}) ⇒ |VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|VapiStdErrorsTimedOutError|nil

Restarts a service

Parameters:

  • service —

    identifier of the service to restart

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

    the optional parameters

Returns:



126
127
128
129
 
# File 'lib/vsphere-automation-appliance/api/services_api.rb', line 126

def restart(service, opts = {})
  restart_with_http_info(service, opts)
  nil
end

#restart_with_http_info(service, opts = {}) ⇒ Array<(|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|VapiStdErrorsTimedOutError|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.

Restarts a service

Parameters:

  • service —

    identifier of the service to restart

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-appliance/api/services_api.rb', line 136

def restart_with_http_info(service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServicesApi.restart ...'
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling ServicesApi.restart"
  end
  # resource path
  local_var_path = '/appliance/services/{service}/restart'.sub('{' + 'service' + '}', service.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: ServicesApi#restart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#start(service, opts = {}) ⇒ |VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|VapiStdErrorsTimedOutError|nil

Starts a service

Parameters:

  • service —

    identifier of the service to start

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

    the optional parameters

Returns:



176
177
178
179
 
# File 'lib/vsphere-automation-appliance/api/services_api.rb', line 176

def start(service, opts = {})
  start_with_http_info(service, opts)
  nil
end

#start_with_http_info(service, opts = {}) ⇒ Array<(|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|VapiStdErrorsTimedOutError|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.

Starts a service

Parameters:

  • service —

    identifier of the service to start

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

    the optional parameters

Returns:



186
187
188
189
190
191
192
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
 
# File 'lib/vsphere-automation-appliance/api/services_api.rb', line 186

def start_with_http_info(service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServicesApi.start ...'
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling ServicesApi.start"
  end
  # resource path
  local_var_path = '/appliance/services/{service}/start'.sub('{' + 'service' + '}', service.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: ServicesApi#start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stop(service, opts = {}) ⇒ |VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsNotFoundError|nil

Stops a service

Parameters:

  • service —

    identifier of the service to stop

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

    the optional parameters

Returns:



226
227
228
229
 
# File 'lib/vsphere-automation-appliance/api/services_api.rb', line 226

def stop(service, opts = {})
  stop_with_http_info(service, opts)
  nil
end

#stop_with_http_info(service, opts = {}) ⇒ Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsNotFoundError|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.

Stops a service

Parameters:

  • service —

    identifier of the service to stop

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

    the optional parameters

Returns:



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
267
268
269
270
271
 
# File 'lib/vsphere-automation-appliance/api/services_api.rb', line 236

def stop_with_http_info(service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServicesApi.stop ...'
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling ServicesApi.stop"
  end
  # resource path
  local_var_path = '/appliance/services/{service}/stop'.sub('{' + 'service' + '}', service.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: ServicesApi#stop\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end