HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/vrfs/{VRF.name}/ospfv3_af4_routers/{OSPF_Router.instance_tag}/areas/{OSPF_Area.area_id}/ospf_vlinks/{OSPF_Vlink.peer_router_id}

Path Params
string
required

Reference Resource: VRF
VRF identifier. Should be alphanumeric. VRF names must be unique.

string
required

Reference Resource: OSPF_Router
The list of all the OSPFv3 Router instances for IPv4 Unicast Address Family.

string
required

Reference Resource: OSPF_Area
The list of all the "OSPF_Area" for the OSPF router instance, which contains the OSPFv2 area related configurations. The Area ID is in IPv4 address format.

string
required

Reference Resource: OSPF_Vlink
The list of all the "OSPF_Vlink" for the OSPF Area, which contains the OSPF Virtual link related configurations. The Peer Router ID is in IPv4 address format.

Body Params
ipsec_ah
object

IPsec Authentication Header (AH) configuration. Specifies Security Parameters Index (SPI), authentication type and key to use. IPsec AH is preferred over IPsec Encapsulating Security Payload (ESP) if both ipsec_ah and ipsec_esp are configured.

ipsec_esp
object

IPsec Encapsulating Security Payload (ESP) configuration. Specifies Security Parameters Index (SPI), encryption/authentication type and key to use. IPsec Authentication Header (AH) is preferred over IPsec ESP if both ipsec_ah and ipsec_esp are configured.

string

Reference Resource: Keychain
The "Keychain" used for cryptographic authentication. Supports MD5, SHA-1, SHA-256, SHA-384 and SHA-512 algorithms. If not set, OSPF keychain authentication is not operational.

ospf_auth_md5_keys
object

The authentication keys for OSPFv2 authentication type "md5" message-digest.

ospf_auth_sha_keys
object

The authentication keys for OSPFv2 authentication type "sha".

string
length ≥ 1

The authentication key for OSPFv2 authentication type "text". If not set, authentication key is not operational.

string
enum

The type of OSPFv2 authentication. If not set, then the area level authentication of the transit area, holds for the port.

other_config
object
string
required

Reference Resource: OSPF_Vlink
The list of all the "OSPF_Vlink" for the OSPF Area, which contains the OSPF Virtual link related configurations. The Peer Router ID is in IPv4 address format.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
Response
Click Try It! to start a request and see the response here!