Get a Network Profile List Example

GET /api/network/profiles returns a page of current network profiles.

curl Command

The following example command returns a list of network profiles.

curl --insecure -H "Accept:application/json" 
-H "Authorization: Bearer $token" 
https://$vRA/iaas-proxy-provider/api/network/profiles

JSON Output

The following JSON output is returned based on the command input.

{
  "links": [
    
  ],
  "content": [
    {
      "@type": "NATNetworkProfile",
      "id": "599541aa-ffb0-4a37-9483-4353f3fc6be3",
      "name": "NATTest",
      "description": "",
      "createdDate": "2014-11-11T02:29:09.000Z",
      "lastModifiedDate": "2014-11-11T02:29:09.000Z",
      "isHidden": false,
      "definedRanges": [
        {
          "id": "9f7d8025-bd4c-4560-9b41-9ce455ee49ae",
          "name": "range",
          "description": "",
          "beginIPv4Address": "10.118.190.110",
          "endIPv4Address": "10.118.190.115",
          "state": "UNALLOCATED",
          "createdDate": "2014-11-11T02:29:05.000Z",
          "lastModifiedDate": "2014-11-11T02:29:05.000Z",
          "definedAddresses": [
            {
              "id": "6e7dc8c3-dc64-4ebd-a282-05852010310f",
              "name": null,
              "description": null,
              "IPv4Address": "10.118.190.111",
              "IPSortValue": 0,
              "state": "UNALLOCATED",
              "hostName": "",
              "createdDate": "2014-11-11T02:29:05.000Z",
              "lastModifiedDate": "2014-11-11T02:29:05.000Z"
            },
            {
              "id": "f6802100-1d7e-4f31-bdeb-1b27f7e77766",
              "name": null,
              "description": null,
              "IPv4Address": "10.118.190.115",
              "IPSortValue": 0,
              "state": "UNALLOCATED",
              "hostName": "",
              "createdDate": "2014-11-11T02:29:05.000Z",
              "lastModifiedDate": "2014-11-11T02:29:05.000Z"
            },
            {
              "id": "f6deba8c-fbf4-4ea0-9d9c-325e9db2f13e",
              "name": null,
              "description": null,
              "IPv4Address": "10.118.190.114",
              "IPSortValue": 0,
              "state": "UNALLOCATED",
              "hostName": "",
              "createdDate": "2014-11-11T02:29:05.000Z",
              "lastModifiedDate": "2014-11-11T02:29:05.000Z"
            },
            {
              "id": "9d5a9d25-26d7-4ce3-93a2-61242a88c5b2",
              "name": null,
              "description": null,
              "IPv4Address": "10.118.190.110",
              "IPSortValue": 0,
              "state": "UNALLOCATED",
              "hostName": "",
              "createdDate": "2014-11-11T02:29:05.000Z",
              "lastModifiedDate": "2014-11-11T02:29:05.000Z"
            },
            {
              "id": "2b616f1a-dc35-4caa-8ee7-6494ca50db57",
              "name": null,
              "description": null,
              "IPv4Address": "10.118.190.113",
              "IPSortValue": 0,
              "state": "UNALLOCATED",
              "hostName": "",
              "createdDate": "2014-11-11T02:29:05.000Z",
              "lastModifiedDate": "2014-11-11T02:29:05.000Z"
            },
            {
              "id": "9dd5d265-ec23-42be-9bdb-734c11b1e315",
              "name": null,
              "description": null,
              "IPv4Address": "10.118.190.112",
              "IPSortValue": 0,
              "state": "UNALLOCATED",
              "hostName": "",
              "createdDate": "2014-11-11T02:29:05.000Z",
              "lastModifiedDate": "2014-11-11T02:29:05.000Z"
            },

          ]
        }
      ],
      "profileType": "NAT",
      "subnetMask": "255.255.255.0",
      "gatewayAddress": "10.118.190.230",
      "primaryDnsAddress": "10.110.182.45",
      "secondaryDnsAddress": "",
      "dnsSuffix": "mycompany.com",
      "dnsSearchSuffix": "",
      "primaryWinsAddress": "10.0.0.1",
      "secondaryWinsAddress": "",
      "dhcpStartIPAddress": null,
      "dhcpEndIPAddress": null,
      "leaseTimeInSeconds": 0
    },
    {
      "@type": "PrivateNetworkProfile",
      "id": "594e4016-b067-4d19-aa81-63502675f925",
      "name": "privateTest",
      "description": "",
      "createdDate": "2014-11-11T02:26:44.000Z",
      "lastModifiedDate": "2014-11-11T02:26:44.000Z",
      "isHidden": false,
      "definedRanges": [
        {
          "id": "8827193e-f1c3-493e-8bcd-1b153f2a5e74",
          "name": "range",
          "description": "",
          "beginIPv4Address": "10.118.190.110",
          "endIPv4Address": "10.118.190.112",
          "state": "UNALLOCATED",
          "createdDate": "2014-11-11T02:25:57.000Z",
          "lastModifiedDate": "2014-11-11T02:25:57.000Z",
          "definedAddresses": [
            {
              "id": "262a4273-1e75-4c23-8fb8-088473521b19",
              "name": null,
              "description": null,
              "IPv4Address": "10.118.190.111",
              "IPSortValue": 0,
              "state": "UNALLOCATED",
              "hostName": "",
                            "createdDate": "2014-11-11T02:25:57.000Z",
              "lastModifiedDate": "2014-11-11T02:25:57.000Z"
            },
            {
              "id": "7eebd0ad-0dde-4fa1-aad3-750498214caf",
              "name": null,
              "description": null,
              "IPv4Address": "10.118.190.110",
              "IPSortValue": 0,
              "state": "UNALLOCATED",
              "hostName": "",
              "createdDate": "2014-11-11T02:25:57.000Z",
              "lastModifiedDate": "2014-11-11T02:25:57.000Z"
            },
            {
              "id": "37ca8368-5d19-4d23-a6b8-7b233bb2320d",
              "name": null,
              "description": null,
              "IPv4Address": "10.118.190.112",
              "IPSortValue": 0,
              "state": "UNALLOCATED",
              "hostName": "",
              "createdDate": "2014-11-11T02:25:57.000Z",
              "lastModifiedDate": "2014-11-11T02:25:57.000Z"
            },
          ]
        }
      ],
      "profileType": "PRIVATE",
      "subnetMask": "255.255.255.0",
      "gatewayAddress": "10.118.190.230",
      "dhcpStartIPAddress": null,
      "dhcpEndIPAddress": null,
      "leaseTimeInSeconds": 0
    },
    {
      "@type": "RoutedNetworkProfile",
      "id": "a3dbfc76-7eab-4c1f-8f59-8fcc0b50ec6c",
      "name": "routedTest",
      "description": "",
      "createdDate": "2014-11-11T02:31:11.000Z",
      "lastModifiedDate": "2014-11-11T02:31:11.000Z",
      "isHidden": false,
      "definedRanges": [
        {
          "id": "4d9b291a-841f-4f62-b03e-83781133024c",
          "name": "Range 1",
          "description": "",
          "beginIPv4Address": "10.118.183.1",
          "endIPv4Address": "10.118.183.254",
          "state": "UNALLOCATED",
          "createdDate": "2014-11-11T02:30:34.000Z",
          "lastModifiedDate": "2014-11-11T02:30:34.000Z",
          "definedAddresses": [
            
          ]
        }
      ],
      "profileType": "ROUTED",
      "subnetMask": "255.255.254.0",
      "primaryDnsAddress": "10.110.182.45",
      "secondaryDnsAddress": "",
      "dnsSuffix": "mycompany.com",
      "dnsSearchSuffix": "",
      "primaryWinsAddress": "10.0.0.1",
      "secondaryWinsAddress": "",
      "baseIP": "10.118.183.1"
    },
    {
      "@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"
            },
          ]
        },
        {
          "id": "67acdc6f-d0b9-4f47-a74b-ea58ff9ce074",
          "name": "range2",
          "description": "",
          "beginIPv4Address": "10.110.183.180",
          "endIPv4Address": "10.110.183.183",
          "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": "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"
            },

          ]
        }
      ],
      "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": ""
    }
  ],
  "metadata": {
    "size": 0,
    "totalElements": 4,
    "totalPages": 1,
    "number": 1,
    "offset": 0
  }
}

