Class: VSphereAutomation::VCenter::IsoImageApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IsoImageApi

Returns a new instance of IsoImageApi.



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

def api_client
  @api_client
end

Instance Method Details

#mount(library_item, request_body, opts = {}) ⇒ VcenterIsoImageMountResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsNotFoundError|

Mounts an ISO image from a content library on a virtual machine.

Parameters:

  • library_item —

    The identifier of the library item having the ISO image to mount on the virtual machine.

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

    the optional parameters

Returns:



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

def mount(library_item, request_body, opts = {})
  data, _status_code, _headers = mount_with_http_info(library_item, request_body, opts)
  data
end

#mount_with_http_info(library_item, request_body, opts = {}) ⇒ Array<(VcenterIsoImageMountResult|VapiStdErrorsResourceInaccessibleError|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.

Mounts an ISO image from a content library on a virtual machine.

Parameters:

  • library_item —

    The identifier of the library item having the ISO image to mount on the virtual machine.

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

    the optional parameters

Returns:



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
76
77
78
79
80
81
 
# File 'lib/vsphere-automation-vcenter/api/iso_image_api.rb', line 35

def mount_with_http_info(library_item, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IsoImageApi.mount ...'
  end
  # verify the required parameter 'library_item' is set
  if @api_client.config.client_side_validation && library_item.nil?
    fail ArgumentError, "Missing the required parameter 'library_item' when calling IsoImageApi.mount"
  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 IsoImageApi.mount"
  end
  # resource path
  local_var_path = '/com/vmware/vcenter/iso/image/id:{library_item}?~action=mount'.sub('{' + 'library_item' + '}', library_item.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'])
  # 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::VcenterIsoImageMountResult',
	  '400' => 'VCenter::VapiStdErrorsResourceInaccessibleError',
	  '404' => 'VCenter::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IsoImageApi#mount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unmount(vm, request_body, opts = {}) ⇒ |VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsNotFoundError|nil

Unmounts a previously mounted CD-ROM using an ISO image as a backing.

Parameters:

  • vm —

    The identifier of the virtual machine from which to unmount the virtual CD-ROM.

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

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/vsphere-automation-vcenter/api/iso_image_api.rb', line 87

def unmount(vm, request_body, opts = {})
  unmount_with_http_info(vm, request_body, opts)
  nil
end

#unmount_with_http_info(vm, request_body, 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.

Unmounts a previously mounted CD-ROM using an ISO image as a backing.

Parameters:

  • vm —

    The identifier of the virtual machine from which to unmount the virtual CD-ROM.

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

    the optional parameters

Returns:



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
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/vsphere-automation-vcenter/api/iso_image_api.rb', line 98

def unmount_with_http_info(vm, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IsoImageApi.unmount ...'
  end
  # verify the required parameter 'vm' is set
  if @api_client.config.client_side_validation && vm.nil?
    fail ArgumentError, "Missing the required parameter 'vm' when calling IsoImageApi.unmount"
  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 IsoImageApi.unmount"
  end
  # resource path
  local_var_path = '/com/vmware/vcenter/iso/image/id:{vm}?~action=unmount'.sub('{' + 'vm' + '}', vm.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'])
  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IsoImageApi#unmount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end