NextHop

Next-hop address used to leak the routes from source domain onto the destination domain.

Overview

embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
ip string required   filterable   orderable  
IPType enum (DUALSTACK | IPV4 | IPV6) filterable   orderable  
lastUpdatedBy string autogenerated  
routeDistinguisher string filterable   orderable   locally unique  
type enum (BR_PORT | GATEWAY | IP) filterable   orderable  

API Resource

/nexthops/id
delete get put

Parents

/links/id/nexthops
get post put

Children

/nexthops/id/permissions
delete get post put
/nexthops/id/metadatas
get post
/nexthops/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

ip string required   filterable   orderable  
Discussion

This is the /32 or /128 next-hop IP address. Currently we support only IPv4 address family.

Charateristics

Format: free
SDK attribute: ip

IPType enum filterable   orderable  
Discussion

The IP Type of this Nexthop, possible values are IPV4, IPV6 or DUALSTACK.

Charateristics

Allowed values: DUALSTACK, IPV4, IPV6
SDK attribute: IPType

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

routeDistinguisher string filterable   orderable   locally unique  
Discussion

The next-hop's route distinguisher. A unique 8 byte long. If not provided one will be generated.

Charateristics

Min length: 1
Max length: 255
SDK attribute: routeDistinguisher

type enum filterable   orderable  
Discussion

Next hop type: IP only supported for service chaining

Charateristics

Allowed values: BR_PORT, GATEWAY, IP
SDK attribute: type