OSPF
Overview
Open Shortest Path First (OSPF): An OSPF is an interior gateway protocol of link states and is used to distribute routing information within a single autonomous system (AS). An OSPF is widely used in a data center network and a campus network.
Inventory
vRouter OSPF Area Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.4.0 | ||
| areaId | The area ID. | 3.4.0 | ||
| authentication | 3.4.0 | |||
| keyId | The key ID when the authentication mode is MD5 checksum. | 3.4.0 | ||
| password | The password when the authentication mode is plaintext. | 3.4.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| groupBy | 3.4.0 | |||
| createDate | The creation date. For more information, see Resource Property. | 3.4.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.4.0 | ||
| type | The type. | 3.4.0 |
vRouter OSPF Network Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.4.0 | ||
| L3NetworkUuid | The L3 network UUID of the VM instance. For more information, see L3 Network. | 3.4.0 | ||
| routerAreaUuid | The router area UUID. | 3.4.0 | ||
| vRouterUuid | The router UUID. | 3.4.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| groupBy | 3.4.0 | |||
| createDate | The creation date. For more information, see Resource Property. | 3.4.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.4.0 |
Operations
CreateVRouterOspfArea
Creates a router OSPF area resource. For
example,
CreateVRouterOspfArea areaId=1Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| areaId | The area ID. | 3.4.0 | ||
| areaAuth | The authentication mode of the OSPF area. | Yes | 3.4.0 | |
| areaType | The area type. | Yes | 3.4.0 | |
| password | The password when the authentication mode is plaintext. | Yes | 3.4.0 | |
| keyId | The key ID when the authentication mode is MD5 checksum. | Yes | 3.4.0 | |
| resourceUuid | The area resource UUID. | Yes | 3.4.0 | |
| tagUuids | The tag UUID list. | Yes | 3.4.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
DeleteVRouterOspfArea
Deletes a router OSPF area. For
example,
DeleteVRouterOspfArea uuid=8c7d2c714e1231549dd2a66a3f140ae5Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.4.0 | ||
| deleteMode | Yes | 3.4.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
GetVRouterOspfNeighbor
Obtains the neighboring information about the OSPF. For
example,
GetVRouterOspfNeighbor vRouterUuid=dfb6151287b632599becfc5716b8c374Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vRouterUuid | The router UUID. | 3.4.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
QueryVRouterOspfArea
Queries information about a router OSPF area. For
example,
QueryVRouterOspfAreaPrimitive Fields of Query
GetVRouterRouterId
Obtains a router ID. For
example,
GetVRouterRouterId vRouterUuid=9b8b08cd553c3fd1ba4efc3e6c98512dParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vRouterUuid | The router UUID. | 3.4.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
Note:
- When you obtain a router ID in ZStack Cloud, you
can obtain the routerID of the router in OSPF by adding the
routeProtocolRouterId option to SystemTags.
- Format of the routeProtocolRouterId option:
routeProtocolRouterId::xxxx - Example:
routeProtocolRouterId::1.1.1.1
- Format of the routeProtocolRouterId option:
SetVRouterRouterId
Sets a router ID. For
example,
SetVRouterRouterId vRouterUuid=9b8b08cd553c3fd1ba4efc3e6c98512d routerId=10.10.10.1Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vRouterUuid | The router UUID. | 3.4.0 | ||
| routerId | The router ID in IP address format. | 3.4.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
Note:
- When you set a router ID in ZStack Cloud, you can
use the routerID of the router in OSPF by adding the
routeProtocolRouterId option to SystemTags.
- Format of the routeProtocolRouterId option:
routeProtocolRouterId::xxxx - Example:
routeProtocolRouterId::1.1.1.1
- Format of the routeProtocolRouterId option:
AddVRouterNetworksToOspfArea
Adds a network to an OSPF area. For
example,
AddVRouterNetworksToOspfArea routerAreaUuid=d397110ba793345797e33bc6ed3db65f vRouterUuid=b02959e102353bfd9fd14a149fa20565 l3NetworkUuids=202258e4c4893f85a6b5baa7b8b55bb0Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| routerAreaUuid | The router area UUID. | 3.4.0 | ||
| vRouterUuid | The VPC vRouter UUID. | 3.4.0 | ||
| l3NetworkUuids | The L3 network UUID. | 3.4.0 | ||
| resourceUuid | The resource UUID. | Yes | 3.4.0 | |
| tagUuids | The tag UUID list. | Yes | 3.4.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
RemoveVRouterNetworksFromOspfArea
Removes a network from a router area. For
example,
RemoveVRouterNetworksFromOspfArea uuids=ad747eefbaf534d4a46822cc02fd329aParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuids | The UUIDs in the network area table. | 3.4.0 | ||
| deleteMode | Yes | 3.4.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
UpdateVRouterOspfArea
Updates the property of a router OSPF area. For
example,
UpdateVRouterOspfArea uuid=b90552421b6a390fa55da5b489a53e32Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.4.0 | ||
| areaAuth | The area authentication mode. | Yes | 3.4.0 | |
| areaType | The area type. | Yes | 3.4.0 | |
| password | The password that is used for area authentication. | Yes | 3.4.0 | |
| keyId | The key ID that is used for area authentication. | Yes | 3.4.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
QueryVRouterOspfNetwork
Queries the network information about the area to which a router is added. For
example,
QueryVRouterOspfNetworkPrimitive Fields of Query
Tags
OSPF Tags
You can create a user tag on OSPF by using resourceType=OSPFVO.
For
example,
CreateUserTag resourceType=OSPFVO tag=OSPF-1 \
resourceUuid=3533e0dcd01d4e2aa8697048e152c5d8