Class: VSphereAutomation::VCenter::VMApi
- Inherits:
-
Object
- Object
- VSphereAutomation::VCenter::VMApi
- Defined in:
- lib/vsphere-automation-vcenter/api/vm_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create(request_body, opts = {}) ⇒ VcenterVMCreateResult|VapiStdErrorsUnsupportedError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|
Creates a virtual machine.
-
#create_with_http_info(request_body, opts = {}) ⇒ Array<(VcenterVMCreateResult|VapiStdErrorsUnsupportedError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>
private
Creates a virtual machine.
-
#delete(vm, opts = {}) ⇒ |VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil
Deletes a virtual machine.
-
#delete_with_http_info(vm, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>
private
Deletes a virtual machine.
-
#get(vm, opts = {}) ⇒ VcenterVMResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|
Returns information about a virtual machine.
-
#get_with_http_info(vm, opts = {}) ⇒ Array<(VcenterVMResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>
private
Returns information about a virtual machine.
-
#initialize(api_client = ApiClient.default) ⇒ VMApi
constructor
A new instance of VMApi.
-
#list(opts = {}) ⇒ VcenterVMListResult|VapiStdErrorsUnableToAllocateResourceError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|
Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec.
-
#list_with_http_info(opts = {}) ⇒ Array<(VcenterVMListResult|VapiStdErrorsUnableToAllocateResourceError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>
private
Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
14 15 16 |
# File 'lib/vsphere-automation-vcenter/api/vm_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#create(request_body, opts = {}) ⇒ VcenterVMCreateResult|VapiStdErrorsUnsupportedError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|
Creates a virtual machine.
23 24 25 26 |
# File 'lib/vsphere-automation-vcenter/api/vm_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<(VcenterVMCreateResult|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.
Creates a virtual machine.
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 76 77 78 |
# File 'lib/vsphere-automation-vcenter/api/vm_api.rb', line 33 def create_with_http_info(request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VMApi.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 VMApi.create" end # resource path local_var_path = '/vcenter/vm' # 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::VcenterVMCreateResult', '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: VMApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete(vm, opts = {}) ⇒ |VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil
Deletes a virtual machine.
83 84 85 86 |
# File 'lib/vsphere-automation-vcenter/api/vm_api.rb', line 83 def delete(vm, opts = {}) delete_with_http_info(vm, opts) nil end |
#delete_with_http_info(vm, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInaccessibleError|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.
Deletes a virtual machine.
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/vm_api.rb', line 93 def delete_with_http_info(vm, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VMApi.delete ...' 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 VMApi.delete" end # resource path local_var_path = '/vcenter/vm/{vm}'.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']) # 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: VMApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get(vm, opts = {}) ⇒ VcenterVMResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|
Returns information about a virtual machine.
133 134 135 136 |
# File 'lib/vsphere-automation-vcenter/api/vm_api.rb', line 133 def get(vm, opts = {}) data, _status_code, _headers = get_with_http_info(vm, opts) data end |
#get_with_http_info(vm, opts = {}) ⇒ Array<(VcenterVMResult|VapiStdErrorsResourceInaccessibleError|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.
Returns information about a virtual machine.
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 179 180 181 182 183 184 185 186 |
# File 'lib/vsphere-automation-vcenter/api/vm_api.rb', line 143 def get_with_http_info(vm, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VMApi.get ...' 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 VMApi.get" end # resource path local_var_path = '/vcenter/vm/{vm}'.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']) # 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::VcenterVMResult', '400' => 'VCenter::VapiStdErrorsResourceInaccessibleError', '401' => 'VCenter::VapiStdErrorsUnauthenticatedError', '403' => 'VCenter::VapiStdErrorsUnauthorizedError', '404' => 'VCenter::VapiStdErrorsNotFoundError', '503' => 'VCenter::VapiStdErrorsServiceUnavailableError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: VMApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(opts = {}) ⇒ VcenterVMListResult|VapiStdErrorsUnableToAllocateResourceError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|
Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec.
198 199 200 201 |
# File 'lib/vsphere-automation-vcenter/api/vm_api.rb', line 198 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
#list_with_http_info(opts = {}) ⇒ Array<(VcenterVMListResult|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) virtual machines in vCenter matching the VM.FilterSpec.
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 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 |
# File 'lib/vsphere-automation-vcenter/api/vm_api.rb', line 215 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VMApi.list ...' end if @api_client.config.client_side_validation && opts[:'filter_power_states'] && !opts[:'filter_power_states'].all? { |item| ['POWERED_OFF', 'POWERED_ON', 'SUSPENDED'].include?(item) } fail ArgumentError, 'invalid value for "filter_power_states", must include one of POWERED_OFF, POWERED_ON, SUSPENDED' end # resource path local_var_path = '/vcenter/vm' # query parameters query_params = {} query_params[:'filter.vms'] = @api_client.build_collection_param(opts[:'filter_vms'], :multi) if !opts[:'filter_vms'].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.hosts'] = @api_client.build_collection_param(opts[:'filter_hosts'], :multi) if !opts[:'filter_hosts'].nil? query_params[:'filter.clusters'] = @api_client.build_collection_param(opts[:'filter_clusters'], :multi) if !opts[:'filter_clusters'].nil? query_params[:'filter.resource_pools'] = @api_client.build_collection_param(opts[:'filter_resource_pools'], :multi) if !opts[:'filter_resource_pools'].nil? query_params[:'filter.power_states'] = @api_client.build_collection_param(opts[:'filter_power_states'], :multi) if !opts[:'filter_power_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::VcenterVMListResult', '400' => 'VCenter::VapiStdErrorsUnableToAllocateResourceError', '401' => 'VCenter::VapiStdErrorsUnauthenticatedError', '403' => 'VCenter::VapiStdErrorsUnauthorizedError', '503' => 'VCenter::VapiStdErrorsServiceUnavailableError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: VMApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |