Class: VSphereAutomation::VCenter::OvfLibraryItemApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OvfLibraryItemApi

Returns a new instance of OvfLibraryItemApi.



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

def api_client
  @api_client
end

Instance Method Details

#create(request_body, opts = {}) ⇒ VcenterOvfLibraryItemCreateResult|VapiStdErrorsResourceBusyError|VapiStdErrorsNotFoundError|

Creates a library item in content library from a virtual machine or virtual appliance. <p> This operation creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this operation, the original content is overwritten. </p>

Parameters:

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

    the optional parameters

Returns:



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

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<(VcenterOvfLibraryItemCreateResult|VapiStdErrorsResourceBusyError|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.

Creates a library item in content library from a virtual machine or virtual appliance. &lt;p&gt; This operation creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this operation, the original content is overwritten. &lt;/p&gt;

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/ovf_library_item_api.rb', line 33

def create_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OvfLibraryItemApi.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 OvfLibraryItemApi.create"
  end
  # resource path
  local_var_path = '/com/vmware/vcenter/ovf/library-item'

  # 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::VcenterOvfLibraryItemCreateResult',
	  '400' => 'VCenter::VapiStdErrorsResourceBusyError',
	  '404' => 'VCenter::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OvfLibraryItemApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#deploy(ovf_library_item_id, request_body, opts = {}) ⇒ VcenterOvfLibraryItemDeployResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|

Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. <p> This operation deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target. </p>

Parameters:

  • ovf_library_item_id —

    Identifier of the content library item containing the OVF package to be deployed.

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/vsphere-automation-vcenter/api/ovf_library_item_api.rb', line 81

def deploy(ovf_library_item_id, request_body, opts = {})
  data, _status_code, _headers = deploy_with_http_info(ovf_library_item_id, request_body, opts)
  data
end

#deploy_with_http_info(ovf_library_item_id, request_body, opts = {}) ⇒ Array<(VcenterOvfLibraryItemDeployResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthorizedError|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.

Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. &lt;p&gt; This operation deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target. &lt;/p&gt;

Parameters:

  • ovf_library_item_id —

    Identifier of the content library item containing the OVF package to be deployed.

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

    the optional parameters

Returns:



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

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

#filter(ovf_library_item_id, request_body, opts = {}) ⇒ VcenterOvfLibraryItemFilterResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsNotFoundError|

Queries an OVF package stored in content library to retrieve information to use when deploying the package. See #deploy. <p> This operation retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the operation can be used to populate the deployment specification (see ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target. </p>

Parameters:

  • ovf_library_item_id —

    Identifier of the content library item containing the OVF package to query.

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/vsphere-automation-vcenter/api/ovf_library_item_api.rb', line 145

def filter(ovf_library_item_id, request_body, opts = {})
  data, _status_code, _headers = filter_with_http_info(ovf_library_item_id, request_body, opts)
  data
end

#filter_with_http_info(ovf_library_item_id, request_body, opts = {}) ⇒ Array<(VcenterOvfLibraryItemFilterResult|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.

Queries an OVF package stored in content library to retrieve information to use when deploying the package. See #deploy. &lt;p&gt; This operation retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the operation can be used to populate the deployment specification (see ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target. &lt;/p&gt;

Parameters:

  • ovf_library_item_id —

    Identifier of the content library item containing the OVF package to query.

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

    the optional parameters

Returns:



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/vsphere-automation-vcenter/api/ovf_library_item_api.rb', line 156

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