[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
VdcNetwork
An organization vDC network.
AllOf
This class requires all of the following:
JSON Example
{
"backingNetworkId": "string",
"backingNetworkType": "enum",
"connection": {
"connected": false,
"connectionType": "enum",
"connectionTypeValue": "string",
"routerRef": {
"id": "string",
"name": "string"
}
},
"crossVdcNetworkId": "string",
"crossVdcNetworkLocationId": "string",
"description": "string",
"enableDualSubnetNetwork": false,
"guestVlanTaggingAllowed": false,
"id": "string",
"isDefaultNetwork": false,
"lastTaskFailureMessage": "string",
"name": "string",
"networkType": "enum",
"orgRef": {
"id": "string",
"name": "string"
},
"orgVdc": {
"id": "string",
"name": "string"
},
"orgVdcIsNsxTBacked": false,
"overlayId": 0,
"ownerRef": {
"id": "string",
"name": "string"
},
"parentNetworkId": {
"id": "string",
"name": "string"
},
"retainNicResources": false,
"routeAdvertised": false,
"securityGroups": [
{
"id": "string",
"name": "string"
}
],
"segmentProfileTemplateRef": {
"id": "string",
"name": "string"
},
"shared": false,
"status": "enum",
"subnets": {
"values": [
{
"dnsServer1": "string",
"dnsServer2": "string",
"dnsSuffix": "string",
"enabled": false,
"gateway": "string",
"ipRanges": {
"values": [
{
"endAddress": "string",
"startAddress": "string"
}
]
},
"prefixLength": 0,
"totalIpCount": 0,
"usedIpCount": 0
}
]
},
"totalIpCount": 0,
"usedIpCount": 0
}
Vendor Extensions
This class contains the following vendor extensions defined in the spec:
x-vcloud-cross-references:
- cross-reference:
alias: vAppUplinkEligible
description: |
A filter to look up a list of networks that are eligible as an uplink to a vApp
Example usage:
filter?vAppUplinkEligible==true
referenced-property: vAppUplinkEligible
referenced-type: ./networking/orgVdcNetworks.yaml#/definitions/OrgVdcNetworkAdditionalProperties
x-vcloud-property-annotations:
backingNetworkId:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
x-vcloud-restricted: Visible to provider users only
backingNetworkType:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
connection:
x-vcloud-constraints:
- constraint: NonSortable
crossVdcNetworkId:
x-vcloud-constraints:
- constraint: NonSortable
crossVdcNetworkLocationId:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
description:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
enableDualSubnetNetwork:
x-vcloud-added-in: "35.0"
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
guestVlanTaggingAllowed:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
id:
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSortable
isDefaultNetwork:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
lastTaskFailureMessage:
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSearchable
- constraint: NonSortable
x-vcloud-deprecated-alternative: |
Please use VCD Task API to monitor status of last task.
x-vcloud-deprecated-in: "33.0"
networkType:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
orgRef:
x-vcloud-added-in: "35.0"
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSortable
orgVdc:
x-vcloud-constraints:
- constraint: NonSortable
orgVdcIsNsxTBacked:
x-vcloud-added-in: "36.0"
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSearchable
- constraint: NonSortable
x-vcloud-restricted: Visible to provider users only
overlayId:
x-vcloud-added-in: "36.0"
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
x-vcloud-restricted: Visible to provider users only
ownerRef:
x-vcloud-added-in: "35.0"
x-vcloud-constraints:
- constraint: NonSortable
retainNicResources:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
routeAdvertised:
x-vcloud-added-in: "34.0"
securityGroups:
x-vcloud-added-in: "34.0"
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
segmentProfileTemplateRef:
x-vcloud-added-in: "36.2"
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
totalIpCount:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
usedIpCount:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 31.0
Property Of
InlineVdcNetworks1
Parameter To
Create Network
Update Network
Returned By
Get Org VDC Network