IngressAdvFwdEntryTemplate

Security Policy Entries defines what action to take for a particular type of traffic, based on its origin and its destination, its protocol, EtherType, eventual ports, DSCP value and other information.

Overview

ACLTemplateName string
action enum (DROP | FORWARD | FORWARDING_PATH_LIST | REDIRECT | TRANSPARENT) required   filterable   orderable  
addressOverride string filterable   orderable  
addressOverrideType enum (IPV4 | IPV6 | MACRO_GROUP) filterable   orderable  
appType enum (ALL | APPLICATION | NONE) filterable   orderable  
associatedApplicationID string
associatedForwardingPathListID string
associatedLiveEntityID string filterable  
associatedLiveTemplateID string read only  
associatedTrafficType enum (L4_SERVICE | L4_SERVICE_GROUP) filterable   orderable  
associatedTrafficTypeID string
associatedVirtualFirewallRuleID string read only   autogenerated  
description string filterable  
destinationPort string filterable   orderable  
domainName string read only  
DSCP string required   filterable   orderable  
DSCPRemarking string filterable   orderable  
embeddedMetadata list read only   autogenerated  
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  
isSLAAware boolean
lastUpdatedBy string autogenerated  
locationEntityType enum (PGEXPRESSION | PGEXPRESSIONTEMPLATE | POLICYGROUP | POLICYGROUPTEMPLATE | REDIRECTIONTARGET | REDIRECTIONTARGETTEMPLATE | SUBNET | SUBNETTEMPLATE | ZONE | ZONETEMPLATE) read only  
locationID string filterable   orderable  
locationType enum (ANY | PGEXPRESSION | POLICYGROUP | SUBNET | ZONE) required   filterable   orderable  
mirrorDestinationGroupID string
mirrorDestinationID string
networkEntityType enum (PGEXPRESSION | PGEXPRESSIONTEMPLATE | POLICYGROUP | POLICYGROUPTEMPLATE | SUBNET | SUBNETTEMPLATE | ZONE | ZONETEMPLATE) read only  
networkID string filterable   orderable  
networkType enum (ANY | ENDPOINT_DOMAIN | ENDPOINT_SUBNET | ENDPOINT_ZONE | ENTERPRISE_NETWORK | NETWORK_MACRO_GROUP | PGEXPRESSION | POLICYGROUP | PUBLIC_NETWORK | SAAS_APPLICATION_GROUP | SUBNET | UNDERLAY_INTERNET_POLICYGROUP | ZONE) filterable   orderable  
policyState enum (DRAFT | LIVE) filterable   orderable  
priority integer filterable   orderable  
protocol string filterable   orderable  
redirectionTargetEntityType enum (REDIRECTIONTARGET | REDIRECTIONTARGETTEMPLATE) read only  
redirectRewriteType enum (VLAN) locally unique  
redirectRewriteValue string
redirectVPortTagID string filterable   orderable  
remoteUplinkPreference enum (DEFAULT | PRIMARY | PRIMARY_SECONDARY | SECONDARY | SECONDARY_PRIMARY) 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)
vlanRange string
webFilterID string orderable  
webFilterStatsLoggingEnabled boolean filterable   orderable  
webFilterType enum (WEB_CATEGORY | WEB_DOMAIN_NAME) filterable   orderable  

API Resource

/ingressadvfwdentrytemplates/id
delete get put

Parents

/ingressadvfwdentrytemplates
get
/mirrordestinations/id/ingressadvfwdentrytemplates
get
/vports/id/ingressadvfwdentrytemplates
get
/ingressadvfwdtemplates/id/ingressadvfwdentrytemplates
get post

Children

/ingressadvfwdentrytemplates/id/metadatas
get post
/ingressadvfwdentrytemplates/id/globalmetadatas
get post put
/ingressadvfwdentrytemplates/id/statistics
get

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 DROP or FORWARD or REDIRECT or FORWARDING_PATH_LIST. Actions REDIRECT and FORWARDING_PATH_LIST are allowed only for IngressAdvancedForwardingEntry. Possible values are DROP, FORWARD, REDIRECT, FORWARDING_PATH_LIST. If FORWARDING_PATH_LIST is selected in IngressAdvancedForwardingEntry, user will have to attach a ForwardingPathList (list of forwarding action-uplink preference entries) to the ACL.


Charateristics

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

addressOverride string filterable   orderable  
Discussion

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


Charateristics

Format: free
SDK attribute: addressOverride

addressOverrideType enum filterable   orderable  
Discussion

Address Override Type can be IPV4, IPV6 or MACRO_GROUP.


Charateristics

Allowed values: IPV4, IPV6, MACRO_GROUP
SDK attribute: addressOverrideType

appType enum filterable   orderable  
Discussion

Type of application selected, ALL (all applications in match criteria), NONE (no application in match criteria), APPLICATION (specific application in match criteria).


Charateristics

Allowed values: ALL, APPLICATION, NONE
Default value: NONE
SDK attribute: appType

associatedApplicationID string
Discussion

Associated application UUID.


Charateristics

Format: free
Max length: 255
SDK attribute: associatedApplicationID

associatedForwardingPathListID string
Discussion

Associated forwarding path list UUID.


Charateristics

