OSPFInterface

The OSPF interface represents the connection of a router to the OSPF network. The OSPF interface defines the protocol metrics and security parameters for OSPF traffic on a V-Port on the specified subnet. An OSPF interface can exist in only one OSPF area.

Overview

adminState enum (DOWN | UP) filterable   orderable  
associatedSubnetID string required   filterable   orderable  
authenticationKey string filterable  
authenticationType enum (MESSAGE_DIGEST | NONE | PASSWORD) filterable   orderable  
deadInterval integer filterable  
description string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
helloInterval integer filterable  
interfaceType enum (BROADCAST | POINT_TO_POINT) filterable   orderable  
lastUpdatedBy string autogenerated  
messageDigestKeys list
metric integer filterable   orderable  
mtu integer filterable   orderable  
name string required   filterable   orderable  
passiveEnabled boolean filterable  
priority integer filterable   orderable  

API Resource

/ospfinterfaces/id
delete get put

Parents

/ospfareas/id/ospfinterfaces
get post

Children

/ospfinterfaces/id/metadatas
get post
/ospfinterfaces/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

adminState enum filterable   orderable  
Discussion

Admin state of this OSPF interface


Charateristics

Allowed values: DOWN, UP
Default value: UP
SDK attribute: adminState

associatedSubnetID string required   filterable   orderable  
Discussion

ID of the Subnet which is associated to the current OSPFInterface. Once the OSPF interface is created, the associated subnet ID cannot be updated. The interface must be deleted and re-created with a different subnet ID.


Charateristics

Format: free
SDK attribute: associatedSubnetID

authenticationKey string filterable  
Discussion

The authentication key that is used on the interface.


Charateristics

Format: free
Max length: 8
SDK attribute: authenticationKey

authenticationType enum filterable   orderable  
Discussion

Authentication Type used for this OSPFInterface


Charateristics

Allowed values: MESSAGE_DIGEST, NONE, PASSWORD
Default value: NONE
SDK attribute: authenticationType

deadInterval integer filterable  
Discussion

Time OSPF waits without receiving hello packets before declaring a neighbor down. If specified, it must be at least twice as long as 'helloInterval'.


Charateristics

Default value: 40
Min value: 1
Max value: 65535
SDK attribute: deadInterval

description string
Discussion

Description of this OSPF Interface.


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

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

helloInterval integer filterable  
Discussion

Time interval between OSPF hellos issued on the interface.


Charateristics

Default value: 10
Min value: 1
Max value: 65535
SDK attribute: helloInterval

interfaceType enum filterable   orderable  
Discussion

Can be BROADCAST or POINT_TO_POINT


Charateristics

Allowed values: BROADCAST, POINT_TO_POINT
Default value: BROADCAST
SDK attribute: interfaceType

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

messageDigestKeys list
Discussion

This attribute applies only when 'authenticationType' is 'MESSAGE_DIGEST'. In that case, this attribute is a list of pairs of key ID/password used for MD5 authentication. The key ID must by an integer between 1 and 255, and the value is a password (of 16 charachters maximum) used to generate an MD5 hash. The MD5 has is then used as authentication data in the OSPF packets. No duplicate key IDs are allowed. The format for each pair is 'keyID:password' (e.g. '1:foobar')


Charateristics

SDK attribute: messageDigestKeys

metric integer filterable   orderable  
Discussion

Configure an explicit route cost metric for the interface.


Charateristics

Min value: 1
Max value: 65535
SDK attribute: metric

mtu integer filterable   orderable  
Discussion

MTU to be used by OSPF for this logical interface


Charateristics

Min value: 512
Max value: 9198
SDK attribute: mtu

name string required   filterable   orderable  
Discussion

Name of the OSPF Interface. The name has to be unique within the OSPFArea.


Charateristics

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

passiveEnabled boolean filterable  
Discussion

Enable the passive property of the interface.


Charateristics

Default value: false
SDK attribute: passiveEnabled

priority integer filterable   orderable  
Discussion

Determines which routers are selected as the designated router and backup designated router of the area.


Charateristics

Default value: 1
Max value: 255
SDK attribute: priority