Skip to end of metadata
Go to start of metadata

About this Resource

The OSPF Config allows the user to configure OSPF protocol on selected network address

REST API Methods for this Resource

Resource Schema


Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ConfigIEStateNoYesEnum1Possible values:
  • 0 - esDISABLED
  • 1 - esENABLED
Specifies the Administrative State of the resource.
OSPFInstanceYesYesstringnone16 - Max Length Specifies OSPF Protocol instance name. OSPF Instance name should not be modified once it is created.
OSPFProcessIDYesYesint1Possible values:
  • 1 - Minimum
  • 65535 - Maximum
Specifies the process ID of the OSPF protocol instance. The process ID is local to the router. Process ID cannot be modified once OSPF instance is created. Process ID should be in the range 1-65535
OSPFRouterIDYesYesstringnone15 - Max Length Specifies OSPF Router ID in IPv4 address format (A.B.C.D). Router ID should not be modified once OSPF instance is created
enableDefaultInfoOriginateYesYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether Default Information Originate feature is to be enabled or disabled.
OSPFAreaIDYesYesstringnone16 - Max Length Specifies OSPF Area ID (A.B.C.D | 0-4294967295). Should be specified in IPv4 address format (A.B.C.D) or as a decimal value in the range (0-4294967295). Area ID cannot be modified once OSPF instance is created
OSPFAreaTypeYesYesEnum0Possible values:
  • 0 - REGULAR
  • 1 - STUB
  • 2 - NSSA
Specifies OSPF area to create. OSPF Area type cannot be modified once OSPF instance is created
ifNameYesYesstringnone500 - Max Length Specifies network address and mask (A.B.C.D/M) of logical interface. If multiple network addresses needs to be configured then the network addresses should be comma separated