List VIfs On Enforcement Point
This API lists VIFs from the specified NSX Manager.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/vifs
Parameters
Parameters
string
enforcement-point-name
Required
Not available
Query Parameters
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
included_fields
Optional
Comma separated list of fields that should be included in query result
string
lport_attachment_id
Optional
LPort attachment ID of the VIF.
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
Not available
string
sort_by
Optional
Field by which records are sorted
Response
Response
Response BodyResponse Body
200 OK returns
VirtualNetworkInterfaceListResult
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"results": [
{
"_last_sync_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"description": "string",
"device_key": "string",
"device_name": "string",
"display_name": "string",
"external_id": "string",
"host_id": "string",
"ip_address_info": [
{
"ip_addresses": [
"string"
],
"source": "string"
}
],
"lport_attachment_id": "string",
"mac_address": "string",
"owner_vm_id": "string",
"owner_vm_type": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"vm_local_id_on_host": "string"
}
],
"sort_ascending": false,
"sort_by": "string"
}
array of
ResourceLink
_links
Optional
The server will populate this field when returing the resource. Ignored on PUT and POST.
string
_schema
Optional
Schema for this resource
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
integer
result_count
Optional
Count of results found (across all pages), set only on first page
boolean
sort_ascending
Optional
If true, results are sorted in ascending order
string
sort_by
Optional
Field by which records are sorted
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/vifs
Errors
Not available
400
The request cannot be fulfilled due to bad syntax.
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
503
The server is currently unavailable (because it is overloaded or down for maintenance).
