You can use the REST API to query and display an external, NAT, private, 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.

Before you begin

  • Log in to vRealize Automation as a tenant administrator.

  • Verify that the host name and fully qualified domain name of the vRealize Automation instance are available.

  • If you are not using the API Explorer, verify that you have a valid HTTP bearer token that matches your login credentials. See REST API Authentication.

  • Obtain the network profile ID to query. See Get a Network Profile List.

About this task

Procedure

Use the following command to query the existing network profile ID 68b6a183-fc8a-4592-af23-92f8d410ee32.
curl --insecure -H "Accept:application/json" 
-H "Authorization: Bearer $token" 
https://$host/ iaas-proxy-provider/api/network/profiles/68b6a183-fc8a-4592-af23-92f8d410ee32

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.220",
      "state": "UNALLOCATED",
      "createdDate": "2014-11-11T02:23:38.000Z",
      "lastModifiedDate": "2014-11-11T02:23:38.000Z",
      "definedAddresses": [
        {
          "id": "16ab9e24-7c30-4d6d-85fc-04a6fb72919b",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.211",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "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": "22ed8c63-f34f-454b-9e05-245b65c8deaa",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.216",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "42093f0e-7814-46cf-b3ee-2544aa79a20d",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.204",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "a194316e-0d92-4f23-ba16-2fa8dbb5c695",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.215",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "7cbe2d40-986d-429a-a91c-30067fff3d94",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.213",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "3ba70e64-84c6-42bf-a20d-3229de74544a",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.220",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "a1777d45-b2d0-4ecd-9d0a-3db499756f0f",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.206",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "8349e9bf-33ff-4382-9d9f-5b05efcf7f9c",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.207",
          "IPSortValue": 0,
          "state": "UNALLOCATED",

          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "bf96c279-4ea7-4b34-8b08-7a13f156d6c9",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.214",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "10e85576-95c6-4df3-bff7-7ba590286e1a",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.210",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "f1962c5e-6b48-4cd5-9f2d-93b706690b6b",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.205",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "cdfc5bcc-1db7-46e7-b8e7-a40d67c92763",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.219",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "b846b73d-950d-4a96-a335-b67d8bf8022b",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.202",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "fc7c445f-5efe-4c1e-941e-c78a2682d3f0",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.208",
          "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"
        },
        {
          "id": "900fcc08-7713-41fe-9f3a-e5c0da3f02b7",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.217",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "4854b7af-13fa-48ed-a69f-e7e428699909",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.212",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "4a1b41fe-f585-43b1-8c62-ee8a14f026cf",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.203",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "451ab99c-c6df-4ecd-8b48-f14d7afa4c48",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.209",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        },
        {
          "id": "db9b41af-4f7b-41f3-b14e-f373df6dd128",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.218",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:23:38.000Z",
          "lastModifiedDate": "2014-11-11T02:23:38.000Z"
        }
      ]
    },
    {
      "id": "67acdc6f-d0b9-4f47-a74b-ea58ff9ce074",
      "name": "range2",
      "description": "",
      "beginIPv4Address": "10.110.183.180",
      "endIPv4Address": "10.110.183.199",
      "state": "UNALLOCATED",
      "createdDate": "2014-11-11T02:24:04.000Z",
      "lastModifiedDate": "2014-11-11T02:24:04.000Z",
      "definedAddresses": [
        {
          "id": "37b5c7d1-b82f-4961-a7cc-0117d3610ed7",

          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.182",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "d6112083-b195-4f94-9b07-0fe490d5caa8",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.192",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "b0032edf-c5c9-4809-9481-2427a1878936",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.186",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "e13b52fb-7375-4397-a054-24e29c843e6e",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.185",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "43d8bae4-7b78-40d2-a9ef-350d28901c24",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.180",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "c270ce8e-a418-4d02-89db-3b84f6816a75",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.181",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "684bbe43-29ce-4113-92c7-43921c943099",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.183",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "f7177c16-de44-4db6-bbee-47e0ef219478",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.188",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "0f6dc355-5c71-4c6a-b607-4916804feecc",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.190",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "9eb818c0-4174-4dbf-99be-4c9e6e83c90f",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.189",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "7f2a2483-1562-4e88-9ebd-5c61e75f2d79",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.195",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "0e7a8d8d-1bf7-4008-a3ec-634218049722",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.196",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "2d5f3e43-5899-46b6-a0ca-73dfbd57dd5f",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.193",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "67d43b6f-98f7-442a-a00e-761f2b462118",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.198",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "f64f36d8-076b-4d74-87d7-78b156b7764e",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.199",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "4b03c95a-ebb8-4382-ac10-7bb39173b718",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.197",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "636f224c-8ec4-4b58-9c9f-a847dbff4572",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.191",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "5d40b63e-523e-44d1-b0db-b6ecb3fed325",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.184",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "add1df2a-14ec-49d9-832e-d55c3a386926",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.187",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        },
        {
          "id": "ce67f8a7-c5ca-44d5-bd17-f944f2d3748e",
          "name": null,
          "description": null,
          "IPv4Address": "10.110.183.194",
          "IPSortValue": 0,
          "state": "UNALLOCATED",
          "hostName": "",
          "createdDate": "2014-11-11T02:24:04.000Z",
          "lastModifiedDate": "2014-11-11T02:24:04.000Z"
        }
      ]
    }
  ],
  "profileType": "EXTERNAL",
  "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": ""
}