Methods
ReadOSPFv3Configuration
This method returns the existing OSPFv3 configuration in a router, in terms of different OSPFAreas and the set of interfaces in each of them.
Response Example
Following example would illustrate a router with one OSPFArea and 4 enabled interfaces in it.
Code Block |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<ospfService>
<routerId>193.1.190.141</routerId>
<enabledState>ENABLED</enabledState>
<ospfArea>
<areaId>0.0.0.0</areaId>
<ospfProtocolEndpoints>
<ospfProtocolEndpoint>
<name>ge-2/0/0.13</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.1</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.2</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.3</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
</ospfProtocolEndpoints>
</ospfArea>
</ospfService> |
Configures OSPFv3 in the router. By default, OSPFv3 is created but it's in a disable state. It can be enabled with the enableOSPFv3 after you configure all the desired information. Optionally the routerId can be specified when calling this method.
Body Example
Following example would configure OSPFv3 with the routerId 10.10.10.10
Code Block |
---|
theme | Eclipse |
---|
language | html/xml |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<ospfService>
<routerId>10.10.10.10</routerId>
</ospfService> |
ClearOSPFv3Configuration
Removes the whole OSPFv3 configuration from the router.
ActivateOSPFv3
Enables OSPFv3 service in the router.
DeactivateOSPFv3
Disables the OSPF service in the router.
Adds an OSPFv3 area to the router. Optionally it can includes a list of interfaces to add to this area, with their enabled state.
Body Example
Following example would create an OSPFv3 area with id 0.0.0.0 and 4 interfaces in it, all of them enabled.
Code Block |
---|
theme | Eclipse |
---|
language | html/xml |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<ospfArea>
<areaId>0.0.0.0</areaId>
<ospfProtocolEndpoints>
<ospfProtocolEndpoint>
<name>ge-2/0/0.13</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.1</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.2</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.3</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
</ospfProtocolEndpoints>
</ospfArea> |
RemoveOSPFv3Area
Removes an existing OSPFArea from the router.
EnableOSPFv3Interfaces
Enables a list existing OSPFv3 interfaces which are in disable state. It's independent from the area they belong to.
Body Example
Following request would enable interfaces fe-0/3/3.1 and ge-0/1/1.3.
Code Block |
---|
theme | Eclipse |
---|
language | html/xml |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<interfaces>
<interface>fe-0/3/3.1</interface>
<interface>ge-0/1/1.3</interface>
</interfaces> |
DisableOSPv3FInterfaces
Disables a list existing OSPFv3 interfaces which are in enabled state. It's independent from the area they belong to.
Body Example
Following request would disable interface fe-0/3/3.1
Code Block |
---|
theme | Eclipse |
---|
language | html/xml |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<interfaces>
<interface>fe-0/3/3.1</interface>
</interfaces> |