Class: VSphereAutomation::VCenter::NetworkApi
- Inherits:
-
Object
- Object
- VSphereAutomation::VCenter::NetworkApi
- Defined in:
- lib/vsphere-automation-vcenter/api/network_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) ⇒ NetworkApi
constructor
A new instance of NetworkApi.
-
#list(opts = {}) ⇒ VcenterNetworkListResult|VapiStdErrorsUnableToAllocateResourceError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|
Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec.
-
#list_with_http_info(opts = {}) ⇒ Array<(VcenterNetworkListResult|VapiStdErrorsUnableToAllocateResourceError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>
private
Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ NetworkApi
Returns a new instance of NetworkApi.
16 17 18 |
# File 'lib/vsphere-automation-vcenter/api/network_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/network_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#list(opts = {}) ⇒ VcenterNetworkListResult|VapiStdErrorsUnableToAllocateResourceError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|
Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec.
27 28 29 30 |
# File 'lib/vsphere-automation-vcenter/api/network_api.rb', line 27 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
#list_with_http_info(opts = {}) ⇒ Array<(VcenterNetworkListResult|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) networks in vCenter matching the Network.FilterSpec.
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 82 83 84 85 86 87 |
# File 'lib/vsphere-automation-vcenter/api/network_api.rb', line 41 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: NetworkApi.list ...' end if @api_client.config.client_side_validation && opts[:'filter_types'] && !opts[:'filter_types'].all? { |item| ['STANDARD_PORTGROUP', 'DISTRIBUTED_PORTGROUP', 'OPAQUE_NETWORK'].include?(item) } fail ArgumentError, 'invalid value for "filter_types", must include one of STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, OPAQUE_NETWORK' end # resource path local_var_path = '/vcenter/network' # query parameters query_params = {} query_params[:'filter.networks'] = @api_client.build_collection_param(opts[:'filter_networks'], :multi) if !opts[:'filter_networks'].nil? query_params[:'filter.names'] = @api_client.build_collection_param(opts[:'filter_names'], :multi) if !opts[:'filter_names'].nil? query_params[:'filter.types'] = @api_client.build_collection_param(opts[:'filter_types'], :multi) if !opts[:'filter_types'].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? # 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::VcenterNetworkListResult', '400' => 'VCenter::VapiStdErrorsUnableToAllocateResourceError', '401' => 'VCenter::VapiStdErrorsUnauthenticatedError', '403' => 'VCenter::VapiStdErrorsUnauthorizedError', '503' => 'VCenter::VapiStdErrorsServiceUnavailableError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: NetworkApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |