ForwardingPathListEntry

Forwarding path list entry to be associated with forwarding path list for l4 based policy to PAT / IKE to underlay.

Overview

DSCPRemarking string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
FCOverride enum (A | B | C | D | E | F | G | H | NONE)
forwardingAction enum (IKE | OVERLAY | UNDERLAY_PAT | UNDERLAY_ROUTE) required   filterable   orderable  
lastUpdatedBy string autogenerated  
priority integer read only   autogenerated   filterable   orderable  
remoteUplinkPreference enum (DEFAULT | PRIMARY | PRIMARY_SECONDARY | SECONDARY | SECONDARY_PRIMARY) filterable   orderable  
slaAware boolean
uplinkPreference enum (DEFAULT | PRIMARY | PRIMARY_SECONDARY | SECONDARY | SECONDARY_PRIMARY) filterable   orderable  

API Resource

/forwardingpathlistentries/id
delete get put

Parents

/forwardingpathlists/id/forwardingpathlistentries
get post

Children

/forwardingpathlistentries/id/metadatas
get post
/forwardingpathlistentries/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

DSCPRemarking string filterable   orderable  
Discussion

Remarking value for the DSCP field in IP header of customer packet.DSCP value range from enumeration of 65 values: NONE, 0, 1, ..., 63

Charateristics

Default value: None
Format: free
SDK attribute: DSCPRemarking

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

FCOverride enum
Discussion

Value of the Service Class to be overridden in the packet when the match conditions are satisfied.

Charateristics

Allowed values: A, B, C, D, E, F, G, H, NONE
Default value: NONE
SDK attribute: FCOverride

forwardingAction enum required   filterable   orderable  
Discussion

Type of forwarding action associated with this entry.

Charateristics

Allowed values: IKE, OVERLAY, UNDERLAY_PAT, UNDERLAY_ROUTE
SDK attribute: forwardingAction

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

priority integer read only   autogenerated   filterable   orderable  
Discussion

Autogenerated priority of a Forwarding Path List Entry for a given Forwarding Path List.

Charateristics

Min value: 10
Max value: 65535
SDK attribute: priority

remoteUplinkPreference enum filterable   orderable  
Discussion

Indicates the preferencial path selection for network traffic.

Charateristics

Allowed values: DEFAULT, PRIMARY, PRIMARY_SECONDARY, SECONDARY, SECONDARY_PRIMARY
Default value: DEFAULT
SDK attribute: remoteUplinkPreference

slaAware boolean
Discussion

This flag denotes whether the Uplink Preference configured by the user will work with AAR or will over-ride AAR.

Charateristics

Default value: false
SDK attribute: slaAware

uplinkPreference enum filterable   orderable  
Discussion

Type of forwarding uplink preference associated with this entry. In case of forwardingAction "IKE", uplinkPreference must not be set.

Charateristics

Allowed values: DEFAULT, PRIMARY, PRIMARY_SECONDARY, SECONDARY, SECONDARY_PRIMARY
SDK attribute: uplinkPreference