OSPFInstance

The OSPF instance is the highest hierarchical OSPF configuration object in a domain. The OSPF instance allows you to assign global import and export routing policies for OSPF traffic in the domain.

Overview

associatedExportRoutingPolicyID string filterable  
associatedImportRoutingPolicyID string filterable  
creationDate string read only   autogenerated   orderable  
description string
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
exportLimit integer filterable   orderable  
exportToOverlay boolean filterable  
externalID string filterable   orderable   locally unique  
externalPreference integer filterable   orderable  
IPType enum (IPV4) deprecated   filterable   orderable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable  
OSPFType enum (OSPFv2 | OSPFv3) creation only   filterable   orderable   locally unique  
owner string autogenerated  
preference integer filterable   orderable  
superBackboneEnabled boolean deprecated   filterable  

API Resource

/ospfinstances/id
delete get put

Parents

/domains/id/ospfinstances
get post
/aggregateddomains/id/ospfinstances
get post

Children

/ospfinstances/id/permissions
delete get post put
/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  
Discussion

Export OSPF Routing Policy ID

Charateristics

Format: free
SDK attribute: associatedExportRoutingPolicyID

associatedImportRoutingPolicyID string filterable  
Discussion

Import OSPF Routing Policy ID

Charateristics

Format: free
SDK attribute: associatedImportRoutingPolicyID

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string
Discussion

Description of OSPF Instance

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

exportLimit integer 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  
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
Max value: 255
SDK attribute: externalPreference

IPType enum deprecated   filterable   orderable  
Discussion

The IP Type of the OSPF Instance, currently only IPv4 is supported.

Charateristics

Allowed values: IPV4
Default value: IPV4
SDK attribute: IPType

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string required   filterable   orderable  
Discussion

Name of OSPF Instance

Charateristics

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

OSPFType enum creation only   filterable   orderable   locally unique  
Discussion

Type of the OSPF protocol, possible values are OSPFv2 and OSPFv3.

Charateristics

Allowed values: OSPFv2, OSPFv3
Default value: OSPFv2
SDK attribute: OSPFType

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

preference integer filterable   orderable  
Discussion

Preference for OSPF Internal Routes.

Charateristics

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

superBackboneEnabled boolean deprecated   filterable  
Discussion

Flag to determine whether SuperBackbone is enabled or not.

Charateristics

Default value: false
SDK attribute: superBackboneEnabled