Create OSPF Config (v2.0)

POST 
/sdwan/v2.0/api/sites/:site_id/elements/:element_id/ospfconfigs

Create an OSPF configuration.

Request

Path Parameters

site_id stringrequired

The site ID.

element_id stringrequired

The element ID.

application/json

Body

Details of the OSPF config to be created

areas Area[]
Areas: Valid
Array [
area_id integer
The area over which the OSPF parameters can be applied. Identifier for the area in x.x.x.x format. This is the identifier that each neighbor must accept to be part of the same area.
area_type string
Possible values: [NORMAL, STUB, NSSA]
The OSPF config area type.
]
description string

Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0)

id string

Id

interfaces InterfaceOspfConfig[]
Interfaces: Valid
Array [
area_id integer
Identifier for the area in x.x.x.x format.
interface_id string
Associated area interface ID.
ospf_config_override OspfGlobalConfig
The global config to override the global configurations for the selected interface.
cost integer
The Cost range, which is 1 - 65535.
dead_interval integer
The number of seconds that a neighbor router waits for a hello packet from the device before declaring the router down. range is 1-65535, Default is 40.
hello_interval integer
The interval in seconds at which the OSPF process sends hello packets to its directly connected neighbors (the range is 1 - 65535; the default is 10).
md5_key_id integer
MD5 Key ID between 1 and 255 and an MD5 Secret of up to 16 characters. The MD5 password you specify will be applied to the messages exchanged with the peer.
md5_secret string
The MD5 secret key of 16 characters. The MD5 password specified is applied to the messages exchanged with the peer.
retransmit_interval integer
The length of time, in seconds, that OSPF waits to receive a link-state advertisement (LSA) from a neighbor before retransmitting it (the range is 1 - 65535; the default is 5).
transmit_delay integer
The length of time an LSA is delayed seconds before being sent out of an interface (range is 1 - 65535; default is 1).
]
name stringrequired

Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0)

prefix_adv_route_map_id string

Prefix Adv Route Map Id

prefix_adv_type_to_lan string

Prefix Adv Type To Lan

redistribute_bgp boolean

Redistribute Bgp

redistribute_route_map_id string

Redistribute Route Map Id

router_id string

Router Id: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, message = OSPF_CONFIG_INVALID_ROUTER_ID, type = IP)

scope string

Scope

shutdown boolean

Shutdown

tags string[]

Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\s]+, required = false)

vrf_context_id stringrequired

Vrf Context Id: NotNull(message = OSPF_CONFIG_NO_VRF_CONTEXT)

Responses

200

Successful Operation

application/json

Schema

Schema

areas Area[]
Areas: Valid
Array [
area_id integer
The area over which the OSPF parameters can be applied. Identifier for the area in x.x.x.x format. This is the identifier that each neighbor must accept to be part of the same area.
area_type string
Possible values: [NORMAL, STUB, NSSA]
The OSPF config area type.
]
description string

Description: Size(max = 1024, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0)

id string

Id

interfaces InterfaceOspfConfig[]
Interfaces: Valid
Array [
area_id integer
Identifier for the area in x.x.x.x format.
interface_id string
Associated area interface ID.
ospf_config_override OspfGlobalConfig
The global config to override the global configurations for the selected interface.
cost integer
The Cost range, which is 1 - 65535.
dead_interval integer
The number of seconds that a neighbor router waits for a hello packet from the device before declaring the router down. range is 1-65535, Default is 40.
hello_interval integer
The interval in seconds at which the OSPF process sends hello packets to its directly connected neighbors (the range is 1 - 65535; the default is 10).
md5_key_id integer
MD5 Key ID between 1 and 255 and an MD5 Secret of up to 16 characters. The MD5 password you specify will be applied to the messages exchanged with the peer.
md5_secret string
The MD5 secret key of 16 characters. The MD5 password specified is applied to the messages exchanged with the peer.
retransmit_interval integer
The length of time, in seconds, that OSPF waits to receive a link-state advertisement (LSA) from a neighbor before retransmitting it (the range is 1 - 65535; the default is 5).
transmit_delay integer
The length of time an LSA is delayed seconds before being sent out of an interface (range is 1 - 65535; default is 1).
]
name stringrequired

Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0)

prefix_adv_route_map_id string

Prefix Adv Route Map Id

prefix_adv_type_to_lan string

Prefix Adv Type To Lan

redistribute_bgp boolean

Redistribute Bgp

redistribute_route_map_id string

Redistribute Route Map Id

router_id string

