OSPFInstance

Represent an OSPF instance. There can be only one OSPF instance per domain.

Overview

associatedExportRoutingPolicyID string filterable   orderable  
associatedImportRoutingPolicyID string filterable   orderable  
description string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
exportLimit integer required   filterable   orderable  
exportToOverlay boolean filterable   orderable  
externalID string filterable   orderable   locally unique  
externalPreference integer filterable   orderable  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
preference integer filterable   orderable  
superBackboneEnabled boolean filterable   orderable  

API Resource

/ospfinstances/id
delete get put

Parents

/domains/id/ospfinstances
get post

Children

/ospfinstances/id/metadatas
get post
/ospfinstances/id/globalmetadatas
get post put
/ospfinstances/id/ospfareas
get post

Members

This object has no members.

Attributes documentation

associatedExportRoutingPolicyID string filterable   orderable  
Discussion

Export OSPF Routing Policy ID


Charateristics

Format: free
SDK attribute: associatedExportRoutingPolicyID

associatedImportRoutingPolicyID string filterable   orderable  
Discussion

Import OSPF Routing Policy ID


Charateristics

Format: free
SDK attribute: associatedImportRoutingPolicyID

description string
Discussion

Description of OSPF Instance


Charateristics

Format: free
SDK attribute: description

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

exportLimit integer required   filterable   orderable  
Discussion

This command configures the maximum number of routes (prefixes) that can be exported into OSPF from the route table.


Charateristics

Min value: 1
Max value: 4294967295
SDK attribute: exportLimit

exportToOverlay boolean filterable   orderable  
Discussion

Flag which determines whether the routes learnt through BGP and OSPF will be exported to VSC or not. This flag also exists in the NSGRoutingPolicyBinding entity. The NSGRoutingPolicyBinding flag takes precedence over this one.


Charateristics

Default value: false
SDK attribute: exportToOverlay

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

externalPreference integer filterable   orderable  
Discussion

Preference for OSPF External Routes.


Charateristics

Default value: 150
Min value: 1
Max value: 255
SDK attribute: externalPreference

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of OSPF Instance


Charateristics

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

preference integer filterable   orderable  
Discussion

Preference for OSPF Internal Routes.


Charateristics

Default value: 10
Min value: 1
Max value: 255
SDK attribute: preference

superBackboneEnabled boolean filterable   orderable  
Discussion

Flag to determine whether SuperBackbone is enabled or not.


Charateristics

Default value: false
SDK attribute: superBackboneEnabled