Class: VSphereAutomation::VCenter::DeploymentInstallRemotePscApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeploymentInstallRemotePscApi

Returns a new instance of DeploymentInstallRemotePscApi.



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

def api_client
  @api_client
end

Instance Method Details

#check(request_body, opts = {}) ⇒ VcenterDeploymentInstallRemotePscCheckResult|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|

Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC.

Parameters:

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

    the optional parameters

Returns:



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

def check(request_body, opts = {})
  data, _status_code, _headers = check_with_http_info(request_body, opts)
  data
end

#check_with_http_info(request_body, opts = {}) ⇒ Array<(VcenterDeploymentInstallRemotePscCheckResult|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|, 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.

Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC.

Parameters:

  • request_body
  • 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
74
75
 
# File 'lib/vsphere-automation-vcenter/api/deployment_install_remote_psc_api.rb', line 33

def check_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeploymentInstallRemotePscApi.check ...'
  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 DeploymentInstallRemotePscApi.check"
  end
  # resource path
  local_var_path = '/vcenter/deployment/install/remote-psc?action=check'

  # 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::VcenterDeploymentInstallRemotePscCheckResult',
	  '400' => 'VCenter::VapiStdErrorsNotAllowedInCurrentStateError',
	  '401' => 'VCenter::VapiStdErrorsUnauthenticatedError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeploymentInstallRemotePscApi#check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end