[{"label":"Latest (v36.3)","version":"latest"},{"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

Get VDC Network Profile

Description

Retrieves the vDC Network Profile.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/vdcs/{orgVdcId}/networkProfile
Copy

Path Parameters

Path Parameters

string
orgVdcId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns VdcNetworkProfile of type(s) application/json;version=36.3
{
	"primaryEdgeCluster": {
		"id": "string",
		"name": "string"
	},
	"secondaryEdgeCluster": {
		"id": "string",
		"name": "string"
	},
	"servicesEdgeCluster": {
		"backingId": "string",
		"edgeClusterRef": {
			"id": "string",
			"name": "string"
		}
	},
	"vappNetworkSegmentProfileTemplateRef": {
		"id": "string",
		"name": "string"
	},
	"vdcNetworkSegmentProfileTemplateRef": {
		"id": "string",
		"name": "string"
	}
}
primaryEdgeCluster Optional

The Edge Cluster where the primary appliance for an NSX-V Edge Gateway will be deployed.


secondaryEdgeCluster Optional

The Edge Cluster where the secondary appliance for an NSX-V Edge Gateway will be deployed if HA is enabled on the Edge.


servicesEdgeCluster Optional

The Edge Cluster where the DHCP server profile will be stored for NSX-T networks using NETWORK mode DHCP.


vappNetworkSegmentProfileTemplateRef Introduced Changed Optional

The vApp Network Segment Profile Template that is to be used when any new vApp Network is created under this VDC. Setting this will override any global level vApp Network Segment Profile Template. This field is only applicable for NSX-T Org vDC’s.


vdcNetworkSegmentProfileTemplateRef Introduced Changed Optional

The Org vDC Network Segment Profile Template that is to be used when any new Org vDC Network is created under this VDC. Setting this will override any global level Org vDC Network Segment Profile Template. This field is only applicable for NSX-T Org vDC’s.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/vdcs/{orgVdcId}/networkProfile


[{"label":"Latest (v36.3)","version":"latest"},{"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
Feedback

Was this page helpful?