VMware Cloud Director API - EdgeGatewayRecord

VMware Cloud Director API - EdgeGatewayRecord

QueryResultEdgeGatewayRecordType

Element:
EdgeGatewayRecord
Type:
QueryResultEdgeGatewayRecordType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Type for a single edgeGateway query result in records format.
Since:
5.1
Schema:
queryRecordView.xsd
Media type(s):
None
Extends:
QueryResultRecordType
XML Representation:
<EdgeGatewayRecord xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
        vdc="xs:string" numberOfExtNetworks="xs:int" numberOfOrgNetworks="xs:int" isBusy="xs:boolean"
        edgeGatewayType="xs:string" orgVdcName="xs:string" orgName="xs:string" availableNetCount="xs:int"
        gatewayStatus="xs:string" haStatus="xs:string" advancedNetworkingEnabled="xs:boolean" distributedRoutingEnabled="xs:boolean"
        egressPointId="xs:string" vdcGroupId="xs:string" vdcGroupName="xs:string" deploymentMode="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Metadata 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"/>
        <MetadataEntry 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"/>
            <Domain visibility="xs:string"/>
            <Key> xs:string </Key>
            <TypedValue/>
        </MetadataEntry>
    </Metadata>
</EdgeGatewayRecord>

Attributes

Attribute Type Required Modifiable Since Deprecated Description Filter Sort
href anyURI No always 5.1 Contains the URI to the resource. Yes Yes
id string No always 5.1 The resource identifier, expressed in URN format. The value of this attribute uniquely identifies the resource, persists for the life of the resource, and is never reused. Yes Yes
type string No always 5.1 Contains the type of the resource. Yes Yes
name string No none 5.1 EdgeGateway name. Yes Yes
vdc string No none 5.1 VDC Reference or ID Yes Yes
numberOfExtNetworks int No none 5.1 Number of external networks connected to the edgeGateway. Yes Yes
numberOfOrgNetworks int No none 5.1 Number of org VDC networks connected to the edgeGateway Yes Yes
isBusy boolean No none 5.1 True if this Edge Gateway is busy. Yes Yes
edgeGatewayType string No none 32.0 Yes Yes
orgVdcName string No none 29.0 Yes Yes
orgName string No none 32.0 Organization name Yes Yes
availableNetCount int No none 29.0 Available networks count Yes Yes
gatewayStatus string No none 5.1 Yes Yes
haStatus string No none 5.1 High Availability Status of the edgeGateway Yes Yes
advancedNetworkingEnabled boolean No none 7.0 Is Advanced Networking Enabled Yes Yes
distributedRoutingEnabled boolean No none 29.0 True if Distributed Routing for this Edge Gateway is enabled Yes Yes
egressPointId string No none 31.0 Id of the egress point using this gateway Yes Yes
vdcGroupId string No none 35.0 VDC Group Id Yes Yes
vdcGroupName string No none 35.0 VDC Group Name Yes Yes
deploymentMode string No none 39.0 Deployment Mode Yes Yes

Elements

Element Type Required Modifiable Since Deprecated Description
Link LinkType No none 5.1 Contains a link to an operation associated with a specific relation type.
Metadata MetadataType No 5.1