NSX Autonomous Edge REST API

Read Logical Port

Returns information about the specified logical port.

Request:

Method:

GET

URI Path(s):

/ports/{port-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<ip>/api/v1/ports/c84f70b4-7500-4087-bb2d-3f68f5a32060

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalRouterIPTunnelPort+

LogicalRouterIPTunnelPort (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	integer	Readonly
_schema	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
admin_state	Admin state of port Admin state of port.	string	Readonly Enum: UP, DOWN
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Readonly Sortable
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
resource_type	Must be set to the value LogicalRouterIPTunnelPort	LogicalPortResourceType	Required
subnets	Tunnel port subnets Tunnel port subnets.	array of IPSubnet	Required Readonly Minimum items: 1 Maximum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
vpn_session_id	VPN session identifier Associated VPN session identifier.	string	Readonly

LogicalRouterLoopbackPort+

LogicalRouterLoopbackPort (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	integer	Readonly
_schema	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Readonly Sortable
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
resource_type	Must be set to the value LogicalRouterLoopbackPort	LogicalPortResourceType	Required
subnets	Logical router loopback port subnets	array of IPSubnet	Maximum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

LogicalRouterPort+

LogicalRouterPort (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	integer	Readonly
_schema	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
dhcp_server_id	DHCP server ID Specify DHCP server for L2 domain to use. If not given, there is no DHCP service in the L2 domain.	string
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
exit_interface	Exit interface from edge Exit interface from edge	ExitEdgeInterface	Required
id	Unique identifier of this resource	string	Readonly Sortable
l2_extensions	L2 extensions Configuration for extending L2 domain via L2VPN.	array of L2Extension	Minimum items: 1
mac_address	MAC address MAC address	string	Readonly
mtu	Maximum transmission unit (MTU) Maximum transmission unit specifies the size of the largest packet that a network protocol can transmit.	integer	Minimum: 64 Maximum: 9000 Default: "1500"
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
resource_type	Must be set to the value LogicalRouterPort	LogicalPortResourceType	Required
subnets	Logical router port subnets	array of IPSubnet	Maximum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
urpf_mode	Unicast Reverse Path Forwarding mode	UrpfMode	Default: "STRICT"
vlan_id	VLAN for the Logical Switch	integer	Required Minimum: 0 Maximum: 4091

Example Response:

{ "subnets": [ { "ip_addresses": [ "172.16.40.1" ], "prefix_length": 24 } ], "display_name": "lrPort_2", "urpf_mode": "NONE", "vlan_id": 20, "exit_interface": "eth2", "mac_address": "00:50:56:bc:7d:f0", "id": "fe2f90bf-cbd3-41f9-b2f5-8f4dcb9e09e9", "resource_type": "LogicalRouterPort" }

Required Permissions:

read

Feature:

routing_routers

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable