Class List Method List File List

# Class: Com::Vmware::Vcenter::Network

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Vcenter::Network
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb

## Overview

The Network class provides methods for manipulating a vCenter Server network.

## Defined Under Namespace

Classes: FilterSpec, Summary, Type

## Constant Summary

RESOURCE_TYPE =

      'Network'

## Instance Method Summary (collapse)

- - (Network) initialize(config) constructor

  Constructs a new instance.

- - (Array<Com::Vmware::Vcenter::Network::Summary>) list(filter = nil)

  Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the :class:`Com::Vmware::Vcenter::Network::FilterSpec` .

## Constructor Details

### - (`Network`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    1947
    1948
    1949
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1947

    def initialize(config)
        super(config, @@service_info)
    end

## Instance Method Details

### - (`Array<Com::Vmware::Vcenter::Network::Summary>`) list(filter = nil)

Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the :class:`Com::Vmware::Vcenter::Network::FilterSpec` .

Parameters:

- filter (`Com::Vmware::Vcenter::Network::FilterSpec`, `nil`) (defaults to: `nil`) —

  Specification of matching networks for which information should be returned. If nil , the behavior is equivalent to a :class:`Com::Vmware::Vcenter::Network::FilterSpec` with all fields nil which means all networks match the filter.

Returns:

- (`Array<Com::Vmware::Vcenter::Network::Summary>`) —

  Commonly used information about the networks matching the :class:`Com::Vmware::Vcenter::Network::FilterSpec` .

Raises:

- (`Com::Vmware::Vapi::Std::Errors::InvalidArgument`) —

  if the :attr:`Com::Vmware::Vcenter::Network::FilterSpec.types` field contains a value that is not supported by the server.

- (`Com::Vmware::Vapi::Std::Errors::UnableToAllocateResource`) —

  if more than 1000 networks match the :class:`Com::Vmware::Vcenter::Network::FilterSpec` .

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

  if the system is unable to communicate with a service to complete the request.

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    1971
    1972
    1973
    1974
    1975
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1971

    def list(filter=nil)
        invoke_with_info(@@list_info, {
            'filter' => filter,
        })
    end