ospfRouteInfos

是

REFERENCE

详细请参见表2。

OSPF路由信息。

-

routes

否

ARRAY_REFERENCE

1-8个列表项，详细请参见表3。

OSPF路由信息。

-

siteId

是

uuid

-

-

对应站点ID。格式是uuid，创建时必填。

"fbb684c8-0d37-496f-bafa-4b06d515j7l6"

deviceId

是

uuid

-

-

设备ID。格式是uuid，创建时必填。

"fbb684c8-0d37-496f-bafa-4b06d515j7l6"

vpnId

否

uuid

-

-

所在VPN ID。格式是uuid，创建overlay ospf路由时必填。

"fbb684c8-0d37-496f-bafa-4b06d515j7l6"

tnpId

否

uuid

-

-

所在TNP ID。格式是uuid，创建underlay ospf路由时必填。

"fbb684c8-0d37-496f-bafa-4b06d515j7l6"

routerId

否

string

-

-

用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。

"192.168.1.1"

processId

是

int32

[1-65535]

-

进程号。创建时必填。EVPN隧道模式下，Underlay场景，取值范围20001-30000；Overlay场景，取值范围：1-20000。

501

defaultRouteAdvertisement

否

boolean

• true

• false

false

是否开启通告默认路由。创建时必填。

false

defaultRouteCost

否

int32

[0-16777214]

1

默认路由开销。开启通告默认路由时必填。

1

defaultRouteType

否

int32

-

2

OSPF通告默认路由时的外部路由类型,开启通告默认路由时必填,取值范围1-2，Type1外部路由表示此类路由的可信度高，Type2外部路由表示此类路由的可信度低。

1

internalPreference

否

int32

[1-255]

10

内部优先级。创建时必填。

10

asePreference

否

int32

[1-255]

150

ASE优先级。创建时必填。

150

routeRedistribute

否

ARRAY_REFERENCE

0-64个列表项，详细请参见表4。

路由引入。

-

asbrSummarys

否

ARRAY_REFERENCE

0-64个列表项，详细请参见表5。

边界路由聚合列表。

-

exportRoutePolicy

否

REFERENCE

详细请参见表6。

发布路由策略

-

importRoutePolicy

否

REFERENCE

详细请参见表6。

接收路由策略

-

ipSubnets

否

ARRAY_REFERENCE

0-64个列表项，详细请参见表13。

三层接口参数。仅创建overlay ospf时填入三层接口参数。

-

transportNetworkPorts

否

ARRAY_REFERENCE

0-64个列表项，详细请参见表13。

TNP接口参数。仅创建underlay ospf时填入TNP接口参数。

-

configSource

否

string

0~32个字符。

-

配置源信息，用于区分是WAN业务还是LanWan互联业务，仅查询接口使用，不能修改，取值范围：Wan、LanWan。

"Wan"

type

是

string

0~16个字符。

-

取值范围：BGP、OSPF、DIRECT、STATIC、OPR(V600系列设备支持)、UNR(V300系列设备支持)。对于lan侧ospf，会默认引入BGP，且无法删除。

"BGP"

processId

否

int32

[1-65535]

-

引用的OSPF进程号，引入路由类型为ospf时必填。EVPN隧道模式下，Underlay场景，取值范围20001-30000；Overlay场景，取值范围：1-20000。

501

cost

否

int32

[0-16777214]

1

开销。

1

externalRouteType

否

int32

-

2

设置引入外部路由的路由类型。取值范围1-2，Type1外部路由表示此类路由的可信度高，Type2外部路由表示此类路由的可信度低。

1

ipAddress

否

string

-

-

指定聚合路由的IP地址，ipv4地址加掩码。必填。

"10.1.0.0/16"

cost

否

int32

[0-16777214]

-

聚合路由的开销。

0

tag

否

int64

[0-4294967295]

-

指定聚合路由的标记。

1

distributeDelay

否

int32

[1-65535]

-

指定延迟发布聚合路由的时间。

1

advertise

否

boolean

• true

• false

true

设置是否发布聚合路由。如果不指定该参数则将通告聚合路由。

true

generateNull0Route

否

boolean

• true

• false

false

生成黑洞路由，用来防止路由环路。该字段只有在advertise字段为true时才生效。

false

nodes

否

ARRAY_REFERENCE

0-100个列表项，详细请参见表7。

export方向permit节点支持多个，import方向最多只有一个。更新ospf时，如果node长度为0，则代表删除对应的路由策略。

