Get Forwarding Path
Get networking entities between two logical ports with VIF attachment
Request
URI
GET
https://nsxmanager.your.domain/api/v1/logical-ports/{lport-id}/forwarding-path
COPY
Path Parameters
string
lport-id
Required
ID of source port
Query Parameters
string
peer_port_id
Required
ID of peer port
Responses
200
Success
Returns PortConnectionEntities of type(s) application/json
{
"hypervisors": [
{
"resource": {
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string"
},
"id": "string",
"pnics": [
{
"uplink_name": "string",
"device_name": "string"
}
],
"pnics_list": [
{
"source": "string",
"admin_status": "string",
"link_status": "string",
"interface_alias": [
{
"ip_configuration": "string",
"netmask": "string",
"ip_address": "string",
"physical_address": "string",
"broadcast_address": "string"
}
],
"interface_type": "string",
"interface_id": "string",
"connected_switch": "string",
"mtu": 0
}
],
"neighbors_list": [
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string",
"ifindex": 0,
"neighbors": [
{
"system_name": "string",
"system_desc": "string",
"system_port_number": 0,
"name": "string",
"oid": "string",
"mgmt_addr": "string",
"capabilities": "string",
"link_aggregation_status": false,
"ifindex": 0,
"mac": "string",
"link_aggregation_capable": false,
"port_desc": "string",
"enabled_capabilities": "string",
"link_aggregation_port_id": "string"
}
],
"mac": "string",
"name": "string"
}
],
"profiles": [
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"required_capabilities": [
"string"
],
"_revision": 0,
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"resource_type": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"_create_user": "string"
}
]
}
],
"errors": [
{
"error_summary": "string",
"entity_type": "string"
}
],
"logical_switches": [
{
"resource": {
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string"
},
"id": "string",
"vm_ports": [
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string",
"logical_switch_id": "string",
"switching_profile_ids": [
{
"value": "string",
"key": "string"
}
],
"attachment": {
"attachment_type": "string",
"id": "string"
},
"admin_state": "string",
"address_bindings": [
{
"vlan": 0,
"ip_address": "string",
"mac_address": "string"
}
]
}
],
"vm_vnics": [
{
"_self": {
"rel": "string"
},
"display_name": "string",
"description": "string",
"_last_sync_time": 0,
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"resource_type": "string",
"mac_address": "string",
"device_key": "string",
"host_id": "string",
"owner_vm_id": "string",
"vm_local_id_on_host": "string",
"external_id": "string",
"lport_attachment_id": "string",
"ip_address_info": [
{
"source": "string",
"ip_addresses": [
"string"
]
}
],
"device_name": "string"
}
],
"router_ports": [
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string",
"logical_switch_id": "string",
"switching_profile_ids": [
{
"value": "string",
"key": "string"
}
],
"attachment": {
"attachment_type": "string",
"id": "string"
},
"admin_state": "string",
"address_bindings": [
{
"vlan": 0,
"ip_address": "string",
"mac_address": "string"
}
]
}
]
}
],
"edge_node_groups": [
{
"resource": {
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string"
},
"id": "string",
"edge_nodes": [
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string",
"host_switches": [
{
"pnics": [
{
"uplink_name": "string",
"device_name": "string"
}
],
"host_switch_name": "string",
"static_ip_pool_id": "string",
"host_switch_profile_ids": [
{
"value": "string",
"key": "string"
}
]
}
],
"host_switch_spec": {
"resource_type": "string"
},
"node_id": "string",
"transport_zone_endpoints": [
{
"transport_zone_id": "string",
"transport_zone_profile_ids": [
{
"profile_id": "string",
"resource_type": "string"
}
]
}
]
}
],
"logical_router_id": "string"
}
],
"routers": [
{
"resource": {
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string"
},
"id": "string",
"uplink_ports": [
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"service_bindings": [
{
"service_id": {
"target_display_name": "string",
"is_valid": false,
"target_id": "string",
"target_type": "string"
}
}
],
"_create_time": 0,
"logical_router_id": "string",
"mac_address": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string"
}
],
"downlink_ports": [
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"service_bindings": [
{
"service_id": {
"target_display_name": "string",
"is_valid": false,
"target_id": "string",
"target_type": "string"
}
}
],
"_create_time": 0,
"logical_router_id": "string",
"mac_address": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string"
}
]
}
],
"vms": [
{
"_self": {
"rel": "string"
},
"display_name": "string",
"description": "string",
"_last_sync_time": 0,
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"resource_type": "string",
"local_id_on_host": "string",
"type": "string",
"power_state": "string",
"compute_ids": [
"string"
],
"host_id": "string",
"external_id": "string"
}
],
"tunnels": [
{
"src_node_id": "string",
"tunnel_properties": {
"status": "string",
"egress_interface": "string",
"name": "string",
"bfd": {
"remote_state": "string",
"remote_diagnostic": "string",
"diagnostic": "string",
"state": "string",
"active": false,
"forwarding": false
},
"local_ip": "string",
"encap": "string",
"remote_ip": "string",
"remote_node_id": "string"
}
}
]
}
default
Unexpected error
Returns ApiError of type(s) application/json
{
"module_name": "string",
"error_message": "string",
"error_code": 0
}string
module_name
Optional
module_name
string
error_message
Optional
error_message
integer As int64 As int64
error_code
Optional
error_code
On This Page
Troubleshooting And Monitoring Operations
POST
Create Port Mirroring Sessions
POST
Create Traceflow
DELETE
Delete Port Mirroring Session
DELETE
Delete Traceflow
GET
Get Forwarding Path
GET
Get Heatmap Transport Zone Status
GET
Get Ipfix Obs Points
GET
Get Port Mirroring Session
GET
Get Switch Ipfix Config
GET
Get Traceflow
GET
Get Traceflow Observations
GET
Get Transport Node Report
GET
Get Transport Node Report For A Transport Zone
GET
Get Transport Node Status
GET
List Node Logs
GET
List Port Mirroring Session
GET
List Remote Transport Node Status
GET
List Traceflows
GET
List Transport Node Status
GET
List Transport Node Status For Transport Zone
GET
Read Node Log
GET
Read Node Log Data
PUT
Update Port Mirroring Session
PUT
Update Switch Ipfix Config
POST
Verify Port Mirroring Session