VMware Cloud Director API - VMWExternalNetwork
VMWExternalNetworkType
- Element:
- VMWExternalNetwork
- Type:
- VMWExternalNetworkType
- Namespace:
- http://www.vmware.com/vcloud/extension/v1.5
- Description:
- External network type.
- Since:
- 1.0
- Schema:
- vmwextensions.xsd
- Media type(s):
-
application/vnd.vmware.admin.vmwexternalnet+json
application/vnd.vmware.admin.vmwexternalnet+xml
- Extends:
- NetworkType
- XML Representation:
-
<VMWExternalNetwork xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
name="xs:string">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<vcloud_v1.5:Tasks>
<vcloud_v1.5: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">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
<vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</vcloud_v1.5:Error>
<vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Progress> xs:int </Progress>
<Params> ... </Params>
<Details> xs:string </Details>
<vcloud_v1.5:VcTaskList>
<vcloud_v1.5:VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
</vcloud_v1.5:VcTaskList>
<vcloud_v1.5:Result>
<ResultContent> ... </ResultContent>
<vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</vcloud_v1.5:Result>
</vcloud_v1.5:Task>
</vcloud_v1.5:Tasks>
<vcloud_v1.5:Configuration>
<BackwardCompatibilityMode> xs:boolean </BackwardCompatibilityMode>
<vcloud_v1.5:IpScopes>
<vcloud_v1.5:IpScope>
<IsInherited> xs:boolean </IsInherited>
<vcloud_v1.5:Gateway> vcloud_v1.5:IpAddressType </vcloud_v1.5:Gateway>
<vcloud_v1.5:Netmask> vcloud_v1.5:IpAddressType </vcloud_v1.5:Netmask>
<SubnetPrefixLength> xs:int </SubnetPrefixLength>
<vcloud_v1.5:Dns1> vcloud_v1.5:IpAddressType </vcloud_v1.5:Dns1>
<vcloud_v1.5:Dns2> vcloud_v1.5:IpAddressType </vcloud_v1.5:Dns2>
<DnsSuffix> xs:string </DnsSuffix>
<IsEnabled> xs:boolean </IsEnabled>
<vcloud_v1.5:IpRanges>
<vcloud_v1.5:IpRange>
<vcloud_v1.5:StartAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:StartAddress>
<vcloud_v1.5:EndAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:EndAddress>
</vcloud_v1.5:IpRange>
</vcloud_v1.5:IpRanges>
<vcloud_v1.5:AllocatedIpAddresses>
<vcloud_v1.5:IpAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:IpAddress>
</vcloud_v1.5:AllocatedIpAddresses>
<vcloud_v1.5:SubAllocations href="xs:anyURI" type="xs:string">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<vcloud_v1.5:SubAllocation>
<vcloud_v1.5:EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:IpRanges>
<vcloud_v1.5:IpRange>
<vcloud_v1.5:StartAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:StartAddress>
<vcloud_v1.5:EndAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:EndAddress>
</vcloud_v1.5:IpRange>
</vcloud_v1.5:IpRanges>
</vcloud_v1.5:SubAllocation>
</vcloud_v1.5:SubAllocations>
</vcloud_v1.5:IpScope>
</vcloud_v1.5:IpScopes>
<vcloud_v1.5:ParentNetwork href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<FenceMode> xs:string </FenceMode>
<RetainNetInfoAcrossDeployments> xs:boolean </RetainNetInfoAcrossDeployments>
<vcloud_v1.5:Features>
<vcloud_v1.5:NetworkService>
<IsEnabled> xs:boolean </IsEnabled>
</vcloud_v1.5:NetworkService>
</vcloud_v1.5:Features>
<vcloud_v1.5:SyslogServerSettings>
<vcloud_v1.5:SyslogServerIp1> vcloud_v1.5:IpAddressType </vcloud_v1.5:SyslogServerIp1>
<vcloud_v1.5:SyslogServerIp2> vcloud_v1.5:IpAddressType </vcloud_v1.5:SyslogServerIp2>
</vcloud_v1.5:SyslogServerSettings>
<vcloud_v1.5:RouterInfo>
<vcloud_v1.5:ExternalIp> vcloud_v1.5:IpAddressType </vcloud_v1.5:ExternalIp>
</vcloud_v1.5:RouterInfo>
<SubInterface> xs:boolean </SubInterface>
<DistributedInterface> xs:boolean </DistributedInterface>
<GuestVlanAllowed> xs:boolean </GuestVlanAllowed>
<Connected> xs:boolean </Connected>
<DualStackNetwork> xs:boolean </DualStackNetwork>
</vcloud_v1.5:Configuration>
<VimPortGroupRef>
<vcloud_v1.5:VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<MoRef> xs:string </MoRef>
<VimObjectType> xs:string </VimObjectType>
</VimPortGroupRef>
<VimPortGroupRefs>
<VimObjectRef>
<vcloud_v1.5:VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<MoRef> xs:string </MoRef>
<VimObjectType> xs:string </VimObjectType>
</VimObjectRef>
</VimPortGroupRefs>
</VMWExternalNetwork>
-
Attributes
-
Attribute Type Required Modifiable Since Deprecated Description href anyURI No always 1.0 The URI of the entity. type string No always 1.0 The MIME type of the entity. id string No none 1.0 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 1.0 The name of the entity. -
Elements
-
Element Type Required Modifiable Since Deprecated Description Configuration NetworkConfigurationType No always 1.0 Network configuration. Description string No always 1.0 Optional description. Link LinkType No none 1.0 A reference to an entity or operation associated with this object. Tasks TasksInProgressType No none 1.0 A list of queued, running, or recently completed tasks associated with this entity. VCloudExtension VCloudExtensionType No always 1.0 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services. VimPortGroupRef VimObjectRefType (extension/v1.5) No always 1.0 The portgroup that backs this network. A valid reference to an existing network or dvportgroup in a vCenter server is required on create. On modify, this element is required for schema validation, but its contents cannot be changed. VimPortGroupRefs VimObjectRefsType No always 22.0 A list of DV_PORTGROUP or NETWORK objects that back this network. Each referenced DV_PORTGROUP or NETWORK must exist on a vCenter server registered with the system. You cannot reference more than one DV_PORTGROUP or NETWORK from a single vCenter server. You cannot combine DV_PORTGROUP and NETWORK objects in this list. -
Operations
-
CRUD Operation Description Since Deprecated as input PUT /admin/extension/externalnet/{id} Update an external network. 1.0 35.0 as input POST /admin/extension/externalnets Create an external network. 1.0 35.0