-

mode

是

string

0~16个字符。

-

节点匹配模式，取值为permit或deny。

"permit"

matchCondition

否

REFERENCE

详细请参见表8。

路由策略匹配条件，至少填写一个匹配条件。

-

applyAction

否

REFERENCE

详细请参见表11。

路由策略应用的行为。

-

ipPrefix

否

REFERENCE

详细请参见表9。

IP前缀。

-

tag

否

int64

[0-4294967295]

-

指定路由信息标记值。

100

prefixFilters

是

ARRAY_REFERENCE

0-100个列表项，详细请参见表10。

前缀过滤器。

-

ipv4Address

是

string

-

-

IP地址。必填。

"10.1.0.0"

maskLength

是

int8

[0-32]

-

掩码。必填。

24

greaterEqual

否

int8

[0-32]

-

掩码范围下限。

24

lessEqual

否

int8

[0-32]

-

掩码范围上限。

24

applyMetric

否

REFERENCE

详细请参见表12。

路由策略应用Metric值。

-

localPreference

否

int64

[0-4294967295]

-

本地优先级。

100

preferredValue

否

int64

[0-65535]

-

首选值。

100

applyTag

否

int64

[0-4294967295]

-

指定路由信息标记值。

100

cost

否

string

-

-

路由开销值，取值范围0-4294967295。只在underlay ospf发布策略的白名单生效。

"24"

sign

否

string

-

-

add表示增加开销值，sub表示减小开销值。该字段暂未实现。

"add"

interfaceType

否

string

0~64个字符。

-

接口类型，非必填，默认为IPSUBNET口，可选值：tunnel。

"tunnel"

interfaceId

是

uuid

-

-

IP Subnet ID或TNP ID。格式是uuid。

"fbb684c8-0d37-496f-bafa-4b06d515j7l6"

areaId

是

string

-

-

区域ID，取值范围0-4294967295。

"0"

areaType

否

string

0~10个字符。

-

区域类型。取值：normal（缺省情况下，OSPF区域被定义为普通区域）、stub（不允许发布自治系统外部路由，只允许发布区域内路由和区域间的路由）、nssa（NSSA区域能够将自治域外部路由引入并传播到整个OSPF自治域中）。

"normal"

authMode

是

string

0~16个字符。

none

认证方式。取值：none、simple、cryptographic。

"none"

cryptographicSuit

否

string

0~16个字符。

hmac-sha256

加密算法。取值：hmac-sha256、hmac-md5、md5。认证方式为cryptographic时必填。

"hmac-sha256"

key

否

int32

[1-255]

1

key。认证方式为cryptographic时必填。

1

cryptographicPwd

否

string

1~255个字符。

-

该字段可能包含敏感信息和个人数据，请妥善做好保护。

密码必须包含如下规则：密码长度必须在1～255位。密码只支持特殊字符（"`!@#$%^&()_+=-[]{},.;）、英文大写字母（A~Z）、英文小写字母（a~z）和数字（0~9）。为提高安全性，建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种，同时密码长度不小于6个字符。

"1"

helloTimer

是

int32

[1-65535]

10

Hello报文时间间隔。建议Hello报文时间间隔取值不小于5，否则可能会造成邻接关系的中断。缺省情况下，P2P、Broadcast类型接口发送Hello报文的时间间隔的值为10秒；P2MP、NBMA类型接口发送Hello报文的时间间隔的值为30秒。

1

timerPoll

否

int16

[1-3600]

-

指定发送轮询Hello报文的时间间隔。

1

timerRetransmit

否

int16

[1-3600]

-

接口重传LSA的时间间隔。

1

timerDead

否

int32

[1-235926000]

-

OSPF的邻居失效时间，必须大于Hello报文的时间间隔。

1

mtuEnable

否

boolean

• true

• false

-

接口在发送DD报文时填充MTU值，同时还会检查邻居DD报文所携带的MTU是否超过本端的MTU值。默认值为false。

false

networkType

否

string

0~16个字符。

-

网络类型。取值：broadcast（将接口的网络类型更改为广播）、nbma（将接口的网络类型更改为NBMA）、p2mp（将接口的网络类型更改为点到多点）、p2p（将接口的网络类型更改为点到点）。

"broadcast"

cost

否

int32

[1-65535]

-

开销。

1

drPriority

是

int32

[0-255]

1

DR优先级。

1