NSX-T Data Center REST API
Read Logical Router Port (Deprecated)
Returns information about the specified logical router port. Deprecated:Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id> for DOWNLINK
GET /policy/api/v1/infra/segments/<segment-id> for DOWNLINK
Request:
Method:
GET
URI Path(s):
/api/v1/logical-router-ports/{logical-router-port-id}
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
LogicalRouterCentralizedServicePort+
LogicalRouterCentralizedServicePort (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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | 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 |
| enable_netx | Port is exclusively used for N-S service insertion | boolean | Default: "False" |
| id | Unique identifier of this resource | string | Sortable |
| linked_logical_switch_port_id | Reference to the logical switch port to connect to | ResourceReference | |
| logical_router_id | Identifier for logical router on which this port is created | string | Required |
| mtu | Maximum transmission unit (MTU) Maximum transmission unit specifies the size of the largest packet that a network protocol can transmit. If not specified, the global logical MTU set in the /api/v1/global-configs/RoutingGlobalConfig API will be used. |
integer | Minimum: 64 |
| ndra_profile_id | Identifier for NDRA profile on the port Identifier of Neighbor Discovery Router Advertisement profile associated with port. When NDRA profile id is associated at both the port level and logical router level, the profile id specified at port level takes the precedence. |
string | |
| resource_type | Must be set to the value LogicalRouterCentralizedServicePort | LogicalRouterPortResourceType | Required |
| service_bindings | Service Bindings | array of ServiceBinding | |
| subnets | Logical router port subnets | array of IPSubnet | Minimum 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" |
LogicalRouterDownLinkPort+
LogicalRouterDownLinkPort (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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | 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 |
| enable_multicast | Flag to enable/disable Multicast If this flag is set to true - it will enable multicast on the downlink interface. If this flag is set to false - it will disable multicast on the downlink interface. This is supported only on Tier0 downlinks. Default value for Tier0 downlink will be true. |
boolean | |
| id | Unique identifier of this resource | string | Sortable |
| linked_logical_switch_port_id | Reference to the logical switch port to connect to | ResourceReference | |
| logical_router_id | Identifier for logical router on which this port is created | string | Required |
| mac_address | MAC address MAC address |
string | Readonly |
| ndra_prefix_config | Configuration to override the neighbor discovery router advertisement
prefix time parameters at the subnet level. Note that users are allowed to override the prefix time only for IPv6 subnets which are configured on the port. |
array of NDRAPrefixConfig | |
| ndra_profile_id | Identifier for NDRA profile on the port Identifier of Neighbor Discovery Router Advertisement profile associated with port. When NDRA profile id is associated at both the port level and logical router level, the profile id specified at port level takes the precedence. |
string | |
| resource_type | Must be set to the value LogicalRouterDownLinkPort | LogicalRouterPortResourceType | Required |
| routing_policies | Routing policies Routing policies used to specify how the traffic, which matches the policy routes, will be processed. |
array of RoutingPolicy | Maximum items: 1 |
| service_bindings | Service Bindings | array of ServiceBinding | |
| subnets | Logical router port subnets | array of IPSubnet | Required Minimum 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" |
LogicalRouterLinkPortOnTIER0+
LogicalRouterLinkPortOnTIER0 (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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | 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 | Sortable |
| linked_logical_router_port_id | Identifier of connected LogicalRouterLinkPortOnTIER1 Identifier of connected LogicalRouterLinkPortOnTIER1 of TIER1 logical router |
string | Readonly |
| logical_router_id | Identifier for logical router on which this port is created | string | Required |
| mac_address | MAC address MAC address |
string | Readonly |
| resource_type | Must be set to the value LogicalRouterLinkPortOnTIER0 | LogicalRouterPortResourceType | Required |
| service_bindings | Service Bindings | array of ServiceBinding | |
| subnets | Logical router port subnets | array of IPSubnet | Readonly |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
LogicalRouterLinkPortOnTIER1+
LogicalRouterLinkPortOnTIER1 (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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | 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 |
| edge_cluster_member_index | Member index of the edge node on the cluster Please use logical router API to pass edge cluster members indexes manually. |
array of integer | Deprecated |
| id | Unique identifier of this resource | string | Sortable |
| linked_logical_router_port_id | Reference of TIER0 port to connect the TIER1 to. Reference of LogicalRouterLinkPortOnTIER0 of TIER0 logical router to connect this TIER1 logical router outwards. |
ResourceReference | |
| logical_router_id | Identifier for logical router on which this port is created | string | Required |
| mac_address | MAC address MAC address |
string | Readonly |
| resource_type | Must be set to the value LogicalRouterLinkPortOnTIER1 | LogicalRouterPortResourceType | Required |
| service_bindings | Service Bindings | array of ServiceBinding | |
| subnets | Logical router port subnets | array of IPSubnet | Readonly |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | 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 |
| edge_cluster_member_index | Member index of the edge node on the cluster | array of integer | Required |
| id | Unique identifier of this resource | string | Sortable |
| logical_router_id | Identifier for logical router on which this port is created | string | Required |
| resource_type | Must be set to the value LogicalRouterLoopbackPort | LogicalRouterPortResourceType | Required |
| service_bindings | Service Bindings | array of ServiceBinding | |
| subnets | Loopback port subnets | array of IPSubnet | Required Minimum items: 1 |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
LogicalRouterUpLinkPort+
LogicalRouterUpLinkPort (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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | 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 |
| edge_cluster_member_index | Member index of the edge node on the cluster | array of integer | Required |
| id | Unique identifier of this resource | string | Sortable |
| igmp_config | IGMP local group configuration parameters Interface IGMP[Internet Group Management Protocol] local group config parameters. |
InterfaceIgmpLocalGroupConfig | |
| linked_logical_switch_port_id | Reference to the logical switch port to connect to | ResourceReference | |
| logical_router_id | Identifier for logical router on which this port is created | string | Required |
| 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. If not specified, the global logical MTU set in the /api/v1/global-configs/RoutingGlobalConfig API will be used. |
integer | Minimum: 64 |
| ndra_prefix_config | Configuration to override the neighbor discovery router advertisement
prefix time parameters at the subnet level. Note that users are allowed to override the prefix time only for IPv6 subnets which are configured on the port. |
array of NDRAPrefixConfig | |
| ndra_profile_id | Identifier for NDRA profile on the port Identifier of Neighbor Discovery Router Advertisement profile associated with port. When NDRA profile id is associated at both the port level and logical router level, the profile id specified at port level takes the precedence. |
string | |
| pim_config | PIM configuration parameters PIM[Protocol Independent Multicast] configuration parameters. |
InterfacePimConfig | |
| resource_type | Must be set to the value LogicalRouterUpLinkPort | LogicalRouterPortResourceType | Required |
| service_bindings | Service Bindings | array of ServiceBinding | |
| subnets | Logical router port subnets | array of IPSubnet | Required Minimum 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" |