Class: VSphereAutomation::VCenter::StoragePoliciesVMApi
- Inherits:
-
Object
- Object
- VSphereAutomation::VCenter::StoragePoliciesVMApi
- Defined in:
- lib/vsphere-automation-vcenter/api/storage_policies_vm_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ StoragePoliciesVMApi
constructor
A new instance of StoragePoliciesVMApi.
-
#list(policy, opts = {}) ⇒ VcenterStoragePoliciesVMListResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|
Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
-
#list_with_http_info(policy, opts = {}) ⇒ Array<(VcenterStoragePoliciesVMListResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>
private
Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ StoragePoliciesVMApi
Returns a new instance of StoragePoliciesVMApi.
16 17 18 |
# File 'lib/vsphere-automation-vcenter/api/storage_policies_vm_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/storage_policies_vm_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#list(policy, opts = {}) ⇒ VcenterStoragePoliciesVMListResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|
Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
23 24 25 26 |
# File 'lib/vsphere-automation-vcenter/api/storage_policies_vm_api.rb', line 23 def list(policy, opts = {}) data, _status_code, _headers = list_with_http_info(policy, opts) data end |
#list_with_http_info(policy, opts = {}) ⇒ Array<(VcenterStoragePoliciesVMListResult|VapiStdErrorsErrorError|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 the virtual machines and/or their virtual disks that are associated with the given storage policy.
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 |
# File 'lib/vsphere-automation-vcenter/api/storage_policies_vm_api.rb', line 33 def list_with_http_info(policy, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: StoragePoliciesVMApi.list ...' end # verify the required parameter 'policy' is set if @api_client.config.client_side_validation && policy.nil? fail ArgumentError, "Missing the required parameter 'policy' when calling StoragePoliciesVMApi.list" end # resource path local_var_path = '/vcenter/storage/policies/{policy}/vm'.sub('{' + 'policy' + '}', policy.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::VcenterStoragePoliciesVMListResult', '400' => 'VCenter::VapiStdErrorsErrorError', '401' => 'VCenter::VapiStdErrorsUnauthenticatedError', '403' => 'VCenter::VapiStdErrorsUnauthorizedError', '404' => 'VCenter::VapiStdErrorsNotFoundError', '503' => 'VCenter::VapiStdErrorsServiceUnavailableError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: StoragePoliciesVMApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |