Create a Logical Router Port

Creates a logical router port. The required parameters include resource_type
(LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort,
LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); and
logical_router_id (the router to which each logical router port is assigned).
The service_bindings parameter is optional.

Request:

Method:

POST

URI Path(s):

/api/v1/logical-router-ports

Request Headers:

n/a

Query Parameters:

n/a

Request 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"

Example Request:

POST https://<nsx-mgr>/api/v1/logical-router-ports { "resource_type": "LogicalRouterDownLinkPort", "logical_router_id": "723c1e3e-c82c-4243-bba0-2e1ef4815143", "linked_logical_switch_port_id": { "target_type": "LogicalPort", "target_id": "18691381-b08f-4d90-8c0c-98d0e449b141" }, "subnets": [ { "ip_addresses": [ "172.16.40.1" ], "prefix_length": 24 } ] }

Successful Response:

Response Code:

201 Created

Response Headers:

Location
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"

Example Response:

{ "resource_type": "LogicalRouterLinkPort", "_revision": 0, "id": "4a0d8003-0958-4911-a32b-3a5a51f18d95", "logical_router_id": "7a62a0c5-1ea1-4b25-9d43-dce1c0fa4b8c", "resource_type": "LogicalRouterDownLinkPort", "id": "b5ceef62-cc10-424a-96ed-8c2d5989cd50", "display_name": "b5ceef62-cc10-424a-96ed-8c2d5989cd50", "logical_router_id": "723c1e3e-c82c-4243-bba0-2e1ef4815143", "mac_address": "02:50:56:56:44:52", "linked_logical_switch_port_id": { "target_display_name": "db2-switch-to-t1-router", "is_valid": true, "target_type": "LogicalPort", "target_id": "18691381-b08f-4d90-8c0c-98d0e449b141" }, "subnets": [ { "ip_addresses": [ "172.16.40.1" ], "prefix_length": 24 } ], "_last_modified_time": 1458848284438, "_create_time": 1458848284438, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 0 }

Create a Logical Router Port

Request:

LogicalRouterCentralizedServicePort (schema)

LogicalRouterDownLinkPort (schema)

LogicalRouterLinkPortOnTIER0 (schema)

LogicalRouterLinkPortOnTIER1 (schema)

LogicalRouterLoopbackPort (schema)

LogicalRouterUpLinkPort (schema)

Example Request:

Successful Response:

LogicalRouterCentralizedServicePort (schema)

LogicalRouterDownLinkPort (schema)

LogicalRouterLinkPortOnTIER0 (schema)

LogicalRouterLinkPortOnTIER1 (schema)

LogicalRouterLoopbackPort (schema)

LogicalRouterUpLinkPort (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: