Query a Network Profile Example
GET /api/network/profiles/{id} queries and displays an external, NAT, or routed network profile. For example, you can query an external network profile and use it as the basis for creating a different type of network profile.
curl Command
The following example command queries the existing network profile ID 68b6a183-fc8a-4592-af23-92f8d410ee32.
curl --insecure -H "Accept:application/json" -H "Authorization: Bearer $token" https://$vRA/iaas-proxy-provider/api/network/profiles/68b6a183-fc8a-4592-af23-92f8d410ee32
JSON Output
The following JSON output is returned based on the command input.
{
"@type": "ExternalNetworkProfile",
"id": "68b6a183-fc8a-4592-af23-92f8d410ee32",
"name": "externalTest",
"description": "",
"createdDate": "2014-11-11T02:24:07.000Z",
"lastModifiedDate": "2014-11-11T02:24:07.000Z",
"isHidden": false,
"definedRanges": [
{
"id": "3a85a049-522f-4b64-8f60-6e7b252ad204",
"name": "range",
"description": "",
"beginIPv4Address": "10.110.183.200",
"endIPv4Address": "10.110.183.201",
"state": "UNALLOCATED",
"createdDate": "2014-11-11T02:23:38.000Z",
"lastModifiedDate": "2014-11-11T02:23:38.000Z",
"definedAddresses": [
{
"id": "f229ea1a-18de-4dae-ae7b-0cec7feaa99b",
"name": null,
"description": null,
"IPv4Address": "10.110.183.201",
"IPSortValue": 0,
"state": "UNALLOCATED",
"hostName": "",
"createdDate": "2014-11-11T02:23:38.000Z",
"lastModifiedDate": "2014-11-11T02:23:38.000Z"
},
{
"id": "cd39e786-6490-4c95-8cf7-d6e3b6a0ba67",
"name": null,
"description": null,
"IPv4Address": "10.110.183.200",
"IPSortValue": 0,
"state": "UNALLOCATED",
"hostName": "",
"createdDate": "2014-11-11T02:23:38.000Z",
"lastModifiedDate": "2014-11-11T02:23:38.000Z"
},
}
],
"profileType": "EXTERNAL",
"IPAMEndpointId": null,
"subnetMask": "255.255.255.0",
"gatewayAddress": "10.110.183.253",
"primaryDnsAddress": "10.110.182.45",
"secondaryDnsAddress": "",
"dnsSuffix": "mycompany.com",
"dnsSearchSuffix": "",
"primaryWinsAddress": "10.0.0.1",
"secondaryWinsAddress": ""
}
Input
Use the supported input parameters to control the command output.
| Parameter | Description |
|---|---|
|
URL |
https://$vRA/iaas-proxy-provider/api/network/profiles/$id |
|
Method |
Get |
| $vRA |
Specifies the appliance name and fully qualified domain name, or IP address of the vRealize Automation server. |
| $token |
Specifies a valid HTTP bearer token with necessary credentials. |
| $id: | Specifies the unique network profile identifier. |
Output
The command output contains property names and values based on the command input parameters.
| Parameter | Description | |
|---|---|---|
|
Links |
Specifies an array of link objects, each of which contains the following parts:
|
|
|
Content |
Specifies an array of data rows, each of which represents one of the objects returned in a pageable list. Each object contains the following information:
|
|
|
Metadata |
Specifies the
following paging-related data:
|
|