VMware Cloud Director API - IpScopeType

VMware Cloud Director API - IpScopeType

IpScopeType

Type:
IpScopeType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Specify network settings like gateway, network mask, DNS servers, IP ranges, etc.
Since:
0.9
Schema:
network.xsd
Media type(s):
None
Extends:
VCloudExtensibleType
XML Representation:
<IpScopeType xmlns="http://www.vmware.com/vcloud/v1.5">
    <IsInherited> xs:boolean </IsInherited>
    <Gateway> IpAddressType </Gateway>
    <Netmask> IpAddressType </Netmask>
    <SubnetPrefixLength> xs:int </SubnetPrefixLength>
    <Dns1> IpAddressType </Dns1>
    <Dns2> IpAddressType </Dns2>
    <DnsSuffix> xs:string </DnsSuffix>
    <IsEnabled> xs:boolean </IsEnabled>
    <IpRanges>
        <IpRange>
            <StartAddress> IpAddressType </StartAddress>
            <EndAddress> IpAddressType </EndAddress>
        </IpRange>
    </IpRanges>
    <AllocatedIpAddresses>
        <IpAddress> IpAddressType </IpAddress>
    </AllocatedIpAddresses>
    <SubAllocations href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <SubAllocation>
            <EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <IpRanges>
                <IpRange>
                    <StartAddress> IpAddressType </StartAddress>
                    <EndAddress> IpAddressType </EndAddress>
                </IpRange>
            </IpRanges>
        </SubAllocation>
    </SubAllocations>
</IpScopeType>

Elements

Element Type Required Modifiable Since Deprecated Description
AllocatedIpAddresses IpAddressesType No none 0.9 Read-only list of allocated IP addresses in the network.
Dns1 IpAddressType No always 0.9 Primary DNS server.
Dns2 IpAddressType No always 0.9 Secondary DNS server.
DnsSuffix string No always 0.9 DNS suffix.
Gateway IpAddressType No always 0.9 Gateway of the network.
IpRanges IpRangesType No always 0.9 IP ranges used for static pool allocation in the network.
IsEnabled boolean No always 5.1 Indicates if subnet is enabled or not. Default value is True.
IsInherited boolean Yes always 0.9 True if the IP scope is inherit from parent network.
Netmask IpAddressType No always 0.9 Network mask.
SubAllocations SubAllocationsType No none 5.1 Read-only list of IP addresses that are sub allocated to edge gateways.
SubnetPrefixLength int No always 0.9 Network mask.
VCloudExtension VCloudExtensionType No always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.