华为乾坤-批量查询VPN BGP:响应参数

时间:2025-05-12 15:31:52

响应参数

返回状态码为200:操作成功。

表3 vpn-bgp-list对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

huawei-nce-e-bgp:vpn-bgp

ARRAY_REFERENCE

详细请参见表4

VPN BGP配置。

-

表4 nes-ne-vpn-bgp对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

config-status

string

  • reserved

  • initial

  • configuring-database

  • configured-database-success

  • configured-database-failed

  • configuring-device

  • configured-device-success

  • configured-device-failed

reserved

配置状态,对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态;不支持编辑,仅查询返回。

"configured-database-success"

last-committed-time

string

0~255个字符。

-

最后提交时间,该特性最后提交时间;不支持编辑,仅查询返回。

"2022-01-01 00:00:00"

edit-state

string

  • RUNNING

  • CANDIDATE

  • UNDEPLOYING

  • UNDEPLOYED

-

编辑状态,对应运行状态、候选状态、取消部署状态、未部署状态;不支持编辑,仅查询返回。

"RUNNING"

vpn-instance

string

1~31个字符。

_public_

VPN,单一主键字段。

"_public_"

router-id

string

满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。

-

Router ID。

"10.1.0.0"

ipv4-unicast

REFERENCE

详细请参见表5

IPv4地址族。

-

ipv6-unicast

REFERENCE

详细请参见表16

IPv6地址族,6700V子设备不支持。

-

ipv4-vpn

REFERENCE

详细请参见表27

VPNv4地址族,AR6700V主设备不支持。

-

l2vpn-evpn

REFERENCE

详细请参见表28

L2 EVPN,AR6700V主设备不支持。

-

ipv6-srpolicy

REFERENCE

详细请参见表30

IPv6 SR-Policy,AR6700V主设备和AR6700V子设备不支持。

-

bgp-peer

ARRAY_REFERENCE

详细请参见表31

BGP对等体。

-

表5 nes-ne-vpn-bgp-ipv4-unicast对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

-

使能IPv4地址族,AR6700V主设备不支持。

true

default-route-import

boolean

  • true

  • false

-

引入默认路由,AR6700V主设备不支持。

true

route-select-delay

int32

[0-3600]

-

延迟路由回切(秒),AR6700V主设备不支持。

10

reflector-cluster-id

int64

[1-4294967295]

-

反射器集群ID,AR6700V主设备不支持。

10

reflect-change-path

boolean

  • true

  • false

false

反射器改变路径,AR6700V主设备不支持。

true

auto-frr

boolean

  • true

  • false

false

Auto frr,AR6700V主设备不支持。

true

mode

string

  • be

  • te

-

SRv6 模式,AR6700V主设备和AR6700V子设备不支持。

"be"

down-switch

boolean

  • true

  • false

-

TE隧道发生故障切换TE到BE,AR6700V主设备和AR6700V子设备不支持。

true

route-relay-tunnel-v6-selector

string

1~40个字符。

-

隧道选择器,AR6700V主设备不支持。

"policy1"

preference

REFERENCE

详细请参见表6

优先级,AR6700V主设备不支持。

-

aggregate-route

ARRAY_REFERENCE

详细请参见表7

聚合路由,AR6700V主设备不支持。

-

network-route

ARRAY_REFERENCE

详细请参见表8

网段路由。

-

import-routing

ARRAY_REFERENCE

详细请参见表9

引入路由。

-

evpn

REFERENCE

详细请参见表10

EVPN,AR6700V主设备和AR6700V子设备不支持。

-

advertise-l2-evpn

REFERENCE

详细请参见表13

通告 L2 EVPN,AR6700V主设备不支持。

-

locator

ARRAY_REFERENCE

0-1个列表项,详细请参见表15

Locator,AR6700V主设备和AR6700V子设备不支持。

-

表6 ipv4-unicast-preference对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

external

int32

[1-255]

-

外部优先级。

10

internal

int32

[1-255]

-

内部优先级。

10

local

int32

[1-255]

-

本地优先级。

10

表7 ipv4-unicast-aggregate-route对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

address

string

满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。

-

聚合路由地址,联合主键字段。

"192.168.1.1"

mask

int32

[0-32]

-

聚合路由掩码,联合主键字段。

24

表8 ipv4-unicast-network-route对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

address

string

满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。

-

网段路由地址,联合主键字段。

"192.168.1.2"

mask

int32

[0-32]

-

网段路由掩码,联合主键字段。

24

route-policy

string

1~200个字符。

-

路由策略。

"policy1"

表9 ipv4-unicast-import-routing对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

protocol

string

  • direct

  • ospf

  • isis

  • static

  • rip

  • unr

  • op-route

-

引入路由协议,联合主键字段。

"static"

thead-id

int64

[0-4294967295]

-

进程 ID,联合主键字段。

10

cost

int64

[0-4294967295]

-

花销。

10

route-policy

string

1~200个字符。

-

路由策略。

"policy1"

表10 ipv4-unicast-evpn对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

srv6

REFERENCE

详细请参见表11

SRv6 模式。

-

locator

ARRAY_REFERENCE

0-1个列表项,详细请参见表12

Locator。AR6700V-L款型不支持。

-

表11 evpn-srv6对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

mode

string

  • be

  • te

-

SRv6 模式。

"be"

down-switch

boolean

  • true

  • false

false

TE隧道发生故障切换TE到BE。

true

表12 evpn-locator对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

name

string

1~31个字符。

-

Locator 名称,单一主键字段。

"name"

表13 ipv4-unicast-advertise-l2-evpn对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

advertise-route-to-evpn

ARRAY_REFERENCE

详细请参见表14

通告 L2 EVPN。

-

表14 advertise-route-to-evpn-type-advertise-route-to-evpn对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

protocol

string

  • all

-

路由协议,单一主键字段。

"all"

advertise-route-mode

string

  • all

  • best

  • valid

all

VPN向evrf发布路由模式,AR6700V子设备不支持。

"all"

表15 ipv4-unicast-locator对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

name

string

1~31个字符。

-

Locator 名称,单一主键字段。

"name"

表16 nes-ne-vpn-bgp-ipv6-unicast对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

-

使能IPv6地址族,AR6700V主设备不支持。

true

default-route-import

boolean

  • true

  • false

-

引入默认路由,AR6700V主设备不支持。

true

route-select-delay

int32

[0-3600]

-

延迟路由回切(秒),AR6700V主设备不支持。

10

reflector-cluster-id

int64

[1-4294967295]

-

反射器集群ID,AR6700V主设备不支持。

10

reflect-change-path

boolean

  • true

  • false

false

反射器改变路径,AR6700V主设备不支持。

true

auto-frr

boolean

  • true

  • false

false

Auto frr,AR6700V主设备不支持。

true

mode

string

  • be

  • te

-

SRv6 模式,AR6700V主设备不支持。

"be"

down-switch

boolean

  • true

  • false

-

TE隧道发生故障切换TE到BE,AR6700V主设备不支持。

true

route-relay-tunnel-v6-selector

string

1~40个字符。

-

隧道选择器,AR6700V主设备不支持。

"policy1"

preference

REFERENCE

详细请参见表17

优先级,AR6700V主设备不支持。

-

aggregate-route

ARRAY_REFERENCE

详细请参见表18

聚合路由,AR6700V主设备不支持。

-

network-route

ARRAY_REFERENCE

详细请参见表19

网段路由

-

import-routing

ARRAY_REFERENCE

详细请参见表20

引入路由。

-

evpn

REFERENCE

详细请参见表21

EVPN,AR6700V主设备不支持。

-

advertise-l2-evpn

REFERENCE

详细请参见表24

通告 L2 EVPN,AR6700V主设备不支持。

-

locator

ARRAY_REFERENCE

详细请参见表25

配置SRv6 locator,AR6700V主设备不支持。

-

locator-routes

ARRAY_REFERENCE

详细请参见表26

Locator 路由,AR6700V主设备不支持。

-

表17 ipv6-unicast-preference对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

external

int32

[1-255]

-

外部优先级。

10

internal

int32

[1-255]

-

内部优先级。

10

local

int32

[1-255]

-

本地优先级。

10

表18 ipv6-unicast-aggregate-route对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

address

string

满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。

-

聚合路由地址,联合主键字段。

"fc00::7"

mask

int32

[0-128]

-

聚合路由掩码,联合主键字段。

96

表19 ipv6-unicast-network-route对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

address

string

满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。

-

网段路由地址,联合主键字段。

"fc00::7"

mask

int32

[0-128]

-

网段路由掩码,联合主键字段。

96

表20 ipv6-unicast-import-routing对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

protocol

string

  • direct

  • isis

  • static

  • ospfv3

  • ripng

  • unr

