Class List Method List File List

# Class: Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy

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

## Overview

The ``Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy`` enumerated type defines the possible IP allocation policy for a deployment.

## Constant Summary

DHCP =

      IpAllocationPolicy.new('DHCP')

TRANSIENT_IPPOOL =

      IpAllocationPolicy.new('TRANSIENT_IPPOOL')

STATIC_MANUAL =

      IpAllocationPolicy.new('STATIC_MANUAL')

STATIC_IPPOOL =

      IpAllocationPolicy.new('STATIC_IPPOOL')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy) dhcp

  Specifies that DHCP will be used to allocate IP addresses.

- - (Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy) static_ippool

  Specifies that IP addresses are allocated from the range managed by an IP pool.

- - (Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy) static_manual

  Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed.

- - (Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy) transient_ippool

  Specifies that IP addresses are allocated from an IP pool.

## Class Method Summary (collapse)

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

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

- + (IpAllocationPolicy) 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::Ovf::IpAllocationParams::IpAllocationPolicy`) dhcp

Specifies that DHCP will be used to allocate IP addresses.

Returns:

- (`Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy`)

    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    1397
    1398
    1399
    1400
    1401
    1402
    1403
    1404
    1405
    1406
    1407
    1408
    1409
    1410
    1411
    1412
    1413
    1414
    1415
    1416
    1417
    1418
    1419
    1420
    1421
    1422
    1423
    1424
    1425
    1426
    1427
    1428
    1429
    1430
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1373

    class IpAllocationPolicy < 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.ovf.ip_allocation_params.ip_allocation_policy',
                    IpAllocationPolicy)
            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 [IpAllocationPolicy] 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
                    IpAllocationPolicy.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] dhcp
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that DHCP will be used to allocate IP addresses.
        DHCP = IpAllocationPolicy.new('DHCP')

        # @!attribute [rw] transient_ippool
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.
        TRANSIENT_IPPOOL = IpAllocationPolicy.new('TRANSIENT_IPPOOL')

        # @!attribute [rw] static_manual
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.
        STATIC_MANUAL = IpAllocationPolicy.new('STATIC_MANUAL')

        # @!attribute [rw] static_ippool
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.
        STATIC_IPPOOL = IpAllocationPolicy.new('STATIC_IPPOOL')

    end

### - (`Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy`) static_ippool

Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.

Returns:

- (`Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy`)

    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    1397
    1398
    1399
    1400
    1401
    1402
    1403
    1404
    1405
    1406
    1407
    1408
    1409
    1410
    1411
    1412
    1413
    1414
    1415
    1416
    1417
    1418
    1419
    1420
    1421
    1422
    1423
    1424
    1425
    1426
    1427
    1428
    1429
    1430
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1373

    class IpAllocationPolicy < 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.ovf.ip_allocation_params.ip_allocation_policy',
                    IpAllocationPolicy)
            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 [IpAllocationPolicy] 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
                    IpAllocationPolicy.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] dhcp
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that DHCP will be used to allocate IP addresses.
        DHCP = IpAllocationPolicy.new('DHCP')

        # @!attribute [rw] transient_ippool
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.
        TRANSIENT_IPPOOL = IpAllocationPolicy.new('TRANSIENT_IPPOOL')

        # @!attribute [rw] static_manual
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.
        STATIC_MANUAL = IpAllocationPolicy.new('STATIC_MANUAL')

        # @!attribute [rw] static_ippool
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.
        STATIC_IPPOOL = IpAllocationPolicy.new('STATIC_IPPOOL')

    end

### - (`Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy`) static_manual

Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.

Returns:

- (`Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy`)

    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    1397
    1398
    1399
    1400
    1401
    1402
    1403
    1404
    1405
    1406
    1407
    1408
    1409
    1410
    1411
    1412
    1413
    1414
    1415
    1416
    1417
    1418
    1419
    1420
    1421
    1422
    1423
    1424
    1425
    1426
    1427
    1428
    1429
    1430
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1373

    class IpAllocationPolicy < 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.ovf.ip_allocation_params.ip_allocation_policy',
                    IpAllocationPolicy)
            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 [IpAllocationPolicy] 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
                    IpAllocationPolicy.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] dhcp
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that DHCP will be used to allocate IP addresses.
        DHCP = IpAllocationPolicy.new('DHCP')

        # @!attribute [rw] transient_ippool
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.
        TRANSIENT_IPPOOL = IpAllocationPolicy.new('TRANSIENT_IPPOOL')

        # @!attribute [rw] static_manual
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.
        STATIC_MANUAL = IpAllocationPolicy.new('STATIC_MANUAL')

        # @!attribute [rw] static_ippool
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.
        STATIC_IPPOOL = IpAllocationPolicy.new('STATIC_IPPOOL')

    end

### - (`Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy`) transient_ippool

Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.

Returns:

- (`Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy`)

    1373
    1374
    1375
    1376
    1377
    1378
    1379
    1380
    1381
    1382
    1383
    1384
    1385
    1386
    1387
    1388
    1389
    1390
    1391
    1392
    1393
    1394
    1395
    1396
    1397
    1398
    1399
    1400
    1401
    1402
    1403
    1404
    1405
    1406
    1407
    1408
    1409
    1410
    1411
    1412
    1413
    1414
    1415
    1416
    1417
    1418
    1419
    1420
    1421
    1422
    1423
    1424
    1425
    1426
    1427
    1428
    1429
    1430
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1373

    class IpAllocationPolicy < 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.ovf.ip_allocation_params.ip_allocation_policy',
                    IpAllocationPolicy)
            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 [IpAllocationPolicy] 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
                    IpAllocationPolicy.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] dhcp
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that DHCP will be used to allocate IP addresses.
        DHCP = IpAllocationPolicy.new('DHCP')

        # @!attribute [rw] transient_ippool
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.
        TRANSIENT_IPPOOL = IpAllocationPolicy.new('TRANSIENT_IPPOOL')

        # @!attribute [rw] static_manual
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.
        STATIC_MANUAL = IpAllocationPolicy.new('STATIC_MANUAL')

        # @!attribute [rw] static_ippool
        #     @return [Com::Vmware::Vcenter::Ovf::IpAllocationParams::IpAllocationPolicy]
        #     Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.
        STATIC_IPPOOL = IpAllocationPolicy.new('STATIC_IPPOOL')

    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

    1379
    1380
    1381
    1382
    1383
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1379

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.vcenter.ovf.ip_allocation_params.ip_allocation_policy',
            IpAllocationPolicy)
    end

### + (`IpAllocationPolicy`) 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:

- (`IpAllocationPolicy`) —

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

    1390
    1391
    1392
    1393
    1394
    1395
    1396
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1390

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