EgressACLEntryTemplate API Reference 6

EgressACLEntryTemplate

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 \| TRANSPARENT)	required filterable orderable
addressOverride	string	filterable orderable
associatedL7ApplicationSignatureID	string
associatedLiveEntityID	string	filterable
associatedLiveTemplateID	string	read only
associatedTrafficType	enum (L4_SERVICE \| L4_SERVICE_GROUP)	filterable orderable
associatedTrafficTypeID	string
associatedVirtualFirewallRuleID	string	read only autogenerated filterable
description	string	filterable
destinationPort	string	filterable orderable
domainName	string	read only
DSCP	string	required 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
flowLoggingEnabled	boolean	filterable orderable
ICMPCode	string
ICMPType	string
IPv6AddressOverride	string	filterable orderable
lastUpdatedBy	string	autogenerated
locationEntityType	enum (ENTERPRISENETWORK \| NETWORKMACROGROUP \| PGEXPRESSION \| PGEXPRESSIONTEMPLATE \| POLICYGROUP \| POLICYGROUPTEMPLATE \| PUBLICNETWORK \| 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 (ENTERPRISENETWORK \| NETWORKMACROGROUP \| PGEXPRESSION \| PGEXPRESSIONTEMPLATE \| POLICYGROUP \| POLICYGROUPTEMPLATE \| PUBLICNETWORK \| SAASAPPLICATIONGROUP \| SUBNET \| SUBNETTEMPLATE \| ZONE \| ZONETEMPLATE)	read only
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
sourcePort	string	filterable orderable
stateful	boolean	filterable orderable
statsID	string	read only filterable orderable
statsLoggingEnabled	boolean	filterable orderable
webFilterID	string	orderable
webFilterStatsLoggingEnabled	boolean	filterable orderable
webFilterType	enum (WEB_CATEGORY \| WEB_DOMAIN_NAME)	filterable orderable

API Resource

/egressaclentrytemplates/id

delete get put

Parents

/egressaclentrytemplates

get

/mirrordestinations/id/egressaclentrytemplates

get

/vports/id/egressaclentrytemplates

get

/domains/id/egressaclentrytemplates

get

/l2domains/id/egressaclentrytemplates

get

/aggregateddomains/id/egressaclentrytemplates

get

/egressacltemplates/id/egressaclentrytemplates

get post

Children

/egressaclentrytemplates/id/metadatas

get post

/egressaclentrytemplates/id/globalmetadatas

get post put

/egressaclentrytemplates/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.

Charateristics

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

associatedL7ApplicationSignatureID string

Discussion

The UUID of the associated L7 Application signature

Charateristics

Format: free
SDK attribute: associatedL7ApplicationSignatureID

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 filterable

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

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

flowLoggingEnabled boolean filterable orderable

Discussion

Is flow logging enabled for this particular template

Charateristics

SDK attribute: flowLoggingEnabled

ICMPCode string

Discussion

The ICMP Code when selected protocol is ICMP

Charateristics

Format: free
SDK attribute: ICMPCode

ICMPType string

Discussion

The ICMP Type when selected protocol is ICMP

Charateristics

Format: free
SDK attribute: ICMPType

IPv6AddressOverride string filterable orderable

Discussion

Overrides the source IPv6 for Ingress and destination IP 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

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: ENTERPRISENETWORK, NETWORKMACROGROUP, PGEXPRESSION, PGEXPRESSIONTEMPLATE, POLICYGROUP, POLICYGROUPTEMPLATE, PUBLICNETWORK, REDIRECTIONTARGET, REDIRECTIONTARGETTEMPLATE, SUBNET, SUBNETTEMPLATE, ZONE, ZONETEMPLATE.

Charateristics

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

locationID string filterable orderable

Discussion

The ID of the destination endpoint (Subnet/Zone/VportTag/PolicyGroup/PolicyGroupExpression)

Charateristics

Format: free
SDK attribute: locationID

locationType enum required filterable orderable

Discussion

Type of the destination endpoint (Subnet/Zone/VportTag/PolicyGroup/PolicyGroupExpression

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: ENTERPRISENETWORK, NETWORKMACROGROUP, PGEXPRESSION, PGEXPRESSIONTEMPLATE, POLICYGROUP, POLICYGROUPTEMPLATE, PUBLICNETWORK, SAASAPPLICATIONGROUP, SUBNET, SUBNETTEMPLATE, ZONE, ZONETEMPLATE.

Charateristics

Allowed values: ENTERPRISENETWORK, NETWORKMACROGROUP, PGEXPRESSION, PGEXPRESSIONTEMPLATE, POLICYGROUP, POLICYGROUPTEMPLATE, PUBLICNETWORK, SAASAPPLICATIONGROUP, SUBNET, SUBNETTEMPLATE, ZONE, ZONETEMPLATE
SDK attribute: networkEntityType

networkID string filterable orderable

Discussion

The ID of the source endpoint (Subnet/Zone/Macro/MacroGroup/PortGroup/PolicyGroupExpression)

Charateristics

Format: free
SDK attribute: networkID

networkType enum filterable orderable

Discussion

Type of the source endpoint (Subnet/Zone/Macro/MacroGroup/PortGroup/PolicyGroupExpression)

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

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

stateful boolean filterable orderable

Discussion

True means that this ACL entry is stateful, so there will be a corresponding rule that will be created by OVS in the network. False means that there is no corresponding rule created by OVS in the network.

Charateristics

SDK attribute: stateful

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

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