-

引入路由协议,联合主键字段。

"static"

thead-id

int64

[0-4294967295]

-

进程 ID,联合主键字段。

10

cost

int64

[0-4294967295]

-

花销。

10

route-policy

string

1~200个字符。

-

路由策略。

"policy1"

表21 ipv6-unicast-evpn对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

srv6

REFERENCE

详细请参见表22

SRv6。

-

locator

ARRAY_REFERENCE

0-1个列表项,详细请参见表23

Locator。AR6700V-L款型不支持。

-

表22 srv6对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

mode

string

  • be

  • te

-

SRv6 模式。

"be"

down-switch

boolean

  • true

  • false

false

TE隧道发生故障切换TE到BE。

true

表23 unicast-evpn-locator对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

name

string

1~31个字符。

-

Locator 名称,单一主键字段。

"name"

表24 ipv6-unicast-advertise-l2-evpn对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

advertise-route-to-evpn

ARRAY_REFERENCE

详细请参见表14

通告 L2 EVPN。

-

表25 ipv6-unicast-locator对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

name

string

1~31个字符。

-

Locator 名称,单一主键字段。

"name"

表26 ipv6-unicast-locator-routes对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

locator-name

string

1~31个字符。

-

Locator 名称,单一主键字段。

"name"

表27 nes-ne-vpn-bgp-ipv4-vpn对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

true

使能VPNv4地址族。

true

policy-vpntarget

boolean

  • true

  • false

true

对接收到的VPN路由启用/禁用基于VPN目标的过滤。只有导出RT属性与本地导入RT属性匹配的VPN路由才能添加到路由表中。该选项可用于Kompella方式的跨域VPN

Option B解决方案和ASBR MP-EBGP跨域L2VPN解决方案。

true

表28 nes-ne-vpn-bgp-l2vpn-evpn对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

-

使能L2 EVPN。

true

policy-vpn-target

boolean

  • true

  • false

-

配置VPN Target。

true

reflect-change-path

boolean

  • true

  • false

false

反射器改变路径,AR6700V子设备不支持。

true

表29 nes-ne-vpn-bgp-link-state-unicast对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

string

-

-

使能BGP-LS。

"True"

domain-identifier

string

-

-

区域标识符,IPv4地址格式。

"192.168.1.1"

reflector-cluster-id

int64

[1-4294967295]

-

反射器集群ID。

10

表30 nes-ne-vpn-bgp-ipv6-srpolicy对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

string

-

-

使能IPv6 SR-Policy。

"True"

nexthop-select-depend-type

string

  • default

  • depend-ip

-

下一跳迭代到IP地址时路由参与选路。

"default"

router-id-filter

boolean

  • true

  • false

-

Router ID过滤。

true

表31 nes-ne-vpn-bgp-bgp-peer对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

peer-ip

string

-

-

对端IPv4或IPv6地址,单一主键字段。

"192.168.1.1"

peer-as

string

1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。

-

对端AS。

"1"

local-as-number

string

1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。

-

本端伪AS号。

"1"

local-if-name

string

1~63个字符。

-

接口名称。

"GE0/0/0"

local-if-address

string

-

-

接口地址。

"192.168.1.1"

ebgp-max-hop

int64

[1-255]

-

EBGP允许最大跳数。

10

auth-type

string

  • null

  • password

  • keychain

-

认证方式。

"password"

password-type

string

  • cipher

  • simple

-

密码类型。

"cipher"

password-text

string

1~432个字符。

-

密码。

"Example@123"

key-chain-name

string

1~47个字符。满足正则表达[^A-Z]+。

-

key-chain。

"aa"

timer

REFERENCE

详细请参见表38

保活时间。

-

ipv4-unicast

REFERENCE

详细请参见表32

IPv4地址族。

-

ipv6-unicast

REFERENCE

详细请参见表33

IPv6地址族,AR6700V主设备和AR6700V子设备不支持。

-

ipv4-vpn

REFERENCE

详细请参见表34

VPNv4地址族,AR6700V主设备不支持。

-

l2vpn-evpn

REFERENCE

详细请参见表35

L2 EVPN,AR6700V主设备不支持。

-

ipv6-srpolicy

REFERENCE

详细请参见表37

IPv6 SR-Policy,AR6700V主设备和AR6700V子设备不支持。

-

bfd

REFERENCE

详细请参见表39

BFD。

-