Format: free
Max length: 255
SDK attribute: associatedForwardingPathListID

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 filterable   orderable  
Discussion

This property reflects the type of traffic in case an ACL entry is created using an Service or Service Group. In case a protocol and port are specified for the ACL entry, this property has to be empty (null). Supported values are L4_SERVICE, L4_SERVICE_GROUP and empty.


Charateristics

Allowed values: L4_SERVICE, L4_SERVICE_GROUP
SDK attribute: associatedTrafficType

associatedTrafficTypeID string
Discussion

If a traffic type is specified as Service or Service Group, then the associated Id of Service / Service Group should be specifed here


Charateristics

Format: free
SDK attribute: associatedTrafficTypeID

associatedVirtualFirewallRuleID string read only   autogenerated  
Discussion

The ID of the Virtual Firewall Rule, if this was derived as part of the Virtual Firewall Rule creation


Charateristics

Format: free
SDK attribute: associatedVirtualFirewallRuleID

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

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

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

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

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 Ingress and destination IPv6 for Egress, MAC entries will use this address as the match criteria.


Charateristics

Format: free
SDK attribute: IPv6AddressOverride

isSLAAware 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: isSLAAware

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

locationEntityType enum read only  
Discussion

Indicates whether the Location Entity of ACL Entry was derived from a L2/L3 Domain template or instance. Possible Values: SUBNETTEMPLATE, ZONETEMPLATE, POLICYGROUPTEMPLATE, PGEXPRESSIONTEMPLATE, REDIRECTIONTARGETTEMPLATE, SUBNET, ZONE, POLICYGROUP, PGEXPRESSION, REDIRECTIONTARGET.


Charateristics

Allowed values: PGEXPRESSION, PGEXPRESSIONTEMPLATE, POLICYGROUP, POLICYGROUPTEMPLATE, REDIRECTIONTARGET, REDIRECTIONTARGETTEMPLATE, SUBNET, SUBNETTEMPLATE, ZONE, ZONETEMPLATE
SDK attribute: locationEntityType

locationID string filterable   orderable  
Discussion

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


Charateristics

Format: free
SDK attribute: locationID

locationType enum required   filterable   orderable  
Discussion

Type of the location entity.


Charateristics

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

mirrorDestinationGroupID string
Discussion

ID of the associated Mirror Destination Group.


Charateristics

Format: free
Max length: 255
SDK attribute: mirrorDestinationGroupID

mirrorDestinationID string
Discussion

Destination ID of the mirror destination object.


Charateristics

Format: free
SDK attribute: mirrorDestinationID

networkEntityType enum read only  
Discussion

Indicates whether the Network Entity of ACL Entry was derived from a L2/L3 Domain template or instance. Possible Values: SUBNETTEMPLATE, ZONETEMPLATE, POLICYGROUPTEMPLATE, PGEXPRESSIONTEMPLATE, SUBNET, ZONE, POLICYGROUP, PGEXPRESSION.


Charateristics

Allowed values: PGEXPRESSION, PGEXPRESSIONTEMPLATE, POLICYGROUP, POLICYGROUPTEMPLATE, SUBNET, SUBNETTEMPLATE, ZONE, ZONETEMPLATE
SDK attribute: networkEntityType

networkID string filterable   orderable  
Discussion

The destination network entity 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, NETWORK_MACRO_GROUP, PGEXPRESSION, POLICYGROUP, PUBLIC_NETWORK, SAAS_APPLICATION_GROUP, 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
Format: free
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

redirectionTargetEntityType enum read only  
Discussion

Indicates whether the Redirection Target of ACL Entry was derived from a L3 Domain template or instance. Possible Values: REDIRECTIONTARGET, REDIRECTIONTARGETTEMPLATE.


Charateristics

Allowed values: REDIRECTIONTARGET, REDIRECTIONTARGETTEMPLATE
SDK attribute: redirectionTargetEntityType

redirectRewriteType enum locally unique  
Discussion

The type of redirection rewrite. Currently only VLAN is supported


Charateristics

Allowed values: VLAN
SDK attribute: redirectRewriteType

redirectRewriteValue string
Discussion

The redirect rewrite value. Currently only vlan id is supported


Charateristics

Format: free
SDK attribute: redirectRewriteValue

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

remoteUplinkPreference enum filterable   orderable  
Discussion

Indicates the preferencial path selection for network traffic for this ACL.


Charateristics

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

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

Indicates if stats logging is enabled for this particular template


Charateristics

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

vlanRange string
Discussion

The range can be a single number or a range. Eg : 1,10,15-17


Charateristics

Format: free
SDK attribute: vlanRange

webFilterID string orderable  
Discussion

ID of web filter category or web domain name entity used


Charateristics

Format: free
Max length: 255
SDK attribute: webFilterID

webFilterStatsLoggingEnabled boolean filterable   orderable  
Discussion

Indicates if web filter statistics logging is enabled for this particular template


Charateristics

Default value: false
SDK attribute: webFilterStatsLoggingEnabled

webFilterType enum filterable   orderable  
Discussion

Indicates type of web filter being set


Charateristics

Allowed values: WEB_CATEGORY, WEB_DOMAIN_NAME
SDK attribute: webFilterType