StaticRoute

Static routes allow end users to define how traffic is routed through the dVRS in addition to the routes learned by VSC through VM activation. By using static routes, end users can define for example that all traffic with a destination address towards a specific subnet must be forwarded to a specific VM attached in the dVRS and this VM could be a firewall

Overview

address string filterable   orderable  
associatedFIPDomainID string
associatedGatewayIDs list
associatedSubnetID string
BFDEnabled boolean filterable  
blackHoleEnabled boolean creation only   filterable   orderable  
creationDate string read only   autogenerated   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
IPType enum (IPV4 | IPV6) filterable   orderable  
IPv6Address string filterable   orderable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
netmask string filterable   orderable  
nextHopIp string filterable   orderable  
owner string autogenerated  
routeDistinguisher string filterable   orderable  
type enum (EXIT_DOMAIN | FIP | NETCONF | OVERLAY | OVERLAY_ADDRESS_TRANSLATION)

API Resource

/staticroutes/id
delete get put

Parents

/containerinterfaces/id/staticroutes
get
/sharednetworkresources/id/staticroutes
get post
/staticroutes
get
/vminterfaces/id/staticroutes
get
/domains/id/staticroutes
get post
/l2domains/id/staticroutes
get post
/hostinterfaces/id/staticroutes
get
/aggregateddomains/id/staticroutes
get post

Children

/staticroutes/id/deploymentfailures
get post
/staticroutes/id/permissions
delete get post put
/staticroutes/id/metadatas
get post
/staticroutes/id/globalmetadatas
get post put
/staticroutes/id/eventlogs
get

Members

This object has no members.

Attributes documentation

address string filterable   orderable  
Discussion

IP address of the route

Charateristics

Format: free
SDK attribute: address

associatedFIPDomainID string
Discussion

ID of the associated Secondary FIP Domain. Valid for static route of type FIP.

Charateristics

Format: free
SDK attribute: associatedFIPDomainID

associatedGatewayIDs list
Discussion

List of associated gateway IDs for static route, returned as a JSON list of strings

Charateristics

SDK attribute: associatedGatewayIDs

associatedSubnetID string
Discussion

UUID of Do Not Advertise Subnet

Charateristics

Format: free
SDK attribute: associatedSubnetID

BFDEnabled boolean filterable  
Discussion

Enable or disable Bidirectional Forwarding Detection for this static route

Charateristics

Default value: false
SDK attribute: BFDEnabled

blackHoleEnabled boolean creation only   filterable   orderable  
Discussion

Indicates if this is a black hole static route. Applicable only when the static route type is 'NETCONF'.

Charateristics

Default value: false
SDK attribute: blackHoleEnabled

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

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

IPType enum filterable   orderable  
Discussion

IPv4 or IPv6

Charateristics

Allowed values: IPV4, IPV6
SDK attribute: IPType

IPv6Address string filterable   orderable  
Discussion

IPv6 address of the route

Charateristics

Format: free
SDK attribute: IPv6Address

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

netmask string filterable   orderable  
Discussion

Netmask associated with the route

Charateristics

Format: free
SDK attribute: netmask

nextHopIp string filterable   orderable  
Discussion

IP address of the next hop. This must be a VM attached to the dVRS

Charateristics

Format: free
SDK attribute: nextHopIp

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

routeDistinguisher string filterable   orderable  
Discussion

Route distinguisher associated with the nexthop. System generates this identifier automatically

Charateristics

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

type enum
Discussion

Type flag for static-route provisioning for exit-domain (break-to-underlay) prefixes.

Charateristics

Allowed values: EXIT_DOMAIN, FIP, NETCONF, OVERLAY, OVERLAY_ADDRESS_TRANSLATION
SDK attribute: type