vCloud API - OrgVdcNetwork

OrgVdcNetworkType

Element:

OrgVdcNetwork

Type:

OrgVdcNetworkType

Namespace:

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

Description:

Represents an Org vDC network in the vCloud model.

Since:

5.1

Schema:

network.xsd

Media type(s):

None

Extends:

NetworkType

XML Representation:

<OrgVdcNetwork xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string" status="xs:int">
    <VCloudExtension required="xs:boolean"/>
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string">
        <VCloudExtension required="xs:boolean"/>
    </Link>
    <Description> xs:string </Description>
    <Tasks>
        <VCloudExtension required="xs:boolean"/>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <VCloudExtension required="xs:boolean"/>
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </Link>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </Owner>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <VCloudExtension required="xs:boolean"/>
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
                    <VCloudExtension required="xs:boolean"/>
                </TenantError>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </User>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </Organization>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
        </Task>
    </Tasks>
    <Configuration>
        <VCloudExtension required="xs:boolean"/>
        <BackwardCompatibilityMode> xs:boolean </BackwardCompatibilityMode>
        <IpScopes>
            <VCloudExtension required="xs:boolean"/>
            <IpScope>
                <VCloudExtension required="xs:boolean"/>
                <IsInherited> xs:boolean </IsInherited>
                <Gateway> IpAddressType </Gateway>
                <Netmask> IpAddressType </Netmask>
                <Dns1> IpAddressType </Dns1>
                <Dns2> IpAddressType </Dns2>
                <DnsSuffix> xs:string </DnsSuffix>
                <IsEnabled> xs:boolean </IsEnabled>
                <IpRanges>
                    <VCloudExtension required="xs:boolean"/>
                    <IpRange>
                        <VCloudExtension required="xs:boolean"/>
                        <StartAddress> IpAddressType </StartAddress>
                        <EndAddress> IpAddressType </EndAddress>
                    </IpRange>
                </IpRanges>
                <AllocatedIpAddresses>
                    <VCloudExtension required="xs:boolean"/>
                    <IpAddress> IpAddressType </IpAddress>
                </AllocatedIpAddresses>
                <SubAllocations href="xs:anyURI" type="xs:string">
                    <VCloudExtension required="xs:boolean"/>
                    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                            rel="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </Link>
                    <SubAllocation>
                        <VCloudExtension required="xs:boolean"/>
                        <EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                            <VCloudExtension required="xs:boolean"/>
                        </EdgeGateway>
                        <IpRanges>
                            <VCloudExtension required="xs:boolean"/>
                            <IpRange>
                                <VCloudExtension required="xs:boolean"/>
                                <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">
            <VCloudExtension required="xs:boolean"/>
        </ParentNetwork>
        <FenceMode> xs:string </FenceMode>
        <RetainNetInfoAcrossDeployments> xs:boolean </RetainNetInfoAcrossDeployments>
        <Features>
            <NetworkService>
                <VCloudExtension required="xs:boolean"/>
                <IsEnabled> xs:boolean </IsEnabled>
            </NetworkService>
        </Features>
        <SyslogServerSettings>
            <SyslogServerIp1> IpAddressType </SyslogServerIp1>
            <SyslogServerIp2> IpAddressType </SyslogServerIp2>
        </SyslogServerSettings>
        <RouterInfo>
            <ExternalIp> IpAddressType </ExternalIp>
        </RouterInfo>
    </Configuration>
    <EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
        <VCloudExtension required="xs:boolean"/>
    </EdgeGateway>
    <ServiceConfig>
        <VCloudExtension required="xs:boolean"/>
        <NetworkService>
            <VCloudExtension required="xs:boolean"/>
            <IsEnabled> xs:boolean </IsEnabled>
        </NetworkService>
    </ServiceConfig>
    <IsShared> xs:boolean </IsShared>
</OrgVdcNetwork>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	5.1	The URI of the entity.
type	string	No	always	5.1	The MIME type of the entity.
id	string	No	none	5.1	The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey	string	No	create	5.1	Optional unique identifier to support idempotent semantics for create and delete operations.
name	string	Yes	always	5.1	The name of the entity.
status	int	No	none	5.1	Creation status of the org vDC network. One of: 0 (The org vDC network is not completely created) 1 (The org vDC network is ready)

Elements

Element	Type	Required	Modifiable	Since	Description
Configuration	NetworkConfigurationType	No	always	5.1	Network configuration.
Description	string	No	always	5.1	Optional description.
EdgeGateway	ReferenceType	No	always	5.1	EdgeGateway that connects this Org vDC network. Applicable only for routed networks.
IsShared	boolean	No	always	5.1	True if this network is shared to multiple Org vDCs.
Link	LinkType	No	none	5.1	A reference to an entity or operation associated with this object.
ServiceConfig	GatewayFeaturesType	No	always	5.1	Specifies the service configuration for an isolated Org vDC networks.
Tasks	TasksInProgressType	No	none	5.1	A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension	VCloudExtensionType	No	always	5.1	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.