Listing of VIFs on the NSX Manager

This API lists VIFs from the specified NSX Manager.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/vifs

Request Headers:

n/a

Query Parameters:

VifsOnEPListRequestParams+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
lport_attachment_id	LPort attachment ID of the VIF.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/realized-state/enforcement-points/default/vifs

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

VirtualNetworkInterfaceListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	VirtualNetworkInterface list results	array of VirtualNetworkInterface	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "0036077582cc-1b2e-492b-a546-008e970ddd97nnuullll", "result_count": 23, "results": [ { "resource_type": "VirtualNetworkInterface", "display_name": "Network adapter 1", "device_key": "4000", "device_name": "Network adapter 1", "ip_address_info": [ { "ip_addresses": [ "10.161.65.204", "fd01:0:101:2610:250:56ff:feab:e4be", "fd01:0:101:2610:108e:67da:8759:fffe", "fe80::250:56ff:feab:e4be" ], "source": "VM_TOOLS" } ], "vm_local_id_on_host": "3", "mac_address": "00:50:56:ab:e4:be", "owner_vm_id": "a5732786-a9c1-4139-a4cf-97b97881cb15", "external_id": "a5732786-a9c1-4139-a4cf-97b97881cb15-4000", "host_id": "5875b04c-8e75-11e8-850e-a7ec6eb06bc0", "_last_sync_time": 1532349565124 } ] }

Listing of VIFs on the NSX Manager

Request:

VifsOnEPListRequestParams (schema)

Example Request:

Successful Response:

VirtualNetworkInterfaceListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: