IngressAdvFwdTemplate

Create a table for ingress forwarding policy rules. These include flow redirect rules and forwarding class override rules.

Overview

active boolean filterable   orderable  
associatedLiveEntityID string filterable  
autoGeneratePriority boolean creation only   filterable   orderable  
defaultAllowIP boolean filterable   orderable  
defaultAllowNonIP boolean filterable   orderable  
description string filterable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string filterable   orderable  
policyState enum (DRAFT | LIVE) filterable   orderable  
priority integer filterable   orderable  
priorityType enum (BOTTOM | NONE | TOP) filterable   orderable  

API Resource

/ingressadvfwdtemplates/id
delete get put

Parents

/domains/id/ingressadvfwdtemplates
get post
/l2domains/id/ingressadvfwdtemplates
get post
/aggregateddomains/id/ingressadvfwdtemplates
get post
/l2domaintemplates/id/ingressadvfwdtemplates
get post
/domaintemplates/id/ingressadvfwdtemplates
get post

Children

/ingressadvfwdtemplates/id/metadatas
get post
/ingressadvfwdtemplates/id/globalmetadatas
get post put
/ingressadvfwdtemplates/id/ingressadvfwdentrytemplates
get post
/ingressadvfwdtemplates/id/jobs
get post

Members

This object has no members.

Attributes documentation

active boolean filterable   orderable  
Discussion

If enabled, it means that this ACL or QOS entry is active

Charateristics

Format: free
SDK attribute: active

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

autoGeneratePriority boolean creation only   filterable   orderable  
Discussion

This option affects how ACL entry priorities are generated when not specified. If 'false', the priority is generated by incrementing the current highest priority by 100. If 'true', a random priority will be generated, which is advised when creating many entries concurrently without specifying the priority. This will cause the ACL entry to be randomly placed in the existing list of ACL entries. Therefore it is advised to only enable this when allow rules are being created.

Charateristics

SDK attribute: autoGeneratePriority

defaultAllowIP boolean filterable   orderable  
Discussion

If enabled a default ACL of Allow All is added as the last entry in the list of ACL entries

Charateristics

SDK attribute: defaultAllowIP

defaultAllowNonIP boolean filterable   orderable  
Discussion

If enabled, non ip traffic will be dropped

Charateristics

SDK attribute: defaultAllowNonIP

description string filterable  
Discussion

A description of the entity

Charateristics

Format: free
Max length: 255
SDK attribute: description

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string filterable   orderable  
Discussion

The name of the entity

Charateristics

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

policyState enum filterable   orderable  
Discussion

None

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

SDK attribute: priority

priorityType enum filterable   orderable  
Discussion

Possible values: TOP, BOTTOM or NONE. TOP and BOTTOM ACL policies can only be defined and managed on the template level, NONE can be used on both the template and instantiated level. These allow for careful control of ACL priority handling.

Charateristics

Allowed values: BOTTOM, NONE, TOP
SDK attribute: priorityType