表32 ipv4-unicast对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

-

使能IPv4地址族。

true

allow-as-loop

int32

[1-10]

-

AS号的重复次数。

1

advertise-community

boolean

  • true

  • false

-

发布团体属性。

true

advertise-ext-community

boolean

  • true

  • false

-

发布扩展团体属性。

true

nexthop-config

string

  • local

  • invariable

-

下一跳配置。

"local"

prefix-sid

string

  • default

  • enable

  • disable

-

使能/去使能设备与指定的IPv6对等体交换IPv4前缀SID。

"default"

reflect-client

boolean

  • true

  • false

-

使能/去使能本端设备作为路由反射器(RR),将对等体或对等体组作为其客户端。此配置仅适用于IBGP对等体之间。地址族中的RR及其客户端的配置仅在该地址族中有效。因此,建议将RR及其客户端配置在所需的指定地址族中。

true

export-route-policy

string

1~200个字符。

-

发布路由策略,路由策略名称。

"policy1"

import-route-policy

string

1~200个字符。

-

引入路由策略,路由策略名称。

"policy1"

route-update-interval

int32

[0-600]

-

路由更新间隔(秒)。

10

表33 ipv6-unicast对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

-

使能IPv6地址族。

true

allow-as-loop

int32

[1-10]

-

AS号的重复次数。

1

advertise-community

boolean

  • true

  • false

-

发布团体属性。

true

advertise-ext-community

boolean

  • true

  • false

-

发布扩展团体属性。

true

nexthop-config

string

  • local

  • invariable

-

下一跳配置。

"local"

prefix-sid

string

  • default

  • enable

  • disable

-

使能/去使能设备与指定的IPv6对等体交换IPv4前缀SID。

"default"

reflect-client

boolean

  • true

  • false

-

使能/去使能本端设备作为路由反射器(RR),将对等体或对等体组作为其客户端。此配置仅适用于IBGP对等体之间。地址族中的RR及其客户端的配置仅在该地址族中有效。因此,建议将RR及其客户端配置在所需的指定地址族中。

true

export-route-policy

string

1~200个字符。

-

发布路由策略,路由策略名称。

"policy1"

import-route-policy

string

1~200个字符。

-

引入路由策略,路由策略名称。

"policy1"

表34 ipv4-vpn对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

-

使能VPNv4地址族。

true

export-route-policy

string

1~200个字符。

-

发布路由策略,路由策略名称。

"policy1"

import-route-policy

string

1~200个字符。

-

引入路由策略,路由策略名称。

"policy1"

表35 l2vpn-evpn对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

-

使能L2 EVPN。

true

reflect-client

boolean

  • true

  • false

-

RR反射,AR6700V子设备不支持。

true

export-route-policy

string

1~200个字符。

-

发布路由策略,路由策略名称。

"policy1"

import-route-policy

string

1~200个字符。

-

引入路由策略,路由策略名称。AR6700V子设备不支持。

"policy1"

表36 link-state-unicast对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

string

-

-

使能BGP-LS。

"True"

reflect-client

boolean

  • true

  • false

-

RR反射。

true

export-route-policy

string

1~200个字符。

-

发布路由策略,路由策略名称。

"policy1"

表37 ipv6-srpolicy对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

string

-

-

使能IPv6 SR-Policy。

"True"

reflect-client

boolean

  • true

  • false

-

RR反射。

true

advertise-ext-community

boolean

  • true

  • false

-

发布扩展团体属性。

true

graceful-restart-static-timer

int64

[3600-2147483647]

-

等待对端GR恢复的最大时间。

3600

表38 timer对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

keep-alive-time

int32

[0-21845]

-

存活时间(秒)。

10

host-time

int32

[0-65535]

-

存持时间(秒)。

10

connect-retry-time

int32

[1-65535]

-

连接重传时间(秒)。

10

表39 bfd对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

-

使能BFD。

true

multiplier

int64

[3-50]

-

本地检测倍数。

3

min-rx-interval

int64

[3-20000]

-

最小接收间隔(毫秒)。

10

min-tx-interval

int64

[3-20000]

-

最小发送间隔(毫秒)。

10

返回状态码为400:请求参数错误。

详细信息请参见实际响应消息体。

返回状态码为500:内部错误。

详细信息请参见实际响应消息体。

support.huaweicloud.com/qiankuncmn-qiankuncs/toctopics/zh-cn_topic_0000001899844969.html