Update OSPF Config (v2.0))

PUT 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/ospfglobalconfigs/:ospf_config_id

Updates an OSPF configuration.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

The site ID.

element_id stringrequired

The element ID.

ospf_config_id stringrequired

The OSPF config ID.

application/json

Body

Details of the ospf config to be updated

cost integer

Cost: Range(max = 65535L, message = OSPF_CONFIG_INVALID_COST, min = 1L)

dead_interval int32

Dead Interval: Range(max = 65535L, error = OSPF_CONFIG_INVALID_DEAD_INTERVAL: Invalid Dead Interval.Value needs to be between 1 and 65535., min = 1L)

hello_interval int32

Hello Interval: Range(max = 65535L, error = OSPF_CONFIG_INVALID_HELLO_INTERVAL: Invalid Hello Interval.Value needs to be between 1 and 65535., min = 1L)

id string

Id

md5_key_id integer

Md5 Key Id: Range(max = 255L, message = OSPF_CONFIG_MD5_KEY_ID_LENGTH_EXCEEDS, min = 1L)

md5_secret string

Md5 Secret: Size(max = 16, error = OSPF_CONFIG_MD5_LENGTH_EXCEEDS: Max length of MD5 secret is 16., min = 1)

prefix_adv_type_to_lan string

Prefix Adv Type To Lan

retransmit_interval int32

Retransmit Interval: Range(max = 65535L, error = OSPF_CONFIG_INVALID_RETRANSMIT_INTERVAL: Invalid retransmit interval.Value needs to be between 1 and 65535., min = 1L)

router_id string

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

transmit_delay int32

Transmit Delay: Range(max = 65535L, error = OSPF_CONFIG_INVALID_TRANSMIT_DELAY: Invalid transmit delay.Value needs to be between 1 and 65535., min = 1L)

Responses

200

Successful Operation

application/json

Schema

Schema

cost integer

The Cost range, which is 1 - 65535.

dead_interval int32

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 int32

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).

id string

The OSPF config ID.

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.

prefix_adv_type_to_lan string

The prefix advertisement type to LAN.

retransmit_interval int32

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).

router_id string

The Router ID. IP address and ION device's OSPF ID.

transmit_delay int32

The length of time an LSA is delayed seconds before being sent out of an interface (range is 1 - 65535; default is 1).

Example (from schema)

{
  "cost": 0,
  "dead_interval": 0,
  "hello_interval": 0,
  "id": "string",
  "md5_key_id": 0,
  "md5_secret": "string",
  "prefix_adv_type_to_lan": "string",
  "retransmit_interval": 0,
  "router_id": "string",
  "transmit_delay": 0
}

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_INVALID_HELLO_INTERVAL"
      },
      {
        "code": "OSPF_CONFIG_INVALID_DEAD_INTERVAL"
      },
      {
        "code": "OSPF_CONFIG_PREFIX_ADV_NOT_SUPPORTED_FOR_HUB"
      },
      {
        "code": "OSPF_CONFIG_INVALID_ROUTER_ID"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      }
    ]
  }
}

Loading...