Class List Method List File List

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

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

## Overview

The ``Com::Vmware::Vcenter::Network::Type`` enumerated type defines the type of a vCenter Server network. The type of a network can be used to determine what features it supports and which APIs can be used to find more information about the network or change its configuration.

## Constant Summary

STANDARD_PORTGROUP =

      Type.new('STANDARD_PORTGROUP')

DISTRIBUTED_PORTGROUP =

      Type.new('DISTRIBUTED_PORTGROUP')

OPAQUE_NETWORK =

      Type.new('OPAQUE_NETWORK')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Vcenter::Network::Type) distributed_portgroup

  XXX: vCenter based (create and managed through vCenter).

- - (Com::Vmware::Vcenter::Network::Type) opaque_network

  A network for whose configuration is managed outside of vSphere.

- - (Com::Vmware::Vcenter::Network::Type) standard_portgroup

  XXX: ESX based (created and managed on ESX).

## Class Method Summary (collapse)

- + (VAPI::Bindings::EnumType) binding_type

  Holds (gets or creates) the binding type metadata for this enumeration type.

- + (Type) from_string(value)

  Converts from a string value (perhaps off the wire) to an instance of this enum type.

## Instance Attribute Details

### - (`Com::Vmware::Vcenter::Network::Type`) distributed_portgroup

XXX: vCenter based (create and managed through vCenter)

Returns:

- (`Com::Vmware::Vcenter::Network::Type`)

    2091
    2092
    2093
    2094
    2095
    2096
    2097
    2098
    2099
    2100
    2101
    2102
    2103
    2104
    2105
    2106
    2107
    2108
    2109
    2110
    2111
    2112
    2113
    2114
    2115
    2116
    2117
    2118
    2119
    2120
    2121
    2122
    2123
    2124
    2125
    2126
    2127
    2128
    2129
    2130
    2131
    2132
    2133
    2134
    2135
    2136
    2137
    2138
    2139
    2140
    2141
    2142
    2143
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 2091

    class Type < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.network.type',
                    Type)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [Type] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    Type.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] standard_portgroup
        #     @return [Com::Vmware::Vcenter::Network::Type]
        #     XXX: ESX based (created and managed on ESX)
        STANDARD_PORTGROUP = Type.new('STANDARD_PORTGROUP')

        # @!attribute [rw] distributed_portgroup
        #     @return [Com::Vmware::Vcenter::Network::Type]
        #     XXX: vCenter based (create and managed through vCenter)
        DISTRIBUTED_PORTGROUP = Type.new('DISTRIBUTED_PORTGROUP')

        # @!attribute [rw] opaque_network
        #     @return [Com::Vmware::Vcenter::Network::Type]
        #     A network for whose configuration is managed outside of vSphere. The identifer and name of the network is made available through vSphere so that host and virtual machine virtual ethernet devices can connect to them.
        OPAQUE_NETWORK = Type.new('OPAQUE_NETWORK')

    end

### - (`Com::Vmware::Vcenter::Network::Type`) opaque_network

A network for whose configuration is managed outside of vSphere. The identifer and name of the network is made available through vSphere so that host and virtual machine virtual ethernet devices can connect to them.

Returns:

- (`Com::Vmware::Vcenter::Network::Type`)

    2091
    2092
    2093
    2094
    2095
    2096
    2097
    2098
    2099
    2100
    2101
    2102
    2103
    2104
    2105
    2106
    2107
    2108
    2109
    2110
    2111
    2112
    2113
    2114
    2115
    2116
    2117
    2118
    2119
    2120
    2121
    2122
    2123
    2124
    2125
    2126
    2127
    2128
    2129
    2130
    2131
    2132
    2133
    2134
    2135
    2136
    2137
    2138
    2139
    2140
    2141
    2142
    2143
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 2091

    class Type < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.network.type',
                    Type)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [Type] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    Type.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] standard_portgroup
        #     @return [Com::Vmware::Vcenter::Network::Type]
        #     XXX: ESX based (created and managed on ESX)
        STANDARD_PORTGROUP = Type.new('STANDARD_PORTGROUP')

        # @!attribute [rw] distributed_portgroup
        #     @return [Com::Vmware::Vcenter::Network::Type]
        #     XXX: vCenter based (create and managed through vCenter)
        DISTRIBUTED_PORTGROUP = Type.new('DISTRIBUTED_PORTGROUP')

        # @!attribute [rw] opaque_network
        #     @return [Com::Vmware::Vcenter::Network::Type]
        #     A network for whose configuration is managed outside of vSphere. The identifer and name of the network is made available through vSphere so that host and virtual machine virtual ethernet devices can connect to them.
        OPAQUE_NETWORK = Type.new('OPAQUE_NETWORK')

    end

### - (`Com::Vmware::Vcenter::Network::Type`) standard_portgroup

XXX: ESX based (created and managed on ESX)

Returns:

- (`Com::Vmware::Vcenter::Network::Type`)

    2091
    2092
    2093
    2094
    2095
    2096
    2097
    2098
    2099
    2100
    2101
    2102
    2103
    2104
    2105
    2106
    2107
    2108
    2109
    2110
    2111
    2112
    2113
    2114
    2115
    2116
    2117
    2118
    2119
    2120
    2121
    2122
    2123
    2124
    2125
    2126
    2127
    2128
    2129
    2130
    2131
    2132
    2133
    2134
    2135
    2136
    2137
    2138
    2139
    2140
    2141
    2142
    2143
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 2091

    class Type < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.network.type',
                    Type)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [Type] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    Type.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] standard_portgroup
        #     @return [Com::Vmware::Vcenter::Network::Type]
        #     XXX: ESX based (created and managed on ESX)
        STANDARD_PORTGROUP = Type.new('STANDARD_PORTGROUP')

        # @!attribute [rw] distributed_portgroup
        #     @return [Com::Vmware::Vcenter::Network::Type]
        #     XXX: vCenter based (create and managed through vCenter)
        DISTRIBUTED_PORTGROUP = Type.new('DISTRIBUTED_PORTGROUP')

        # @!attribute [rw] opaque_network
        #     @return [Com::Vmware::Vcenter::Network::Type]
        #     A network for whose configuration is managed outside of vSphere. The identifer and name of the network is made available through vSphere so that host and virtual machine virtual ethernet devices can connect to them.
        OPAQUE_NETWORK = Type.new('OPAQUE_NETWORK')

    end

## Class Method Details

### + (`VAPI::Bindings::EnumType`) binding_type

Holds (gets or creates) the binding type metadata for this enumeration type.

Returns:

- (`VAPI::Bindings::EnumType`) —

  the binding type

    2097
    2098
    2099
    2100
    2101
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 2097

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.vcenter.network.type',
            Type)
    end

### + (`Type`) from_string(value)

Converts from a string value (perhaps off the wire) to an instance of this enum type.

Parameters:

- value (`String`) —

  the actual value of the enum instance

Returns:

- (`Type`) —

  the instance found for the value, otherwise an unknown instance will be built for the value

    2108
    2109
    2110
    2111
    2112
    2113
    2114
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 2108

    def from_string(value)
        begin
            const_get(value)
        rescue NameError
            Type.new('UNKNOWN', value)
        end
    end