Input

Use the supported input parameters to control the command output.


Parameter	Description
URL	https://`$vRA`/iaas-proxy-provider/api/network/profiles
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.

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: rel: Specifies the name of the link. `Self` refers to the object that was returned or requested. This parameter does not appear when you query a single profile. `First`, `Previous`, `Next`, and `Last` refer to corresponding pages of pageable lists. Specifies the application or service that determines the other names. href: Specifies the URL that produces the result.
Content		Specifies an array of data rows, each of which represents one of the tenant objects returned in a pageable list. Each tenant object can contain the following information: `@type`: Specifies one of the following network profile type values: ExternalNetworkProfile NATNetworkProfile PrivateNetworkProfile RoutedNetworkProfile `$id`: Specifies the unique network profile identifier. `$name`: Specifies the network profile name. createdDate: Specifies the date and time that the network profile was created. lastModifiedDate: Specifies the date and time that the network profile was last modified. isHidden: Specifies if the network profile is hidden from the vRealize Automation user interface. definedRanges: Specifies the IP range array that is defined for the network profile. profileType: Specifies the network profile type as one of the following types: EXTERNAL NAT ROUTED IPAMEndpointId: If you are creating or querying an external network profile that uses extrernal, IPAM , specifies the endpoint ID for the external IPAM provider. If you are creating a network profile and the profile does not use external IPAM, code null for this value. subnetMask: Specifies the subnet mask. gatewayAddress: Specifies the IP address of the network gateway. primaryDnsAddress: Specifies the IP address of the primary DNS server. This parameter is only available for external, NAT, and routed network profiles. secondaryDnsAddress: Specifies the IP address of a secondary DNS server. This parameter is only available for external, NAT, and routed network profiles. dnsSuffix: Specifies the DNS suffix. This parameter is only available for external, NAT, and routed network profiles. dnsSearchSuffix: Specifies the DNS search suffix. This parameter is only available for external, NAT, and routed network profiles. primaryWinsAddress: Specifies the IP address of the primary Wins server. This parameter is only available for external, NAT, and routed network profiles. secondaryWinsAddress: Specifies the IP address of secondary Wins server. This parameter is only available for external, NAT, and routed network profiles. dhcpStartIPAddress: Specifies the start IP address of the DHCP server. This parameter is only supported by NAT and private network profiles. dhcpEndIPAddress: Specifies the end IP address of the DHCP server. This parameter is only supported by NAT and private network profiles. leaseTimeInSeconds: Specifies the lease time for the DHCP server. This parameter is only supported by NAT and private network profiles. baseIP: Specifies the base IP address. This parameter is only supported by routed network profiles.
Metadata		Specifies the following paging-related data: Size: Specifies the maximum number of rows per page. totalElement: Specifies the number of rows returned. This parameter is not output when you query for a single profile. totalPages: Specifies the total number of pages of data available. Number: Specifies the current page number. Offset: Specifies the number of rows skipped. Size: Specifies the maximum number of rows per page. totalElement: Specifies the number of rows returned. This parameter is not output when you query for a single profile. totalPages: Specifies the total number of pages of data available. Number: Specifies the current page number. Offset: Specifies the number of rows skipped.