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.
This object has no members.
Admin state of this OSPF interface
Allowed values: DOWN, UP
Default value: UP
SDK attribute: adminState
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.
Format: free
SDK attribute: associatedSubnetID
The authentication key that is used on the interface.
Format: free
Max length: 8
SDK attribute: authenticationKey
Authentication Type used for this OSPFInterface
Allowed values: MESSAGE_DIGEST, NONE, PASSWORD
Default value: NONE
SDK attribute: authenticationType
Enable or disable Bidirectional Forwarding Detection for this OSPF Interface.
Default value: false
SDK attribute: BFDEnabled
Time OSPF waits without receiving hello packets before declaring a neighbor down. If specified, it must be at least twice as long as 'helloInterval'.
Default value: 40
Min value: 1
Max value: 65535
SDK attribute: deadInterval
Description of this OSPF Interface.
Format: free
SDK attribute: description
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.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
Time interval between OSPF hellos issued on the interface.
Default value: 10
Min value: 1
Max value: 65535
SDK attribute: helloInterval
Can be BROADCAST or POINT_TO_POINT
Allowed values: BROADCAST, POINT_TO_POINT
Default value: BROADCAST
SDK attribute: interfaceType
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
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')
SDK attribute: messageDigestKeys
Configure an explicit route cost metric for the interface.
Min value: 1
Max value: 65535
SDK attribute: metric
MTU to be used by OSPF for this logical interface
Min value: 512
Max value: 9198
SDK attribute: mtu
Name of the OSPF Interface. The name has to be unique within the OSPFArea.
Format: free
Min length: 1
Max length: 255
SDK attribute: name
Enable the passive property of the interface.
Default value: false
SDK attribute: passiveEnabled
Determines which routers are selected as the designated router and backup designated router of the area.
Default value: 1
Max value: 255
SDK attribute: priority