IngressAdvFwdEntryTemplate

Defines the template of Ingress Advanced Forwarding entries

Overview

ACLTemplateName string
action enum (DROP | FORWARD | REDIRECT) required   filterable   orderable  
addressOverride string filterable   orderable  
associatedLiveEntityID string filterable  
description string filterable  
destinationPort string filterable   orderable  
domainName string
DSCP string required   filterable   orderable  
enterpriseName string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
etherType string required   filterable   orderable  
externalID string filterable   orderable   locally unique  
FCOverride enum (A | B | C | D | E | F | G | H | NONE) filterable   orderable  
flowLoggingEnabled boolean filterable   orderable  
ICMPCode string
ICMPType string
IPv6AddressOverride string filterable  
lastUpdatedBy string autogenerated  
locationID string filterable   orderable  
locationType enum (ANY | POLICYGROUP | REDIRECTIONTARGET | SUBNET | VPORTTAG | ZONE) required   filterable   orderable  
mirrorDestinationID string
name string filterable   orderable  
networkID string filterable   orderable  
networkType enum (ANY | ENDPOINT_DOMAIN | ENDPOINT_SUBNET | ENDPOINT_ZONE | ENTERPRISE_NETWORK | INTERNET_POLICYGROUP | NETWORK_MACRO_GROUP | POLICYGROUP | PUBLIC_NETWORK | SUBNET | UNDERLAY_INTERNET_POLICYGROUP | ZONE) filterable   orderable  
policyState enum (DRAFT | LIVE) filterable   orderable  
priority integer filterable   orderable  
protocol string filterable   orderable  
redirectRewriteType enum (VLAN) locally unique  
redirectRewriteValue string
redirectVPortTagID string filterable   orderable  
sourcePort string filterable   orderable  
statsID string filterable   orderable  
statsLoggingEnabled boolean filterable   orderable  
uplinkPreference enum (DEFAULT | PRIMARY | PRIMARY_SECONDARY | SECONDARY | SECONDARY_PRIMARY | SYMMETRIC)
vlanRange string

API Resource

/ingressadvfwdentrytemplates/id
delete get put

Parents

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

Children

/ingressadvfwdentrytemplates/id/metadatas
get post
/ingressadvfwdentrytemplates/id/globalmetadatas
get post put
/ingressadvfwdentrytemplates/id/jobs
post
/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. Action REDIRECT is allowed only for IngressAdvancedForwardingEntry Possible values are DROP, FORWARD, REDIRECT, .

Charateristics

Allowed values: DROP, FORWARD, REDIRECT
Format: free
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

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

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

The name of the enterprise for the domains parent

Charateristics

Format: free
SDK attribute: enterpriseName

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
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

FCOverride enum filterable   orderable  
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  
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

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 location entity (Subnet/Zone/VportTag)

Charateristics

Format: free
SDK attribute: locationID

locationType enum required   filterable   orderable  
Discussion

Type of the location entity.

Charateristics

Allowed values: ANY, POLICYGROUP, REDIRECTIONTARGET, SUBNET, VPORTTAG, ZONE
SDK attribute: locationType

mirrorDestinationID string
Discussion

Destination ID of the mirror destination object.

Charateristics

Format: free
SDK attribute: mirrorDestinationID

name string filterable   orderable  
Discussion

Name of the entity.

Charateristics

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

networkID string filterable   orderable  
Discussion

The destination network entity that is referenced(subnet/zone/macro)

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, 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
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

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

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

vlanRange string
Discussion

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

Charateristics

Format: free
SDK attribute: vlanRange