EgressAdvFwdEntryTemplate

Egress forwarding policy rules define what action to take for a particular type of traffic, based on its origin, destination, protocol, EtherType, ports, DSCP value and other information. Supported actions are to redirect traffic, change the forwarding class of the traffic or to allow traffic to pass untouched.

Overview

ACLTemplateName string
action enum (DROP | FORWARD | REDIRECT) required   filterable   orderable  
addressOverride string filterable   orderable  
associatedLiveEntityID string filterable  
associatedLiveTemplateID string read only  
associatedTrafficType enum (L4_SERVICE | L4_SERVICE_GROUP) read only   filterable   orderable  
associatedTrafficTypeID string read only  
description string filterable  
destinationPort string filterable   orderable  
domainName string read only  
DSCP string required   filterable   orderable  
enterpriseName string read only  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
etherType string required   filterable   orderable  
externalID string filterable   orderable   locally unique  
failsafeDatapath enum (FAIL_TO_BLOCK | FAIL_TO_WIRE) filterable   orderable  
FCOverride enum (A | B | C | D | E | F | G | H | NONE)
flowLoggingEnabled boolean filterable   orderable  
ICMPCode string
ICMPType string
IPv6AddressOverride string filterable   orderable  
lastUpdatedBy string autogenerated  
locationID string filterable   orderable  
locationType enum (ANY | PGEXPRESSION | POLICYGROUP | SUBNET | ZONE) required   filterable   orderable  
mirrorDestinationID string
networkID string filterable   orderable  
networkType enum (ANY | ENDPOINT_DOMAIN | ENDPOINT_SUBNET | ENDPOINT_ZONE | ENTERPRISE_NETWORK | INTERNET_POLICYGROUP | NETWORK_MACRO_GROUP | PGEXPRESSION | POLICYGROUP | PUBLIC_NETWORK | SUBNET | UNDERLAY_INTERNET_POLICYGROUP | ZONE) filterable   orderable  
policyState enum (DRAFT | LIVE) filterable   orderable  
priority integer filterable   orderable  
protocol string filterable   orderable  
redirectVPortTagID string filterable   orderable  
sourcePort string filterable   orderable  
statsID string read only   filterable   orderable  
statsLoggingEnabled boolean filterable   orderable  
uplinkPreference enum (DEFAULT | PRIMARY | PRIMARY_SECONDARY | SECONDARY | SECONDARY_PRIMARY | SYMMETRIC)
webFilterID string orderable  
webFilterType enum (WEB_CATEGORY | WEB_DOMAIN_NAME) filterable   orderable  

API Resource

/egressadvfwdentrytemplates/id
delete get put

Parents

/egressadvfwdtemplates/id/egressadvfwdentrytemplates
get post
/egressadvfwdentrytemplates
get

Children

/egressadvfwdentrytemplates/id/metadatas
get post
/egressadvfwdentrytemplates/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

ACLTemplateName string
Discussion

The name of the parent Template for this acl entry

Charateristics

Format: free
SDK attribute: ACLTemplateName

action enum required   filterable   orderable  
Discussion

The action of the ACL entry. Possible values are DROP, FORWARD, REDIRECT. Action REDIRECT is allowed only for EgressAdvancedForwardingEntry.

Charateristics

Allowed values: DROP, FORWARD, REDIRECT
SDK attribute: action

addressOverride string filterable   orderable  
Discussion

Overrides the source IP for Egress and destination IP for Ingress, mac entries will use this address as the match criteria.

Charateristics

Format: free
SDK attribute: addressOverride

associatedLiveEntityID string filterable  
Discussion

In the draft mode, the ACL entry refers to this LiveEntity. In non-drafted mode, this is null.

Charateristics

Format: free
SDK attribute: associatedLiveEntityID

associatedLiveTemplateID string read only  
Discussion

In the draft mode, the ACL entity refers to this live entity parent. In non-drafted mode, this is null

Charateristics

Format: free
SDK attribute: associatedLiveTemplateID

associatedTrafficType enum read only   filterable   orderable  
Discussion

The associated Traffic type. L4 Service / L4 Service Group

Charateristics

Allowed values: L4_SERVICE, L4_SERVICE_GROUP
SDK attribute: associatedTrafficType

associatedTrafficTypeID string read only  
Discussion

The associated Traffic Type ID

Charateristics

Format: free
SDK attribute: associatedTrafficTypeID

description string filterable  
Discussion

Description of the ACL entry

Charateristics

Format: free
SDK attribute: description

destinationPort string filterable   orderable  
Discussion

The destination port to be matched if protocol is UDP or TCP. Value should be either * or single port number or a port range

Charateristics

Format: free
Max length: 255
SDK attribute: destinationPort

domainName string read only  
Discussion

The name of the domain/domain template for the aclTemplateNames parent

Charateristics

