VMware Cloud Director API - NetworkConfigurationType

NetworkConfigurationType

Type:

NetworkConfigurationType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

The configurations applied to a network. This is an abstract base type. The concrete types include those for vApp and Organization wide networks.

Since:

0.9

Schema:

network.xsd

Media type(s):

None

Extends:

VCloudExtensibleType

XML Representation:

<NetworkConfigurationType xmlns="http://www.vmware.com/vcloud/v1.5">
    <BackwardCompatibilityMode> xs:boolean </BackwardCompatibilityMode>
    <IpScopes>
        <IpScope>
            <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>
        </IpScope>
    </IpScopes>
    <ParentNetwork href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <FenceMode> xs:string </FenceMode>
    <RetainNetInfoAcrossDeployments> xs:boolean </RetainNetInfoAcrossDeployments>
    <Features>
        <NetworkService>
            <IsEnabled> xs:boolean </IsEnabled>
        </NetworkService>
    </Features>
    <SyslogServerSettings>
        <SyslogServerIp1> IpAddressType </SyslogServerIp1>
        <SyslogServerIp2> IpAddressType </SyslogServerIp2>
    </SyslogServerSettings>
    <RouterInfo>
        <ExternalIp> IpAddressType </ExternalIp>
    </RouterInfo>
    <SubInterface> xs:boolean </SubInterface>
    <DistributedInterface> xs:boolean </DistributedInterface>
    <ServiceInterface> xs:boolean </ServiceInterface>
    <GuestVlanAllowed> xs:boolean </GuestVlanAllowed>
    <Connected> xs:boolean </Connected>
    <DualStackNetwork> xs:boolean </DualStackNetwork>
</NetworkConfigurationType>

Elements

Element	Type	Required	Modifiable	Since	Description
BackwardCompatibilityMode	boolean	No	always	5.1	Compatibility mode. Default is false. If set to true, will allow users to write firewall rules in the old 1.5 format. The new format does not require to use direction in firewall rules. Also, for firewall rules to allow NAT traffic the filter is applied on the original IP addresses. Once set to true cannot be reverted back to false.
Connected	boolean	No	always	33.0	True if Network is marked as connected in NSX. Defaults to true.
DistributedInterface	boolean	No	always	29.0	True if Network is connected to a distributed logical router.
DualStackNetwork	boolean	No	always	34.0	True if Network is a dual stack network, false if not. A dual stack network has both an IPv4 and an IPv6 subnet. Defaults to false.
Features	NetworkFeaturesType	No	always	0.9	Network features like DHCP, firewall and NAT rules.
FenceMode	string	Yes	always	0.9	Isolation type of the network. If ParentNetwork is specified, this property controls connectivity to the parent. One of: bridged (connected directly to the ParentNetwork), isolated (not connected to any other network), natRouted (connected to the ParentNetwork via a NAT service)
GuestVlanAllowed	boolean	No	always	29.0	True if Network allows guest VLAN tagging.
IpScopes	IpScopesType	No	always	5.1	A list of IP scopes for the network.
ParentNetwork	ReferenceType	No	always	0.9	Contains reference to parent network.
RetainNetInfoAcrossDeployments	boolean	No	always	1.5	Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Default is false.
RouterInfo	RouterInfoType	No	none	1.5	Specifies router information.
ServiceInterface	boolean	No	always	36.2	True if Network is connected as a service interface to a Nsx-T Tier1 Gateway.
SubInterface	boolean	No	always	27.0	True if Network is connected to an Edge Gateway subinterface.
SyslogServerSettings	SyslogServerSettingsType	No	none	0.9	Syslog server settings for the network.
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.