BGPProfile

Definitions for default import/export routing policies and dampening profiles

Overview

associatedExportRoutingPolicyID string filterable  
associatedImportRoutingPolicyID string filterable  
dampeningHalfLife integer filterable   orderable  
dampeningMaxSuppress integer filterable   orderable  
dampeningName string filterable   orderable  
dampeningReuse integer filterable   orderable  
dampeningSuppress integer filterable   orderable  
description string
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
name string required   creation only   filterable   orderable  

API Resource

/bgpprofiles/id
delete get put

Parents

/enterprises/id/bgpprofiles
get post
/bgpprofiles
get

Children

/bgpprofiles/id/metadatas
get post
/bgpprofiles/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedExportRoutingPolicyID string filterable  
Discussion

export BGP policy ID


Charateristics

Format: free
SDK attribute: associatedExportRoutingPolicyID

associatedImportRoutingPolicyID string filterable  
Discussion

import BGP policy ID


Charateristics

Format: free
SDK attribute: associatedImportRoutingPolicyID

dampeningHalfLife integer filterable   orderable  
Discussion

The time in minutes to wait before decrementing dampening penalty.


Charateristics

Default value: 15
Min value: 1
Max value: 45
SDK attribute: dampeningHalfLife

dampeningMaxSuppress integer filterable   orderable  
Discussion

The maximum duration in minutes that a route will be suppressed.


Charateristics

Default value: 60
Min value: 1
Max value: 720
SDK attribute: dampeningMaxSuppress

dampeningName string filterable   orderable  
Discussion

Name for the dampening profile. Unique per enterprise


Charateristics

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

dampeningReuse integer filterable   orderable  
Discussion

This value is compared with penalty to determine route reusability, If the penalty is greater than the suppress limit, the route will be suppressed; if not, it will be reused.


Charateristics

Default value: 750
Min value: 1
Max value: 20000
SDK attribute: dampeningReuse

dampeningSuppress integer filterable   orderable  
Discussion

Specifies the penalty that will be used if a route is suppressed.


Charateristics

Default value: 3000
Min value: 1
Max value: 20000
SDK attribute: dampeningSuppress

description string
Discussion

The description of the BGP Profile


Charateristics

Format: free
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

name string required   creation only   filterable   orderable  
Discussion

Per enterprise unique name


Charateristics

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