Format: free
SDK attribute: domainName

DSCP string required   filterable   orderable  
Discussion

DSCP match condition to be set in the rule. It is either * or from 0-63

Charateristics

Format: free
SDK attribute: DSCP

enterpriseName string read only  
Discussion

The name of the enterprise for the domains parent

Charateristics

Format: free
SDK attribute: enterpriseName

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

etherType string required   filterable   orderable  
Discussion

Ether type of the packet to be matched. etherType can be * or a valid hexadecimal value

Charateristics

Format: free
SDK attribute: etherType

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

failsafeDatapath enum filterable   orderable  
Discussion

Backup datapath option if VNF/VM is down

Charateristics

Allowed values: FAIL_TO_BLOCK, FAIL_TO_WIRE
Default value: FAIL_TO_BLOCK
SDK attribute: failsafeDatapath

FCOverride enum
Discussion

Value of the Service Class to be overridden in the packet when the match conditions are satisfied Possible values are NONE, A, B, C, D, E, F, G, H, .

Charateristics

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

flowLoggingEnabled boolean filterable   orderable  
Discussion

Is flow logging enabled for this particular template

Charateristics

Format: free
SDK attribute: flowLoggingEnabled

ICMPCode string
Discussion

The ICMP Code when protocol selected is ICMP.

Charateristics

Format: free
SDK attribute: ICMPCode

ICMPType string
Discussion

The ICMP Type when protocol selected is ICMP.

Charateristics

Format: free
SDK attribute: ICMPType

IPv6AddressOverride string filterable   orderable  
Discussion

Overrides the source IPv6 for Egress and destination IPv6 for Egress, mac entries will use this address as the match criteria.

Charateristics

Format: free
SDK attribute: IPv6AddressOverride

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

locationID string filterable   orderable  
Discussion

The ID of the destination location entity (Subnet/Zone/VportTag/PolicyGroupExpression)

Charateristics

Format: free
SDK attribute: locationID

locationType enum required   filterable   orderable  
Discussion

Type of the destination location entity.

Charateristics

Allowed values: ANY, PGEXPRESSION, POLICYGROUP, SUBNET, ZONE
SDK attribute: locationType

mirrorDestinationID string
Discussion

Destination ID of the mirror destination object.

Charateristics

Format: free
SDK attribute: mirrorDestinationID

networkID string filterable   orderable  
Discussion

The source network entity id that is referenced(subnet/zone/macro/PolicyGroupExpression)

Charateristics

Format: free
SDK attribute: networkID

networkType enum filterable   orderable  
Discussion

Type of the source network.

Charateristics

Allowed values: ANY, ENDPOINT_DOMAIN, ENDPOINT_SUBNET, ENDPOINT_ZONE, ENTERPRISE_NETWORK, INTERNET_POLICYGROUP, NETWORK_MACRO_GROUP, PGEXPRESSION, POLICYGROUP, PUBLIC_NETWORK, SUBNET, UNDERLAY_INTERNET_POLICYGROUP, ZONE
SDK attribute: networkType

policyState enum filterable   orderable  
Discussion

State of the policy. Possible values are DRAFT, LIVE, .

Charateristics

Allowed values: DRAFT, LIVE
SDK attribute: policyState

priority integer filterable   orderable  
Discussion

The priority of the ACL entry that determines the order of entries

Charateristics

Format: free
SDK attribute: priority

protocol string filterable   orderable  
Discussion

Protocol number that must be matched

Charateristics

Format: free
SDK attribute: protocol

redirectVPortTagID string filterable   orderable  
Discussion

VPort tag to which traffic will be redirected to, when ACL entry match criteria succeeds

Charateristics

Format: free
SDK attribute: redirectVPortTagID

sourcePort string filterable   orderable  
Discussion

Source port to be matched if protocol is UDP or TCP. Value can be either * or single port number or a port range

Charateristics

Format: free
Max length: 255
SDK attribute: sourcePort

statsID string read only   filterable   orderable  
Discussion

The statsID that is created in the VSD and identifies this ACL Template Entry. This is auto-generated by VSD

Charateristics

Format: free
SDK attribute: statsID

statsLoggingEnabled boolean filterable   orderable  
Discussion

Is stats logging enabled for this particular template

Charateristics

Format: free
SDK attribute: statsLoggingEnabled

uplinkPreference enum
Discussion

Indicates the preferencial path selection for network traffic for this ACL - default is DEFAULT when the attribute is applicable.

Charateristics

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

webFilterID string orderable  
Discussion

ID of web filter category or web domain name entity used

Charateristics

Format: free
Max length: 255
SDK attribute: webFilterID

webFilterType enum filterable   orderable  
Discussion

Indicates type of web filter being set

Charateristics

Allowed values: WEB_CATEGORY, WEB_DOMAIN_NAME
SDK attribute: webFilterType