Router Id: IPAddress(allowEmpty = true, allowLinkLocal = false, allowNull = true, bcast = DENY, defaultRoute = false, dnsCheck = false, message = OSPF_CONFIG_INVALID_ROUTER_ID, type = IP)

scope string

Scope

shutdown boolean

Shutdown

tags string[]

Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 1024, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\s]+, required = false)

vrf_context_id stringrequired

Vrf Context Id: NotNull(message = OSPF_CONFIG_NO_VRF_CONTEXT)

Example (from schema)

{
  "areas": [
    {
      "area_id": 0,
      "area_type": "NORMAL"
    }
  ],
  "description": "string",
  "id": "string",
  "interfaces": [
    {
      "area_id": 0,
      "interface_id": "string",
      "ospf_config_override": {
        "cost": 0,
        "dead_interval": 0,
        "hello_interval": 0,
        "md5_key_id": 0,
        "md5_secret": "string",
        "retransmit_interval": 0,
        "transmit_delay": 0
      }
    }
  ],
  "name": "string",
  "prefix_adv_route_map_id": "string",
  "prefix_adv_type_to_lan": "string",
  "redistribute_bgp": true,
  "redistribute_route_map_id": "string",
  "router_id": "string",
  "scope": "string",
  "shutdown": true,
  "tags": [
    "string"
  ],
  "vrf_context_id": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "OSPF_CONFIG_PREFIX_ADV_TYPE_TO_LAN_NOT_SUPPORTED_IN_HUB"
      },
      {
        "code": "OSPF_CONFIG_INVALID_PREFIX_ADV_TO_LAN"
      },
      {
        "code": "OSPF_CONFIG_PREFIX_ADV_ROUTE_MAP_ID_NOT_SUPPORTED"
      },
      {
        "code": "OSPF_CONFIG_PREFIX_ADV_ROUTE_MAP_ID_NOT_FOUND"
      },
      {
        "code": "OSPF_CONFIG_INVALID_REDISTRIBUTE_ROUTE_MAP_ID"
      },
      {
        "code": "OSPF_CONFIG_REDISTRIBUTE_ROUTE_MAP_ID_NOT_FOUND"
      },
      {
        "code": "OSPF_CONFIG_NETWORK_SCOPE_NOT_SUPPORTED_IN_HUB"
      },
      {
        "code": "OSPF_CONFIG_INVALID_NETWORK_SCOPE"
      },
      {
        "code": "OSPF_CONFIG_VRF_CONTEXT_ID_NOT_IN_VRF_PROFILE"
      },
      {
        "code": "OSPF_CONFIG_VRF_CONTEXT_ALREADY_ASSIGNED"
      },
      {
        "code": "OSPF_CONFIG_DUPLICATE_AREA_ID"
      },
      {
        "code": "OSPF_CONFIG_AREA_ID_ZERO_MUST_HAVE_TYPE_NORMAL"
      },
      {
        "code": "OSPF_CONFIG_NO_INTERFACE_ASSIGNED_TO_VRF"
      },
      {
        "code": "OSPF_CONFIG_INVALID_INTERFACE"
      },
      {
        "code": "OSPF_CONFIG_INVALID_INTERFACE_ONLY_SUPPORT_LAN"
      },
      {
        "code": "OSPF_CONFIG_INVALID_INTERFACE_ONLY_SUPPORT_PRIVATE"
      },
      {
        "code": "OSPF_CONFIG_NOT_MATCHING_AREA_ID"
      },
      {
        "code": "OSPF_CONFIG_NEED_BOTH_MD5_KEY_AND_SECRET"
      },
      {
        "code": "OSPF_CONFIG_INVALID_DEAD_INTERVAL_WITH_RESPECT_TO_HELLO_INTERVAL"
      },
      {
        "code": "OSPF_CONFIG_NO_VRF_CONTEXT"
      },
      {
        "code": "OSPF_CONFIG_INVALID_ROUTER_ID"
      },
      {
        "code": "OSPF_CONFIG_INVALID_AREA_TYPE"
      },
      {
        "code": "OSPF_CONFIG_MD5_KEY_ID_LENGTH_EXCEEDS"
      },
      {
        "code": "OSPF_CONFIG_MD5_LENGTH_EXCEEDS"
      },
      {
        "code": "OSPF_CONFIG_INVALID_RETRANSMIT_INTERVAL"
      },
      {
        "code": "OSPF_CONFIG_INVALID_TRANSMIT_DELAY"
      },
      {
        "code": "OSPF_CONFIG_INVALID_HELLO_INTERVAL"
      },
      {
        "code": "OSPF_CONFIG_INVALID_DEAD_INTERVAL"
      }
    ]
  }
}

Loading...